Dela via

Export-YamlCommandHelp

Modul:
Microsoft.PowerShell.PlatyPS Module

Exporterar CommandHelp objekt till YAML-filer.

Syntax

__AllParameterSets 

Export-YamlCommandHelp
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-OutputFolder <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Beskrivning

Det här kommandot exporterar ett CommandHelp--objekt till en Yaml-fil. Du kan lägga till metadata-frontmatter i Yaml-filen med hjälp av parametern Metadata. Du kan hämta ett CommandHelp--objekt med hjälp av cmdleten Export-YamlCommandHelp eller någon av de Import-* cmdletarna.

Exempel

Exempel 1 – Konvertera Markdown-kommandohjälpinnehåll till Yaml-format

Det här exemplet importerar Markdown-hjälpen i det gamla formatet från mappen .\v1 och exporterar den till mappen .\v2 i det nya formatet.

$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

Parametrar

-CommandHelp

CommandHelp objekt som ska exporteras. Du kan skicka objektet CommandHelp i pipelinen eller med hjälp av parametern Kommando.

Parameteregenskaper

Typ:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Standardvärde:None
Stöder jokrar:False
DontShow:False

Parametermängder

(All)
Position:0
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter fastighetsnamn:False
Värde från återstående argument:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokrar:False
DontShow:False
Alias:jfr

Parametermängder

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter fastighetsnamn:False
Värde från återstående argument:False

-Encoding

Den kodning som ska användas när du skriver markdown-filen. Om inget värde anges kodas som standard värdet för $OutputEncoding-inställningsvariabeln.

Parameteregenskaper

Typ:Encoding
Standardvärde:False
Stöder jokrar:False
DontShow:False

Parametermängder

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter fastighetsnamn:False
Värde från återstående argument:False

-Force

Använd parametern Force för att skriva över utdatafilen om den redan finns.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokrar:False
DontShow:False

Parametermängder

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter fastighetsnamn:False
Värde från återstående argument:False

-Metadata

Metadata som ska läggas till i markdown-filens frontmatter. Metadata är en hashtable där du anger nyckel- och värdeparen som ska läggas till i frontmattern. Nya nyckelnamn läggs till i den befintliga frontmattern. Värdena för befintliga nycklar skrivs över.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokrar:False
DontShow:False

Parametermängder

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter fastighetsnamn:False
Värde från återstående argument:False

-OutputFolder

Mappen där markdown-filen sparas. Om mappen inte finns skapas den.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokrar:False
DontShow:False

Parametermängder

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter fastighetsnamn:False
Värde från återstående argument:False

-WhatIf

Kör kommandot i ett läge som bara rapporterar vad som skulle hända utan att utföra åtgärderna.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokrar:False
DontShow:False
Alias:Wi

Parametermängder

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter fastighetsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Ingångar

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Utgångar

FileInfo