PlasterTemplate/Advanced.xml
|
<?xml version="1.0" encoding="UTF-8"?> <plasterManifest xmlns="http://www.microsoft.com/schemas/PowerShell/Plaster/v1" schemaVersion="1.0"> <metadata> <name>ModuleTemplate</name> <id>c8e32c92-c461-4200-89a0-79ac904e7520</id> <version>1.0.0</version> <title>Custom Module Template</title> <description>Plaster template to create a module</description> <author>John McCrae</author> <tags>Plaster, PSake, PlatyPS</tags> </metadata> <parameters> <parameter name="ModuleAuthor" type="user-fullname" prompt="Author" /> <parameter name="ModuleName" type="text" prompt="Name of your module" default="MyNewModule" /> <parameter name="ModuleVersion" type="text" prompt="Version Number" default="0.0.0.1" /> <parameter name="CompanyName" type="text" prompt="Name of your Organization" default="" /> <parameter name="Description" type="text" prompt="Brief Description of your module" /> <parameter name="GitHubUserName" type="text" prompt="Enter your Github username" /> <parameter name="GitHubRepo" type="text" prompt="Enter your Github repository name for this project" /> <parameter name="PowerShellVersion" type="text" prompt="Enter the minimum PS version needed to run this module" /> <parameter name="FunctionFolders" type="multichoice" prompt="Please select folders to include" default="0,3"> <choice label="&Public" value="Public" help="Adds a public folder to module root" /> <choice label="&Internal" value="Internal" help="Adds a internal folder to module root" /> <choice label="&Classes" value="Classes" help="Adds a classes folder to module root" /> <choice label="P&rivate" value="Private" help="Adds a private folder to module root" /> <choice label="&Binaries" value="Binaries" help="Adds a binaries folder to module root" /> <choice label="&DSCResources" value="DSCResources" help="Adds a DSCResource folder to module root" /> </parameter> <parameter name='Options' type='multichoice' prompt='Select one or more of the following tooling options:' default='1,2,3,4,5' store='text' > <choice label='&None' help="No tooling options specified." value="None"/> <choice label='Add &Git .gitignore file' help="Adds a .gitignore file." value="Git"/> <choice label='Add p&sake build script' help="Adds psake build script that generates the module directory for publishing to the PowerShell Gallery." value="psake"/> <choice label='Add &Pester test support' help="Adds test directory and Pester test for the module manifest file." value="Pester"/> <choice label='Add PSScript&Analyzer support' help="Adds script analysis support using PSScriptAnalyzer." value="PSScriptAnalyzer"/> <choice label='Add plat&yPS help generation support' help="Adds help build support using platyPS." value="platyPS"/> </parameter> </parameters> <content> <message> Setting up Your Project ----------------------- </message> <newModuleManifest destination="${PLASTER_PARAM_ModuleName}\${PLASTER_PARAM_ModuleName}.psd1" moduleVersion="${PLASTER_PARAM_ModuleVersion}" rootModule="${PLASTER_PARAM_ModuleName}.psm1" author="${PLASTER_PARAM_ModuleAuthor}" companyName="${PLASTER_PARAM_CompanyName}" description="${PLASTER_PARAM_Description}" encoding='UTF8-NoBOM'/> <templateFile source="Scaffold\template.psm1" destination="${PLASTER_PARAM_ModuleName}\${PLASTER_PARAM_ModuleName}.psm1" /> <templateFile source="Scaffold\nuspec.txt" destination="${PLASTER_PARAM_ModuleName}\${PLASTER_PARAM_ModuleName}.nuspec" /> <message>Creating Base Folders for module: $PLASTER_PARAM_ModuleName</message> <file source="" destination="${PLASTER_PARAM_ModuleName}\Public\" condition="$PLASTER_PARAM_FunctionFolders -contains "Public"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Internal\" condition="$PLASTER_PARAM_FunctionFolders -contains "Internal"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Classes\" condition="$PLASTER_PARAM_FunctionFolders -contains "Classes"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Private\" condition="$PLASTER_PARAM_FunctionFolders -contains "Private"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Binaries\" condition="$PLASTER_PARAM_FunctionFolders -contains "Binaries"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\DSCResources\" condition="$PLASTER_PARAM_FunctionFolders -contains "DSCResources"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Documentation\" /> <message condition="$PLASTER_PARAM_FunctionFolders -contains "Public""> Creating First Function File ---------------------- </message> <templateFile source="Scaffold\New-PSNowModuleBase.ps1.template" destination="${PLASTER_PARAM_ModuleName}\Public\${PLASTER_PARAM_ModuleName}.ps1" /> <message> Deploying Common Files ---------------------- </message> <templateFile source="Scaffold\LICENSE.md" destination="${PLASTER_PARAM_ModuleName}\LICENSE.md" /> <templateFile source="Scaffold\readme.md.txt" destination="${PLASTER_PARAM_ModuleName}\Readme.md" /> <message> Staging Support Folders ----------------------- </message> <file source="" destination="${PLASTER_PARAM_ModuleName}\Spec\" /> <templateFile source="Scaffold\PSNow.feature.template" destination="${PLASTER_PARAM_ModuleName}\Spec\${PLASTER_PARAM_ModuleName}.feature" /> <file source="Scaffold\PSNow.Steps.ps1.template" destination="${PLASTER_PARAM_ModuleName}\Spec\${PLASTER_PARAM_ModuleName}.Steps.ps1" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\.vscode" /> <file source="Scaffold\settings.json.example" destination="${PLASTER_PARAM_ModuleName}\.vscode\settings.json" /> <file source="Scaffold\task.json.example" destination="${PLASTER_PARAM_ModuleName}\.vscode\task.json" /> <message condition="$PLASTER_PARAM_Options -contains "Git""> Setting up Support for Git -------------------------- </message> <file source=".gitignore" destination="${PLASTER_PARAM_ModuleName}\.gitignore" condition="$PLASTER_PARAM_Options -contains "Git"" /> <message condition="$PLASTER_PARAM_Options -contains "psake""> Setting up Support for Psake Build Environment ---------------------------------------------- </message> <requireModule name="psake" minimumVersion="4.8.0" condition="$PLASTER_PARAM_Options -contains "psake"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Build\" condition="$PLASTER_PARAM_Options -contains "psake"" /> <file source="Build\build.ps1" destination="${PLASTER_PARAM_ModuleName}\Build\build.ps1" condition="$PLASTER_PARAM_Options -contains "psake"" /> <file source="Build\build.depend.psd1" destination="${PLASTER_PARAM_ModuleName}\Build\build.depend.psd1" condition="$PLASTER_PARAM_Options -contains "psake"" /> <templateFile source="Scaffold\build.psake.ps1.template" destination="${PLASTER_PARAM_ModuleName}\Build\build.psake.ps1" condition="$PLASTER_PARAM_Options -contains "psake"" /> <file source="Build\deploy.psdeploy.ps1" destination="${PLASTER_PARAM_ModuleName}\Build\deploy.psdeploy.ps1" condition="$PLASTER_PARAM_Options -contains "psake"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Certs\" condition="$PLASTER_PARAM_Options -contains "psake"" /> <templateFile source="Scaffold\openssl.cfg" destination="${PLASTER_PARAM_ModuleName}\Certs\openssl.cfg" condition="$PLASTER_PARAM_Options -contains "psake"" /> <message condition="$PLASTER_PARAM_Options -contains "Pester""> Setting up Support for Pester ----------------------------- </message> <requireModule name="Pester" minimumVersion="3.4.0" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Tests\" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Tests\Common\" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Tests\Unit\" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Tests\Acceptance\" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="Tests\Common\Analyzer.tests.ps1.example" destination="${PLASTER_PARAM_ModuleName}\Tests\Common\Analyzer.tests.ps1.example" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="Tests\Common\Basic.tests.ps1" destination="${PLASTER_PARAM_ModuleName}\Tests\Common\Basic.tests.ps1" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="Tests\Common\Environment.tests.ps1" destination="${PLASTER_PARAM_ModuleName}\Tests\Common\Environment.tests.ps1" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="Tests\Common\Help.Tests.ps1" destination="${PLASTER_PARAM_ModuleName}\Tests\Common\Help.Tests.ps1" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="Tests\Common\Manifest.Tests.ps1" destination="${PLASTER_PARAM_ModuleName}\Tests\Common\Manifest.Tests.ps1" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="Tests\Common\PSSA.Tests.wip.ps1" destination="${PLASTER_PARAM_ModuleName}\Tests\Common\PSSA.Tests.wip.ps1" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="Tests\Acceptance\Project.Tests.ps1" destination="${PLASTER_PARAM_ModuleName}\Tests\Acceptance\Project.Tests.ps1" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <file source="Tests\Unit\Unit.Tests.ps1" destination="${PLASTER_PARAM_ModuleName}\Tests\Unit\Unit.Tests.ps1" condition="$PLASTER_PARAM_Options -contains "Pester"" /> <message condition="$PLASTER_PARAM_Options -contains "PSScriptAnalyzer""> Setting up support for PS ScriptAnalyzer ---------------------------------------- </message> <file source="Build\PSScriptAnalyzerSettings.psd1" destination="${PLASTER_PARAM_ModuleName}\Build\PSScriptAnalyzerSettings.psd1" condition="$PLASTER_PARAM_Options -contains "PSScriptAnalyzer"" /> <message condition="$PLASTER_PARAM_Options -contains "platyPS""> Setting up Support for PlatyPS ------------------------------ </message> <requireModule name="PlatyPS" minimumVersion="0.14.0" condition="$PLASTER_PARAM_Options -contains "platyPS"" /> <file source="" destination="${PLASTER_PARAM_ModuleName}\Help" condition="$PLASTER_PARAM_Options -contains "platyPS"" /> <file source="Scaffold\about_PSNow.help.md" destination="${PLASTER_PARAM_ModuleName}\Help\about_${PLASTER_PARAM_ModuleName}.help.md" condition="$PLASTER_PARAM_Options -contains "platyPS"" /> <message> We're Done! ----------- Your new PowerShell module -[ $PLASTER_PARAM_ModuleName ]- has been created. If you noted any 'Missing The required module 'abcde' (minimum version: 0.14.0) was not found' errors, you correct those by running .\build\build.ps1 -ResolveDependency. </message> <message condition="$PLASTER_PARAM_Options -contains 'Pester'"> A Pester test has been executed to validate the module's manifest file. Add additional tests to the test directory. You can run the Pester tests in your project by executing the 'test' task: '.\build\build.ps1 -tasklist analyze, test'. </message> <message condition="$PLASTER_PARAM_Options -contains 'psake'"> You can build your project by executing the 'buildNuget' task: '.\build\build.ps1 -tasklist BuildNuget'. Then, publish your project to the PSGallery by typing '.\build\build.ps1 -tasklist publishpsgallery'. </message> <message condition="($PLASTER_PARAM_Options -contains 'psake') -and ($PLASTER_PARAM_Options -contains 'platyPS')"> You can generate help and additional documentation using platyPS by running the 'build.ps1 -tasklist help' task. Add additional documentation written in markdown to the docs directory. You can update the help by running the 'build.ps1 -tasklist help' task again. </message> </content> </plasterManifest> |