{"id":19040253,"url":"https://github.com/keithbabinec/powershellmodulestarterkit","last_synced_at":"2025-04-23T21:09:24.268Z","repository":{"id":217054919,"uuid":"100153199","full_name":"keithbabinec/PowerShellModuleStarterKit","owner":"keithbabinec","description":"A starter kit for new PowerShell script modules including unit tests.","archived":false,"fork":false,"pushed_at":"2020-06-05T03:38:15.000Z","size":271,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-23T21:09:18.138Z","etag":null,"topics":["pester","powershell","powershell-module","starter-kit"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/keithbabinec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2017-08-13T04:12:16.000Z","updated_at":"2024-08-11T11:46:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"38cb6361-9700-4866-86f5-84d4704eafe9","html_url":"https://github.com/keithbabinec/PowerShellModuleStarterKit","commit_stats":null,"previous_names":["keithbabinec/powershellmodulestarterkit"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keithbabinec%2FPowerShellModuleStarterKit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keithbabinec%2FPowerShellModuleStarterKit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keithbabinec%2FPowerShellModuleStarterKit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keithbabinec%2FPowerShellModuleStarterKit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keithbabinec","download_url":"https://codeload.github.com/keithbabinec/PowerShellModuleStarterKit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250514786,"owners_count":21443209,"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":["pester","powershell","powershell-module","starter-kit"],"created_at":"2024-11-08T22:21:26.694Z","updated_at":"2025-04-23T21:09:24.252Z","avatar_url":"https://github.com/keithbabinec.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PowerShellModuleStarterKit\nA starter kit for new PowerShell script modules.\n\nThis repository demonstrates how to organize a module and accomplish a few common tasks like public vs private functions, unit tests, working with classes, and more. \n\nTip: For a starter that contains Azure DevOps CI pipeline support, check out [PowerShellCiPipelineStarterKit](https://github.com/keithbabinec/PowerShellCiPipelineStarterKit).\n\n## Features\n* Public and private functions.\n* Unit testing with the Pester framework.\n* PowerShell v5 classes (accessible inside and outside the module scope).\n* Module private data (for constants and caching).\n* Referencing static resource files.\n* Referencing external libraries.\n\n## Setup\n1. Clone the repository to your local computer.\n2. Open PowerShell (as an administrator).\n3. Install the [Pester](https://github.com/pester/Pester) framework:\n``` powershell\nInstall-Module -Name Pester -MinimumVersion 4.10.1 -Scope AllUsers -Force -SkipPublisherCheck\n```\n4. Add this starter kit module to the PSModule path.\n***Note: This assumes you have cloned the repository to C:\\Source. Update the path if this isn't correct.***\n``` powershell\n$repoDirectory = 'C:\\Source\\PowerShellModuleStarterKit'\n$existingPaths = $ENV:PSModulePath\n$newPaths = \"$repoDirectory;$existingPaths\"\n$scope = [System.EnvironmentVariableTarget]::Machine\n[System.Environment]::SetEnvironmentVariable('PSModulePath',$newPaths,$scope)\n```\n\n## Load the module\n``` powershell\nImport-Module -Name SampleModule\n```\n\n## Run the unit tests\n***Note: This assumes you have cloned the repository to C:\\Source. Update the path if this isn't correct.***\n``` powershell\ncd 'C:\\Source\\PowerShellModuleStarterKit\\SampleModule'\nInvoke-Pester\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeithbabinec%2Fpowershellmodulestarterkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeithbabinec%2Fpowershellmodulestarterkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeithbabinec%2Fpowershellmodulestarterkit/lists"}