https://github.com/devblackops/Stucco

An opinionated Plaster template for high-quality PowerShell modules
https://github.com/devblackops/Stucco

plaster plaster-template powershell

Last synced: 2 months ago
JSON representation

An opinionated Plaster template for high-quality PowerShell modules

• Host: GitHub
• URL: https://github.com/devblackops/Stucco
• Owner: devblackops
• License: mit
• Created: 2018-10-04T04:02:28.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-02-11T16:12:38.000Z (11 months ago)
• Last Synced: 2024-08-02T17:36:54.321Z (5 months ago)
• Topics: plaster, plaster-template, powershell
• Language: PowerShell
• Size: 134 KB
• Stars: 194
• Watchers: 12
• Forks: 28
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - devblackops/Stucco - An opinionated Plaster template for high-quality PowerShell modules (PowerShell)

README

        
# Stucco

| GitHub Actions |  PS Gallery | License |

|----------------|-------------|---------|

[![GitHub Actions Status][github-actions-badge]][github-actions-build] | [![PowerShell Gallery][psgallery-badge]][psgallery] | [![License][license-badge]][license]

---



    



Stucco is an **opinionated** [Plaster](https://github.com/PowerShellOrg/Plaster) template for building high-quality [PowerShell](https://github.com/PowerShell/PowerShell) modules.

This template produces PowerShell projects according to a structure that I and many others in the PowerShell community use.

Apart from the PowerShell module itself, this template creates project scaffolding that enables effective collaboration with the community.

## Features

- MIT or Apache licensing options

- Changelog following [Keep a Changelog](http://keepachangelog.com/) guidelines with [Semantic Versioning](http://semver.org/)

- Optional [Code of Conduct](http://contributor-covenant.org)

- Optional [Read The Docs](https://readthedocs.org/) support for online documentation using [Mkdocs](https://www.mkdocs.org/)

- Optional [PlatyPS](https://github.com/PowerShell/platyPS) support for markdown-based help documentation

- Project dependency resolution using [PSDepend](https://github.com/RamblingCookieMonster/PSDepend)

- [psake](https://github.com/psake/psake) tasks using [PowerShellBuild](https://github.com/psake/PowerShellBuild) for build / test automation

- [AppVeyor](https://www.appveyor.com/), [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) or [GitLab CI/CD](https://docs.gitlab.com/ee/ci/) for CI/CD

- GitHub templates for contributing, issues, and pull requests

- VSCode tasks

## Usage

```powershell

$template = Get-PlasterTemplate -IncludeInstalledModules | Where-Object TemplatePath -Match 'Stucco'

Invoke-Plaster -TemplatePath $template.TemplatePath

```

## Contributions Welcome

The goal of this project is help create common patterns for PowerShell module development.

Additional features or capabilities that benefit the community are welcome.

[github-actions-badge]: https://github.com/devblackops/stucco/workflows/CI/badge.svg

[github-actions-build]: https://github.com/devblackops/stucco/actions

[psgallery-badge]: https://img.shields.io/powershellgallery/dt/stucco.svg

[psgallery]: https://www.powershellgallery.com/packages/stucco

[license-badge]: https://img.shields.io/github/license/devblackops/stucco.svg

[license]: https://www.powershellgallery.com/packages/stucco