en-US/about_PoshProject.help.txt
|
TOPIC
about_poshproject SHORT DESCRIPTION PoshProject is a simple PowerShell scaffolding module inspired from `Plaster`. LONG DESCRIPTION PoshProject is a simple PowerShell scaffolding module inspired from `Plaster`. It keeps a small predefined layout for the xml template with two major sections. One is `Configuration` which holds the `Project Name`, `Directories` to be created and `Type` of project. Second is `Metadata` which holds the basic and mandatory fields to create manifest file. It allows you to create a template, get the template as object, test it and invoke it to create your desired project folder and file structure. EXAMPLES # Create a template for your project PS C:\> New-PoshTemplate -ProjectName "Azure-Health-Check" -ProjectType Module -License MIT -DependsOn ("Az.Accounts", "Az.KeyVault") # Get the template object PS C:\> Get-PoshTemplate ".\PoshProjectTemplate.xml" ProjectName : Azure-Health-Check Directories : Classes,Private,Public,docs,en-US,Tests Type : Module Dependencies : Az.Accounts,Az.KeyVault License : MIT Metadata : PoshProject.Metadata # Test the template PS C:\> Test-PoshTemplate ".\PoshProjectTemplate.xml" [+] Error Count: 0 [+] Valid Template # Create the project structure PS C:\> Invoke-PoshTemplate ".\PoshProjectTemplate.xml" [+] Creating Project [+] Creating Project Directory [+] Creating Module Manifest [+] Creating Root Module [+] Creating Project Directories [+] Creating Classes [+] Creating Private [+] Creating Public [+] Creating docs [+] Creating en-US [+] Creating Tests [+] Adding License [+] Installing Dependencies [+] Installing Az.Accounts [+] Successfully installed: Az.Accounts [+] Installing Az.KeyVault [+] Successfully installed: Az.KeyVault NOTE Test the template before creating your project. Change in the name of template file will return error. TROUBLESHOOTING NOTE If there is any change in `Guid` in template file you will receive invalid template error. To overcome this generate new guid with the cmdlet `New-Guid` and add it in the template. SEE ALSO https://github.com/IndividualsinDemand/PoshProject/blob/master/docs/Test-PoshTemplate.md https://github.com/IndividualsinDemand/PoshProject KEYWORDS List of cmdlets - Get-PoshTemplate - Test-PoshTemplate - New-PoshTemplate - Invoke-PoshTemplate |