Panoramica di PlatyPS

platyPS è lo strumento principale per la creazione della Guida di PowerShell visualizzata usando Get-Help. I file della Guida di PowerShell vengono archiviati in un formato XML noto come Microsoft Assistance Markup Language (MAML). Prima di PlatyPS, i file della Guida sono stati creati a mano usando catene di strumenti complesse. Markdown viene ampiamente usato nella community open source, supportato da molti editor, tra cui Visual Studio Codee più facile da creare. PlatyPS semplifica il processo consentendo di scrivere i file della Guida in Markdown e quindi convertiti in MAML.

Esistono due versioni principali di PlatyPS.

• platyPS v0.14.2 è la versione corrente di PlatyPS usata per creare file della Guida di PowerShell in formato Markdown.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 è la nuova versione di PlatyPS. Questa versione è una riscrittura completa in C# sfruttando markdig per l'analisi di Markdown. Questa versione include diversi miglioramenti:
  • Fornisce una descrizione più accurata di un cmdlet di PowerShell e dei relativi parametri
  • Miglioramento delle prestazioni: processi 1000 di file Markdown in secondi
  • Crea un modello a oggetti del file della Guida che è possibile modificare in memoria
  • Fornisce cmdlet che è possibile concatenare per eseguire operazioni complesse
  • Definisce un nuovo schema Markdown che include tutti gli elementi necessari per Get-Help, oltre a informazioni precedentemente non disponibili.
  • Fornire la conversione automatica di Markdown esistente (usando lo schema precedente) in nuovi oggetti, consentendo di esportare in un nuovo markdown, YAML o MAML.