| external help file | Module Name | online version | schema |
|---|---|---|---|
Plaster-help.xml |
Plaster |
2.0.0 |
Creates a new Plaster template manifest file.
New-PlasterManifest [[-Path] <String>] [-TemplateName] <String> [-TemplateType] <String> [[-Id] <Guid>]
[[-TemplateVersion] <String>] [[-Title] <String>] [[-Description] <String>] [[-Tags] <String[]>]
[[-Author] <String>] [-AddContent] [-WhatIf] [-Confirm] [<CommonParameters>]
The New-PlasterManifest command creates a new Plaster manifest file, populates its values, and saves the manifest file in the specified path.
Template authors can use this command to create a manifest for their template. A template manifest is a file named plasterManifest.xml or plasterManifest_<culture-name>.xml. The information stored in the manifest is used to scaffold files and folders.
The metadata section of the manifest is used to supply information about the template e.g. a unique id, name, version, title, author and tags.
The parameters section of the manifest is used to describe choices the template user can choose from. Those choices are then used to conditionally create files and folders and modify existing files under the specified destination path.
The content section is used to specify what actions the template will perform under the user's chosen destination directory. This includes copying files to the destination, copy & expanding template files, modifying files, verifying required modules are installed and displaying messages to the user.
See the help topic about_Plaster_CreatingAManifest for more details on authoring a Plaster manifest file.
New-PlasterManifest -TemplateName NewPowerShellItem -TemplateType Item
Creates a basic plasterManifest.xml file in the current directory.
New-PlasterManifest -TemplateName NewPowerShellItem -TemplateType Item -TemplateVersion 0.1.0 -Description "Some description." -Tags Module, Publish,Build
Creates a plasterManifest.xml file in the current directory with the version set to 0.1.0 and with the Description and Tags elements populated.
New-PlasterManifest -TemplateName NewPowerShellItem -TemplateType Item -AddContent
Creates a plasterManifest.xml file in the current directory with the content element filled in with all the files (except for any plasterManifest files) in and below the specified directory which defaults to the current directory.
If specified, the contents of the directory the manifest is being created in will be added to the manifest's content element.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the author of the template.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDescription of the Plaster template. This describes what the template is for. It is typically used in an editor like VSCode when displaying additional information about a Plaster template. A typical title might be "Creates files required for a PowerShell module with optional support for Pester tests, building with psake and publishing to the PowerShell Gallery."
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUnique identifier for all versions of this template. The id is a GUID. Use the same id for each version of your template. This will prevent editor environments from listing multiple, installed versions of your template. When you keep your template id the same, the editor will list only the latest version of your template.
Type: Guid
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: [guid]::NewGuid()
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the path and file name of the new Plaster manifest. Enter a path and file name with a .xml extension, such as $pshome\Modules\MyPlasterTemplate\plasterManifest.xml. NOTE: Plaster requires the manifest file be named either plasterManifest.xml OR plasterManifest_<culture-name>.xml e.g. plasterManifest_fr-FR.xml. The default, if no value is provided is to create plasterManifest.xml in the current directory.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: "$pwd\plasterManifest.xml"
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies an array of tags for the template. Users can search for templates based on these tags.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the name of the template. A template name is required. For localized manifests, this value should not be localized. The name is limited to the characters: aA-zZ0-9_-.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDefines the type of template. Valid values are: Project and Item. This value is used by editor extensions like the PowerShell extension for Visual Studio Code to determine if the template expects to create a whole new project in an empty workspace or if it adds an item to an existing workspace.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Item, Project
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the version of the template.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 1.0.0
Accept pipeline input: False
Accept wildcard characters: FalseTitle of the Plaster template. This string is typically used in an editor like VSCode when displaying a list of Plaster templates. A typical title might be "New DSC Resource" or "New PowerShell Module".
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: $Name
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You cannot pipe input to this cmdlet.