Documentazione dello sviluppo dell'interfaccia a riga di comando CoE (deprecato)

La documentazione è fondamentale per comprendere come funziona l'interfaccia della riga di comando. Quando aggiungi nuovi comandi, considera la seguente documentazione:

• Aggiungi pagine Markdown
• Registrazione della riga di comando

Aggiungi pagine Markdown

Aggiungi nuove pagine alla guida per descrivere il nuovo comando e spiegare all'utente l'utilizzo previsto.

Considera di aggiungere quanto segue alla pagina:

1. Immagini statiche che riassumono l'operazione.
2. Registrazione della riga di comando per dimostrare il processo.

Diagrammi

Per gli alberi delle decisioni, i diagrammi vengono generati tramite Mermaid.

Esempi di diagrammi:

• Maturità
• Albero decisionale AA4PP

Stili di diagramma

Per applicare uno stile al diagramma sample.mmd:

1. Usa gli stili di sottogruppo.

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

2. Applica gli stili CSS con un file nella stessa cartella. Ad esempio, crea sample.css nella stessa cartella del file .mmd.

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

Notes

1. Rivedi le forme dei nodi per controllare i simboli visualizzati.

2. Applica lo stile ai cerchi utilizzando il seguente approccio.

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

   Per colorare di verde il cerchio finale, usa il selettore CSS attribute^=value. Questo selettore è richiesto in quanto ogni elemento avrà un ID univoco assegnato da Mermaid.

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

3. Colora una riga. Ogni riga avrà il formato L-start-finish per path, che è la linea, e per la classe .path, che è la linea attorno alla punta della freccia.

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

Aggiorna diagrammi

Le immagini statiche per ogni diagramma sono generate come segue.

1. Vai alla cartella coe-cli.

   cd coe-cli
   

2. Genera file statici.

   npm run diagrams
   

Aggiungere pagine della Guida

Aggiungi nuove pagine alla guida. Ciascuna pagina della guida fornisce informazioni dettagliate sul comando e sulle opzioni. Puoi accedere al file di Markdown della Guida usando il comando help che visualizza il file di Markdown della Guida associato nella finestra della console.

coe help alm

Questo comando visualizza il contenuto della guida.

Registrazione della riga di comando

Per includere una breve registrazione animata dei comandi che dimostrano l'output previsto, puoi utilizzare il processo seguente.

1. Installa termtosvg in un terminale basato su Unix.

   pip3 install --user termtosvg
   

   Questo processo funzionerà su più piattaforme ed è possibile utilizzare una qualsiasi delle seguenti opzioni:

   • Shell Unix nativa su distribuzioni macOS o Linux.
   • Immagini Docker con una shell Unix.
   • Sottosistema Windows per Linux su Windows.

2. Registra la sessione in un file cast.

   termtosvg record test.cast
   

   Il file cast generato è un semplice file di testo che può essere modificato con qualsiasi editor di testo.

3. Rimuovi le pause utilizzando term-trim.ps1.

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

4. Genera il file svg.

   termtosvg render test2.cast test.svg -t window_frame