Documentação de desenvolvimento de CLI do CoE (Preterido)

Nota

A CLI do CoE está preterida e será removida numa futura versão. Utilize o Assistente de Configuração do Projeto do Power Platform para configurar e gerir os seus projetos do ALM Accelerator for Power Platform.

A documentação é fundamental para entender como a CLI funciona. Ao adicionar novos comandos, considere a seguinte documentação:

• Adicionar páginas do Markdown
• Gravar a linha de comandos

Adicionar páginas do Markdown

Adicione novas páginas à ajuda que descrevam o novo comando e expliquem a utilização esperado ao utilizador.

Considere adicionar o seguinte à página:

1. Imagens estáticas que resumem a operação.
2. Grave a linha de comandos para demonstrar o processo.

Diagramas

Para as árvores de decisões, os diagramas são gerados através de Mermaid.

Diagramas de exemplo:

• Maturidade
• Árvore de decisões do AA4PP

Estilos de diagramas

Para modelar o sample.mmd do diagrama:

1. Utilize estilos de subgrupos.

   graph
       subgraph journey[Journey]
         start(Start) --> finish(Finish Here)
       end
   
       style journey fill:transparent,stroke:green,stroke-width:2px
   

2. Aplique estilos CSS com um ficheiro na mesma pasta. Por exemplo, crie sample.css na mesma pasta que o ficheiro .mmd.

   #L-start-finish path {
      stroke: red
   }
   

Notas

1. Reveja as formas do nó para controlar os símbolos apresentados.

2. Modele círculos utilizando a seguinte abordagem.

   graph TD
      subgraph Journey
         start(Start Here) ---> finish((End Here))
      end
   

   Para colorir o círculo final de verde, use CSS attribute^=value selector. Este seletor é obrigatório, uma vez que cada item terá um ID exclusivo atribuído pelo Mermaid.

   [id^=flowchart-finish] circle {
      stroke: green;
      fill: lightgreen
   }
   

3. Pinte uma linha. Cada linha terá o formato L-start-finish para o path, que é a linha e a classe .path, que é a linha em torno da cabeça da seta.

   #L-start-finsh path,
   #L-start-finsh .path
    {
      stroke: green;
   }
   

Atualizar diagramas

As imagens estáticas de cada diagrama são geradas da seguinte forma.

1. Aceda à pasta coe-cli.

   cd coe-cli
   

2. Gere ficheiros estáticos.

   npm run diagrams
   

Adicionar páginas de ajuda

Adicione novas páginas de ajuda à ajuda. Cada página na ajuda fornece informações detalhadas sobre o comando e opções. O ficheiro de Markdown de ajuda pode ser acedido utilizando o comando de ajuda que apresenta o ficheiro de Markdown de ajuda associado na janela da consola.

coe help alm

Este comando apresenta os conteúdos de ajuda.

Gravar a linha de comandos

Para incluir uma breve gravação animada de comandos que demonstre o resultado esperado, utilize o seguinte processo.

1. Instale o termtosvg num terminal baseado em Unix.

   pip3 install --user termtosvg
   

   Este processo funciona em diferentes plataformas e qualquer uma das seguintes opções pode ser utilizada:

   • Shell do Unix nativa em distribuições macOS ou Linux.
   • Imagens do Docker com um shell do Unix.
   • Subsistema do Windows para Linux no Windows.

2. Grave a sessão num ficheiro de transmissão.

   termtosvg record test.cast
   

   O ficheiro de transmissão gerado é um ficheiro de texto simples que pode ser editado com qualquer editor de texto.

3. Remover pausas utilizando term-trim.ps1.

   ./term-trim.ps1 -Input test.cast -Output test2.cast -Trim 1
   
   

4. Gere o ficheiro svg.

   termtosvg render test2.cast test.svg -t window_frame