-
Notifications
You must be signed in to change notification settings - Fork 115
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #430 from erikgraa/feature/validatePatternForParam…
…eters
- Loading branch information
Showing
3 changed files
with
222 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <plasterManifest schemaVersion="0.3" xmlns="http://www.microsoft.com/schemas/PowerShell/Plaster/v1"> | ||
| <metadata> | ||
| <!-- For the default store file, we need a unique identifier to ensure one template's default value store | ||
| doesn't get used with any other template. --> | ||
| <id>ac9f688f-503d-48c9-833a-f0d767d92f47</id> | ||
| <name>NewPowerShellModule</name> | ||
| <!-- For display by UI's in a menu list --> | ||
| <title>New PowerShell Module</title> | ||
| <!-- For display by UI's in hover help --> | ||
| <description>Plaster template for creating the files for a PowerShell module.</description> | ||
| <version>0.2.0</version> | ||
| <tags>Module, ModuleManifest, Build</tags> | ||
| </metadata> | ||
| <parameters> | ||
| <parameter name='ModuleName' type='text' prompt='Enter the name of the module' pattern='^[\w\.\-_]+$'/> | ||
| <parameter name='ModuleDesc' type='text' prompt='Enter a description of the module (required for publishing to the PowerShell Gallery)' pattern='^[\w\s]+\.?$'/> | ||
| <parameter name='Version' type='text' default='1.0.0' prompt='Enter the version number for the module' pattern='^\d+\.\d+(\.\d+)?(\.\d+)?$'/> | ||
| <parameter name='FullName' type='user-fullname' store='text' prompt='Enter your full name' pattern='^[\w\s]+$'/> | ||
| <parameter name='Email' type='user-email' store='text' prompt='Enter your email address'/> | ||
| <parameter name='Options' type='multichoice' default='0,1,3' store='text' prompt='Select desired options'> | ||
| <choice label='&Pester test support' | ||
| help="Adds Tests directory and a starter Pester Tests file." | ||
| value="Pester"/> | ||
| <choice label='P&Sake build script' | ||
| help="Adds a PSake build script that generates the module directory for publishing to the PSGallery." | ||
| value="PSake"/> | ||
| <choice label='platyPS &documentation support' | ||
| help="Adds documentation support using platyPS." | ||
| value="platyPS"/> | ||
| <choice label='&Git' | ||
| help="Adds a .gitignore file." | ||
| value="Git"/> | ||
| <choice label='&None' | ||
| help="No options specified." | ||
| value="None"/> | ||
| </parameter> | ||
| <parameter name='Editor' type='choice' default='2' store='text' prompt='Which editor do you use'> | ||
| <choice label='&ISE' | ||
| help="Your editor is PowerShell ISE." | ||
| value="ISE"/> | ||
| <choice label='Visual Studio &Code' | ||
| help="Your editor is Visual Studio Code." | ||
| value="VSCode"/> | ||
| <choice label='&None' | ||
| help="No editor specified." | ||
| value="None"/> | ||
| </parameter> | ||
| <parameter name='License' type='choice' default='2' store='text' prompt='Select a license for your module'> | ||
| <choice label='&Apache' | ||
| help="Adds an Apache license file." | ||
| value="Apache"/> | ||
| <choice label='&MIT' | ||
| help="Adds an MIT license file." | ||
| value="MIT"/> | ||
| <choice label='&None' | ||
| help="No license specified." | ||
| value="None"/> | ||
| </parameter> | ||
| </parameters> | ||
| <content> | ||
| <message> | ||
| Scaffold a PowerShell Module with the files required to run Pester tests, build with PSake and publish to the PSGallery. | ||
|
|
||
| </message> | ||
|
|
||
| <newModuleManifest destination='src\${PLASTER_PARAM_ModuleName}.psd1' | ||
| moduleVersion='$PLASTER_PARAM_Version' | ||
| rootModule='${PLASTER_PARAM_ModuleName}.psm1' | ||
| author='$PLASTER_PARAM_FullName' | ||
| description='$PLASTER_PARAM_ModuleDesc' | ||
| encoding='UTF8-NoBOM'/> | ||
| <file source='Module.psm1' | ||
| destination='src\${PLASTER_PARAM_ModuleName}.psm1'/> | ||
| <file source='_gitignore' | ||
| destination='.gitignore' | ||
| condition='$PLASTER_PARAM_Options -contains "Git"'/> | ||
| <file source='build*.ps1' | ||
| destination='' | ||
| condition='$PLASTER_PARAM_Options -contains "PSake"'/> | ||
| <file source='' | ||
| destination='docs\' | ||
| condition='$PLASTER_PARAM_Options -contains "platyPS"'/> | ||
| <!-- Recursively copy all *files* into the corresponding directory structure under dest dir RecurseFile --> | ||
| <file source='RecurseFile\**' | ||
| destination='Recurse'/> | ||
| <templateFile source='ApacheLicense.txt' | ||
| destination='LICENSE.txt' | ||
| condition="$PLASTER_PARAM_License -eq 'Apache'" | ||
| encoding="UTF8-NoBOM"/> | ||
| <templateFile source='MITLicense.txt' | ||
| destination='LICENSE.txt' | ||
| condition="$PLASTER_PARAM_License -eq 'MIT'"/> | ||
| <templateFile source='en-US\about_Module.help.txt' | ||
| destination='en-US\about_${PLASTER_PARAM_ModuleName}.help.txt'/> | ||
| <templateFile source='Tests\Module.T.ps1' | ||
| destination='test\${PLASTER_PARAM_ModuleName}.Tests.ps1' | ||
| condition="$PLASTER_PARAM_Options -contains 'Pester'"/> | ||
| <templateFile source='RecurseTemplateFile\**' | ||
| destination='Recurse' | ||
| encoding='Ascii'/> | ||
| <file source='tasks.json' | ||
| destination='.vscode\tasks.json' | ||
| condition="$PLASTER_PARAM_Editor -eq 'VSCode'"/> | ||
| <modify path='.vscode\tasks.json' encoding='UTF8' | ||
| condition="$PLASTER_PARAM_Editor -eq 'VSCode'"> | ||
| <replace condition="$PLASTER_FileContent -notmatch '// Author:'"> | ||
| <original>(?s)^(.*)</original> | ||
| <substitute expand='true'>// Author: $PLASTER_PARAM_FullName`r`n`$1</substitute> | ||
| </replace> | ||
| <replace condition="$PLASTER_PARAM_Options -contains 'Pester' -and $PLASTER_FileContent -notmatch 'taskName":\s*"Test"'"> | ||
| <original><![CDATA[(?si)(?<="tasks":\s*\[)(\s*)(?=\{)]]></original> | ||
| <substitute><![CDATA[$1{ | ||
| "taskName": "Test", | ||
| "suppressTaskName": true, | ||
| "isTestCommand": true, | ||
| "showOutput": "always", | ||
| "args": [ | ||
| "Write-Host 'Invoking Pester...'; Invoke-Pester -PesterOption @{IncludeVSCodeMarker=$true};", | ||
| "Invoke-Command { Write-Host 'Completed Test task in task runner.' }" | ||
| ], | ||
| "problemMatcher": [ | ||
| { | ||
| "owner": "powershell", | ||
| "fileLocation": ["absolute"], | ||
| "severity": "error", | ||
| "pattern": [ | ||
| { | ||
| "regexp": "^\\s*(\\[-\\]\\s*.*?)(\\d+)ms\\s*$", | ||
| "message": 1 | ||
| }, | ||
| { | ||
| "regexp": "^\\s+at\\s+[^,]+,\\s*(.*?):\\s+line\\s+(\\d+)$", | ||
| "file": 1, | ||
| "line": 2 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| },$1]]></substitute> | ||
| </replace> | ||
|
|
||
| <replace condition="$PLASTER_PARAM_Options -contains 'PSake' -and $PLASTER_FileContent -notmatch 'taskName":\s*"Build"'"> | ||
| <original><![CDATA[(?si)(?<="tasks":\s*\[)(\s*)(?=\{)]]></original> | ||
| <substitute><![CDATA[$1{ | ||
| "taskName": "Build", | ||
| "suppressTaskName": true, | ||
| "isBuildCommand": true, | ||
| "showOutput": "always", | ||
| "args": [ | ||
| "Write-Host 'Invoking PSake...'; Invoke-PSake build.ps1 -taskList Build;", | ||
| "Invoke-Command { Write-Host 'Completed Build task in task runner.' }" | ||
| ] | ||
| },$1]]></substitute> | ||
| </replace> | ||
| </modify> | ||
|
|
||
| <requireModule name="Pester" condition='$PLASTER_PARAM_Options -contains "Pester"' | ||
| minimumVersion="3.4.0" | ||
| message="Without Pester, you will not be able to run the provided Pester test to validate your module manifest file.`nWithout version 3.4.0, VS Code will not display Pester warnings and errors in the Problems panel."/> | ||
|
|
||
| <requireModule name="psake" condition='$PLASTER_PARAM_Options -contains "PSake"' | ||
| message="Without psake, you will not be able to run the provided build script to build and/or publish your module."/> | ||
|
|
||
| <requireModule name="platyPS" condition='$PLASTER_PARAM_Options -contains "platyPS"' | ||
| message="Without platyPS, you will not be able to generate PowerShell external help for your module using markdown."/> | ||
|
|
||
| <message nonewline='true'>`n`nYour new PowerShell module project $PLASTER_PARAM_ModuleName </message> | ||
| <message nonewline='true' condition="$PLASTER_PARAM_Options -contains 'Git'">with Git version control </message> | ||
| <message>has been created.</message> | ||
|
|
||
| <message condition="$PLASTER_PARAM_Options -contains 'PSake'"> | ||
| You can build your project by executing the 'build' task by pressing Ctrl+P, then type 'task build'. | ||
| You can publish your project to the PSGallery by pressing Ctrl+P, then type 'task publish'. | ||
|
|
||
| </message> | ||
|
|
||
| <message condition="$PLASTER_PARAM_Options -contains 'Pester'"> | ||
| A Pester test has been created to validate the module's manifest file. Add additional test to the Tests directory. | ||
| You can run the Pester tests in your project by executing the 'test' task by pressing Ctrl+P, then type 'task test'. | ||
|
|
||
| </message> | ||
|
|
||
| <message condition="$PLASTER_PARAM_Options -contains 'platyPS'"> | ||
| You can generate help and additional documentation using platyPS by running the 'docs' task by pressing Ctrl+P, | ||
| then type 'task docs'. Add additional documentation written in platyPS markdown to the docs directory. You can | ||
| update the docs by running the 'docs' task again. | ||
|
|
||
| </message> | ||
| </content> | ||
| </plasterManifest> |