Export-YamlCommandHelp
Exporte objets CommandHelp dans des fichiers YAML.
Syntaxe
__AllParameterSets
Export-YamlCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cette commande exporte un objet CommandHelp vers un fichier Yaml. Vous pouvez ajouter un frontmatter de métadonnées au fichier Yaml à l’aide du paramètre Metadata . Vous pouvez obtenir un objet CommandHelp à l’aide de l’applet de commande Export-YamlCommandHelp ou de l’une des applets de commande Import-*.
Exemples
Cet exemple importe l’aide Markdown dans l’ancien format du dossier .\v1 et l’exporte vers le dossier .\v2 dans le nouveau format.
$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
Import-MarkdownCommandHelp -Path {$_.FilePath} |
Export-YamlCommandHelp -OutputFolder .\v2\yaml
Directory: D:\Git\PS-Src\platyPS\v2docs\v2\yaml
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 8/26/2024 3:56 PM 3535 Compare-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 4776 Export-MamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 8150 Export-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4998 Export-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 6357 Export-YamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 5396 Export-YamlModuleFile.yml
-a--- 8/26/2024 3:56 PM 3019 Import-MamlHelp.yml
-a--- 8/26/2024 3:56 PM 4235 Import-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4318 Import-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 4391 Import-YamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 3862 Import-YamlModuleFile.yml
-a--- 8/26/2024 3:56 PM 2325 Measure-PlatyPSMarkdown.yml
-a--- 8/26/2024 3:56 PM 5190 New-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 8335 New-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4697 New-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 3468 Test-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 3172 Update-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 3908 Update-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 5217 Update-MarkdownModuleFile.yml
Paramètres
-CommandHelp
Objet CommandHelp à exporter. Vous pouvez transmettre l’objet CommandHelp sur le pipeline ou à l’aide du paramètre command .
Propriétés du paramètre
Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp [ ]
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: 0 Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: cf
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Encoding
Encodage à utiliser lors de l’écriture du fichier markdown. Si aucune valeur n’est spécifiée, l’encodage est défini par défaut sur la valeur de la variable de préférence $OutputEncoding.
Propriétés du paramètre
Type: Encoding
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Force
Utilisez le paramètre Forcer pour remplacer le fichier de sortie s’il existe déjà.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
Métadonnées à ajouter au frontmatter du fichier markdown. Les métadonnées sont une table de hachage où vous spécifiez les paires clé et valeur à ajouter au frontmatter. Les nouveaux noms de clés sont ajoutés au frontmatter existant. Les valeurs des clés existantes sont remplacées.
Type: Hashtable
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-OutputFolder
Dossier dans lequel le fichier markdown est enregistré. Si le dossier n’existe pas, il est créé.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-WhatIf
Exécute la commande dans un mode qui signale uniquement ce qui se passerait sans effectuer les actions.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: Wi
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters .
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Sorties