{"id":18555082,"url":"https://github.com/mistergf/powerrails","last_synced_at":"2025-08-03T23:37:47.439Z","repository":{"id":71136472,"uuid":"80580874","full_name":"misterGF/PowerRails","owner":"misterGF","description":"Scaffolding for PowerShell scripts and modules","archived":false,"fork":false,"pushed_at":"2017-05-02T23:26:09.000Z","size":127,"stargazers_count":52,"open_issues_count":0,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-24T13:44:01.574Z","etag":null,"topics":["continuous-deployment","linting","powershell","powershell-modules","unit-testing"],"latest_commit_sha":null,"homepage":null,"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/misterGF.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-02-01T01:48:58.000Z","updated_at":"2023-11-18T16:07:27.000Z","dependencies_parsed_at":"2023-04-13T15:01:26.211Z","dependency_job_id":null,"html_url":"https://github.com/misterGF/PowerRails","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misterGF%2FPowerRails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misterGF%2FPowerRails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misterGF%2FPowerRails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misterGF%2FPowerRails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/misterGF","download_url":"https://codeload.github.com/misterGF/PowerRails/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248129888,"owners_count":21052655,"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":["continuous-deployment","linting","powershell","powershell-modules","unit-testing"],"created_at":"2024-11-06T21:25:05.182Z","updated_at":"2025-04-09T23:31:57.282Z","avatar_url":"https://github.com/misterGF.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Overview\n**PowerRails - A module to generate your scripts folder structure.**\n![PowerRails logo](http://res.cloudinary.com/gatec21/image/upload/v1486397147/powerrails_ppxobl.svg)\n\n## Why?\nMost scripts/modules have a similar directory structure.\nYou shouldn't waste your time creating it. Just use this module to\nget a head start and add to your new structure as needed.\n\n![PowerRails in action](http://res.cloudinary.com/gatec21/image/upload/v1486526550/2017-02-07_23-00-04_h75jvf.gif)\n\n**PowerRails will also helps you to become a better developer.**\n\n## How?\nWe include the following helpers to keep you on track 🚆 (pun intended).\n\n- [Script Analyzer](https://github.com/PowerShell/PSScriptAnalyzer/tree/development/RuleDocumentation) is a set of rules that are based on guidance from the PowerShell team. By default we enforce these rules.\n- [Pester](https://github.com/pester/Pester/wiki) is a framework for running unit tests to execute and validate PowerShell commands. You should test your code. Pester helps you with that. Sample tests included.\n- [PSake](http://psake.readthedocs.io/en/latest) is a build automation tool written in PowerShell. Builds glue everything together. Analyze your script, run your unit testing and deploy!\n- [PSDeploy](http://ramblingcookiemonster.github.io/PSDeploy/) is a quick and dirty module that simplifies deployments. If everything checks out, deploy our script to where ever you'd like.\n\n---\n\n## Using PowerRails\nThere is only 1 cmdlet to learn. **New-PowerRailsItem**\nPowerRails is semi-opinioned in the tabs vs spaces discussion. We prefer spaces but I've included\na switch to use tabs if you prefer.\n\n### Download \u0026 import module\n```powershell\nPS\u003e Install-Module -Name PowerRails\nPS\u003e Import-Module -Name PowerRails\n```\n\n### Create a new script\n```powershell\nPS\u003e New-PowerRailsItem -name 'GitHubScrapper' -type 'script' -path '.'\n```\n\n### Create a new module (type is module by default)\n```powershell\nPS\u003e New-PowerRailsItem -name 'MakeMyLifeEasier' -path 'c:\\scripts\\'\n```\n\n### Learn more\n```powershell\nPS\u003e Get-Help New-PowerRailsItem\n```\n\n---\n\n### Build Operations\n* Test the script via Pester and Script Analyzer\n```powershell\nPS\u003e .\\build.ps1\n```\n\n* Test the script with Pester only\n```powershell\nPS\u003e .\\build.ps1 -Task Test\n```\n\n* Test the script with Script Analyzer only\n```powershell\nPS\u003e .\\build.ps1 -Task Analyze\n```\n\n* Deploy the script via PSDeploy (runs all tests)\n```powershell\nPS\u003e .\\build.ps1 -Task Deploy\n```\n---\n\n\nThis module was inspired by the post by [Dev Black Ops](https://devblackops.io/building-a-simple-release-pipeline-in-powershell-using-psake-pester-and-psdeploy/)\nGreat read. Highly recommended.\n\nBig thanks to FreePik for the [logo]('http://www.freepik.com/free-photos-vectors/logo').\n\n## Don't forget to star this project if you like it!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmistergf%2Fpowerrails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmistergf%2Fpowerrails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmistergf%2Fpowerrails/lists"}