{"id":21117098,"url":"https://github.com/powershelllibrary/plastertemplate-psmodule","last_synced_at":"2025-03-14T10:43:42.297Z","repository":{"id":197674581,"uuid":"176610802","full_name":"PowerShellLibrary/PlasterTemplate-PSModule","owner":"PowerShellLibrary","description":"Plaster template for a PowerShell module.","archived":false,"fork":false,"pushed_at":"2025-01-27T17:39:32.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-27T18:42:39.207Z","etag":null,"topics":["plaster","plaster-template","powershell"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PowerShellLibrary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-19T22:51:57.000Z","updated_at":"2025-01-27T17:39:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"8655a0de-495c-4024-95a1-83509df265e1","html_url":"https://github.com/PowerShellLibrary/PlasterTemplate-PSModule","commit_stats":null,"previous_names":["powershelllibrary/plastertemplate-psmodule"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShellLibrary%2FPlasterTemplate-PSModule","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShellLibrary%2FPlasterTemplate-PSModule/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShellLibrary%2FPlasterTemplate-PSModule/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShellLibrary%2FPlasterTemplate-PSModule/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PowerShellLibrary","download_url":"https://codeload.github.com/PowerShellLibrary/PlasterTemplate-PSModule/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243565413,"owners_count":20311702,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["plaster","plaster-template","powershell"],"created_at":"2024-11-20T02:38:23.770Z","updated_at":"2025-03-14T10:43:42.266Z","avatar_url":"https://github.com/PowerShellLibrary.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PlasterTemplate-PSModule\n\nThis is a Plaster template for a PowerShell module.\n\n## How to use\n\n### Install Plaster\n\nModule is available on [Powershell Gallery][gallery]\n\n``` powerShell\nInstall-Module -Name Plaster\n```\n\n### Import Plaster\n\n```powershell\nImport-Module Plaster\n```\n\n## Clone the template\n\n``` powerShell\ngit clone https://github.com/PowerShellLibrary/PlasterTemplate-PSModule\n```\n\n## Creating a new module\n\nThere are two methods of creating a new module.\n\n* Create a hash table containing the required parameters and invoke ```Invoke-Plaster```\n\n    ``` powerShell\n    $parameters = @{\n        DestinationPath   = \"C:\\repo\\PS.Modules\"\n        TemplatePath      = \"C:\\repo\\PlasterTemplate-PSModule\"\n        Author            = 'Alan'\n        ModuleVersion     = '1.0.0'\n        ModuleName        = '_ModuleName_'\n        ModuleDescription = '_Description_'\n    }\n    Invoke-Plaster @parameters\n    ```\n    output:\n    ```\n     ____  _           _\n    |  _ \\| | __ _ ___| |_ ___ _ __\n    | |_) | |/ _` / __| __/ _ \\ '__|\n    |  __/| | (_| \\__ \\ ||  __/ |\n    |_|   |_|\\__,_|___/\\__\\___|_|\n                                                v1.1.3\n    ==================================================\n    Destination path: C:\\repo\\PS.Modules\n    Creating test folder and files\n    Create _ModuleName_\\\n    Create _ModuleName_\\Public\\\n    Create _ModuleName_\\Private\\\n    Create _ModuleName_\\_ModuleName_.psd1\n    Create _ModuleName_\\_ModuleName_.psm1\n    ```\n\n\n* Call ```Invoke-Plaster``` and fill parameters manually (template)\n\n    ``` powerShell\n    Invoke-Plaster -DestinationPath \"C:\\repo\\PS.Modules\" -TemplatePath \"C:\\repo\\PlasterTemplate-PSModule\"\n    ```\n\n    output:\n\n    ```cmd\n     ____  _           _\n    |  _ \\| | __ _ ___| |_ ___ _ __\n    | |_) | |/ _` / __| __/ _ \\ '__|\n    |  __/| | (_| \\__ \\ ||  __/ |\n    |_|   |_|\\__,_|___/\\__\\___|_|\n                                                v1.1.3\n    ==================================================\n    Module author's name (Alan Płócieniak):\n    Module name: _ModuleName_\n    Module version (1.0.0):\n    Module description: _Description_\n    Destination path: C:\\repo\\PS.Modules\n    Creating test folder and files\n    Create _ModuleName_\\\n    Create _ModuleName_\\Public\\\n    Create _ModuleName_\\Private\\\n    Create _ModuleName_\\_ModuleName_.psd1\n    Create _ModuleName_\\_ModuleName_.psm1\n    ```\n\n## Plaster Manifest\n\nOther settings available [here](https://github.com/PowerShellOrg/Plaster/blob/master/docs/en-US/about_Plaster_CreatingAManifest.help.md)\n\nExtended template example:\n\n```xml\n\u003c?xml version=\"1.0\" encoding=\"utf-8\"?\u003e\n\u003cplasterManifest schemaVersion=\"1.0\"\n    xmlns=\"http://www.microsoft.com/schemas/PowerShell/Plaster/v1\"\u003e\n    \u003cmetadata\u003e\n        \u003cname\u003eStandardModuleTemplate\u003c/name\u003e\n        \u003cid\u003ea9c355a8-0228-4f58-8df9-3291dd997c1e\u003c/id\u003e\n        \u003cversion\u003e1.0.0\u003c/version\u003e\n        \u003ctitle\u003eStandard Module Template\u003c/title\u003e\n        \u003cdescription\u003e\u003c/description\u003e\n        \u003cauthor\u003eChuck Norris\u003c/author\u003e\n        \u003ctags\u003e\u003c/tags\u003e\n    \u003c/metadata\u003e\n    \u003cparameters\u003e\n        \u003cparameter name='AuthorName' type=\"user-fullname\" prompt=\"Module author's name\" /\u003e\n        \u003cparameter name='AuthorEmail' type=\"user-email\" prompt=\"Contributer/Owner email\" /\u003e\n        \u003cparameter name='ModuleName' type=\"text\" prompt=\"Name of your module\" /\u003e\n        \u003cparameter name='ModuleDescription' type=\"text\" prompt=\"Brief description on this module\" /\u003e\n        \u003cparameter name='ModuleVersion' type=\"text\" prompt=\"Initial module version\" default='0.0.1' /\u003e\n        \u003cparameter name='ModuleFolders' type = 'multichoice' prompt='Please select folders to include' default='0,1'\u003e\n            \u003cchoice label='\u0026amp;functions' value='functions' help='Folder containing public functions'/\u003e\n            \u003cchoice label='\u0026amp;internal' value='internal' help='Folder containing internal functions that are not exposed to users'/\u003e\n            \u003cchoice label='\u0026amp;classes' value='classes' help='Folder containing classes'/\u003e\n            \u003cchoice label='\u0026amp;resources' value='resources' help='Folder containing any resources required by the module'/\u003e\n        \u003c/parameter\u003e\n        \u003cparameter name='GitHub' type = 'choice' prompt='Include GitHub Support? (Issue/PR Templates, Code of Conduct and Contribution guide)' default='0'\u003e\n            \u003cchoice label='\u0026amp;Yes' value='Yes' help='Include files'/\u003e\n            \u003cchoice label='\u0026amp;No' value='No' help='Do not include files'/\u003e\n        \u003c/parameter\u003e\n        \u003cparameter name='License' type = 'choice' prompt='Add an MIT License?' default='0'\u003e\n            \u003cchoice label='\u0026amp;Yes' value='Yes' help='Adds LICENSE.md'/\u003e\n            \u003cchoice label='\u0026amp;No' value='No' help='Does not adds LICENSE.md'/\u003e\n        \u003c/parameter\u003e\n    \u003c/parameters\u003e\n    \u003ccontent\u003e\n        \u003cmessage\u003eCreating test folder and files\u003c/message\u003e\n        \u003cfile source='' destination='tests'/\u003e\n        \u003ctemplateFile source='tests\\Feature.Tests.ps1' destination=''/\u003e\n        \u003ctemplateFile source='tests\\Help.Exceptions.txt' destination=''/\u003e\n        \u003ctemplateFile source='tests\\Help.Tests.ps1' destination=''/\u003e\n        \u003ctemplateFile source='tests\\Project.Exceptions.txt' destination=''/\u003e\n        \u003ctemplateFile source='tests\\Project.Tests.ps1' destination=''/\u003e\n        \u003cfile source='tests\\README_TESTS.md' destination=''/\u003e\n        \u003ctemplateFile source='tests\\Unit.Tests.ps1' destination=''/\u003e\n        \u003cmessage\u003eCreating VSCode folder and files\u003c/message\u003e\n        \u003cfile source='' destination='.vscode'/\u003e\n        \u003cfile source='.vscode\\settings.json' destination=''/\u003e\n        \u003cfile source='.vscode\\tasks.json' destination=''/\u003e\n        \u003cmessage\u003eCreating code folders\u003c/message\u003e\n        \u003cfile source='' destination='functions' condition='$PLASTER_PARAM_ModuleFolders -contains \"functions\"'/\u003e\n        \u003cfile source='' destination='internal' condition='$PLASTER_PARAM_ModuleFolders -contains \"internal\"'/\u003e\n        \u003cfile source='' destination='resources' condition='$PLASTER_PARAM_ModuleFolders -contains \"resources\"'/\u003e\n        \u003cfile source='' destination='classes' condition='$PLASTER_PARAM_ModuleFolders -contains \"classes\"'/\u003e\n        \u003cmessage condition='$PLASTER_PARAM_GitHub -like \"Yes\"'\u003eCreating GitHub folder and files\u003c/message\u003e\n        \u003cfile source='' destination='.github' condition='$PLASTER_PARAM_GitHub -eq \"Yes\"'/\u003e\n        \u003cfile source='.github\\ISSUE_TEMPLATE\\Bug_report.md' destination='' condition='$PLASTER_PARAM_GitHub -eq \"Yes\"'/\u003e\n        \u003cfile source='.github\\ISSUE_TEMPLATE\\Feature_request.md' destination='' condition='$PLASTER_PARAM_GitHub -eq \"Yes\"'/\u003e\n        \u003cfile source='.github\\PULL_REQUEST_TEMPLATE.md' destination='' condition='$PLASTER_PARAM_GitHub -eq \"Yes\"'/\u003e\n        \u003ctemplateFile source='code-of-conduct.md' destination='' condition='$PLASTER_PARAM_GitHub -eq \"Yes\"'/\u003e\n        \u003ctemplateFile source='contributing.md' destination='' condition='$PLASTER_PARAM_GitHub -eq \"Yes\"'/\u003e\n        \u003cmessage condition='$PLASTER_PARAM_License -like \"Yes\"'\u003eCreating license file\u003c/message\u003e\n        \u003ctemplateFile source='LICENSE.md' destination='' condition='$PLASTER_PARAM_License -like \"Yes\"'/\u003e\n        \u003cmessage\u003eDeploying root directory files\u003c/message\u003e\n        \u003ctemplateFile source='CHANGELOG.md' destination=''/\u003e\n        \u003cfile source='module.psm1' destination='${PLASTER_PARAM_ModuleName}.psm1'/\u003e\n        \u003ctemplateFile source='MODULE_README.md' destination='README.MD'/\u003e\n        \u003cmessage\u003eCreating module manifest\u003c/message\u003e\n        \u003cnewModuleManifest destination='${PLASTER_PARAM_ModuleName}.psd1' moduleVersion='$PLASTER_PARAM_ModuleVersion' rootModule='${PLASTER_PARAM_ModuleName}.psm1' author='$PLASTER_PARAM_AuthorName' companyName='${PLASTER_PARAM_AuthorName}' description='$PLASTER_PARAM_ModuleDescription' encoding='UTF8-NoBOM'/\u003e\n    \u003c/content\u003e\n\u003c/plasterManifest\u003e\n```\n\n[gallery]: https://powershellgallery.com/packages/Plaster/","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpowershelllibrary%2Fplastertemplate-psmodule","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpowershelllibrary%2Fplastertemplate-psmodule","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpowershelllibrary%2Fplastertemplate-psmodule/lists"}