https://github.com/jimbrig/PowerShell-Module-Template
PowerShell Core Module Template Module
https://github.com/jimbrig/PowerShell-Module-Template
Last synced: 4 months ago
JSON representation
PowerShell Core Module Template Module
- Host: GitHub
- URL: https://github.com/jimbrig/PowerShell-Module-Template
- Owner: jimbrig
- License: unlicense
- Created: 2023-08-10T01:51:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-29T20:26:22.000Z (about 1 year ago)
- Last Synced: 2024-11-13T14:54:20.216Z (5 months ago)
- Language: PowerShell
- Size: 377 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - jimbrig/PowerShell-Module-Template - PowerShell Core Module Template Module (PowerShell)
README
[SOURCE_CODE]: ./Source/
[BUILD]: ./Build/
[DOCS]: ./Docs/
[TESTS]: ./Tests/
[CHANGELOG]: ./CHANGELOG.md
[LICENSE]: ./LICENSE.md
[CONTRIBUTING]: ./.github/CONTRIBUTING.md
[CoC]: ./.github/CODE_OF_CONDUCT.md
[SECURITY]: ./.github/SECURITY.md
[BUGS]: https://github.com/jimbrig/PowerShell-Module-Template/issues
[ROADMAP]: ./Docs/Development/Roadmap.md
[DOCS_SITE]: https://docs.jimbrig.com/PowerShell-Module-Template/
[LOGO]: ./Docs/Assets/img/logo.png
[PWSH_LOGO]: ./Docs/Assets/img/pwsh.png
[FAVICON]: ./Docs/Assets/favicon.ico
[LATEST_RELEASE]: https://github.com/jimbrig/PowerShell-Module-Template/releases/latest
[PSGALLERY]: https://www.powershellgallery.com/packages/PowerShell-Module-Template/
[PSGALLERY_PROFILE]: https://www.powershellgallery.com/profiles/jimbrig
PowerShell Module Template
PowerShell Core Module Template Containing Various Utility and Helpers for Advanced Development Experience.
Links:
Source Code |
Published Documentation |
Latest Release: [v0.0.2] |
PowerShell Gallery
View the repo's CHANGELOG for details on the progression of the codebase over time.
Badges
[](https://www.powershellgallery.com/packages/PSXLDevTools/)
[](https://github.com/jimbrig/PSXLDevTools/actions/workflows/ghpkg.yml)
[](https://github.com/jimbrig/PSXLDevTools/actions/workflows/test.yml)
[](https://github.com/jimbrig/PSXLDevTools/actions/workflows/build.yml)
[](https://github.com/jimbrig/PSXLDevTools/actions/workflows/publish.yml)
[](https://github.com/jimbrig/PSXLDevTools/actions/workflows/mkdocs.yml)
[](https://github.com/jimbrig/PSXLDevTools/actions/workflows/changelog.yml)
## Contents
Table of Contents
- [PowerShell Module Template](#powershell-module-template)
- [Badges](#badges)
- [Contents](#contents)
- [Overview](#overview)
- [Repository Structure](#repository-structure)
- [Installation](#installation)
- [Usage](#usage)
- [Appendices](#appendices)
- [Roadmap](#roadmap)
- [References](#references)
- [Acknowledgements](#acknowledgements)
- [Contributing](#contributing)
- [License](#license)
## Overview
This project is a template for creating a PowerShell Core Module.
## Repository Structure
Click to Expand Repository File Structure Diagram
```powershell
> tree /F
│
├───bin
│ Install-RequiredModules.ps1
│ Invoke-PesterStub.ps1
│ Update-ReadMeIndex.ps1
│
├───docs
│ └───en-US
│ about_PSXLDevTools.help.md
│
├───PSXLDevTools
│ │ PSXLDevTools.psd1
│ │ PSXLDevTools.psm1
│ │
│ ├───Dev
│ │ │ Invoke-XLBuild.ps1
│ │ │ New-VBAProject.ps1
│ │ │ New-VBAProjectConfig.ps1
│ │ │
│ │ ├───Exports
│ │ │ Export-CustomCellStyles.ps1
│ │ │ Export-DataMashup.ps1
│ │ │ Export-ListObject.ps1
│ │ │ Export-ListObjects.ps1
│ │ │ Export-PowerQuery.ps1
│ │ │ Export-PowerQueryConnection.ps1
│ │ │ Export-TableStyles.ps1
│ │ │ Export-VBAComponent.ps1
│ │ │ Export-VBAProjectProps.ps1
│ │ │ Export-VBAReferences.ps1
│ │ │ Export-WorksheetMetadata.ps1
│ │ │ Export-XLConditionalFormatting.ps1
│ │ │ Export-XLCustomLists.ps1
│ │ │ Export-XLCustomRibbonX.ps1
│ │ │ Export-XLDataModel.ps1
│ │ │ Export-XLDataValidation.ps1
│ │ │ Export-XLDocumentProps.ps1
│ │ │ Export-XLPivotCache.ps1
│ │ │ Export-XLPivotTable.ps1
│ │ │ Export-XLTheme.ps1
│ │ │ Export-XLThemeColors.ps1
│ │ │ Export-XLThemeFonts.ps1
│ │ │
│ │ └───Imports
│ │ Import-DataMashup.ps1
│ │
│ ├───Private
│ │ GetHelloWorld.ps1
│ │
│ └───Public
│ Export-PowerQueries.ps1
│ Get-HelloWorld.ps1
│
├───resources
│ │ dirtree.js
│ │ md.config.js
│ │
│ └───images
│ excel.ico
│ office365.ico
│ powershell.ico
│ powershellcore-preview.ico
│ powershellcore.png
│ regedit.ico
│ win10.ico
│ windowspowershell.ico
│
├───tests
│ │ Export-PowerQueries.tests.ps1
│ │ Help.tests.ps1
│ │ Manifest.tests.ps1
│ │ Meta.tests.ps1
│ │ MetaFixers.psm1
│ │ ScriptAnalyzerSettings.psd1
│ │
│ └───TestWorkbooks
│
│ .editorconfig
│ .gitattributes
│ .gitignore
│ build.ps1
│ CHANGELOG.md
│ cliff.toml
│ LICENSE
│ mkdocs.yml
│ psakeFile.ps1
│ README.md
│ RequiredModules.psd1
│ requirements.psd1
│
├───.devcontainer
│ devcontainer.json
│ Dockerfile
│
├───.github
│ │ CONTRIBUTING.md
│ │ ISSUE_TEMPLATE.md
│ │ PULL_REQUEST_TEMPLATE.md
│ │
│ └───workflows
│ build.yml
│ changelog.yml
│ lint.yml
│ mkdocs.yml
│ publish.yml
│ readme.yml
│ test.yml
│
├───.vscode
│ extensions.json
│ launch.json
│ settings.json
│ tasks.json
```
## Installation
> [!NOTE]
> View my other PowerShell Creations from my [PowerShell Gallery Packages Profile][PSGALLERY_PROFILE]!
- Install via the [PowerShell Gallery][PSGALLERY]:
```powershell
# Using PowerShellGet (in PowerShell 5.0+)
Install-Module -Name PSModuleTemplate -Scope CurrentUser -Force
# Using new PSResourceGet (in PowerShell 7.0+)
Install-PSResource -Name PSModuleTemplate -Repository PSGallery -Scope CurrentUser -Force
```
## Usage
```powershell
# TODO
# etc...
```
***
## Appendices
### Roadmap
- [ ] TODO
### References
- [ ] TODO
### Acknowledgements
- [ ] TODO
### Contributing
- [ ] TODO
### License
- [License][LICENSE]
***
Jimmy Briggs | 2023
***
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.