PSRule

Validate infrastructure as code (IaC) and DevOps repositories using the PSRule PowerShell module. PSRule is powerful, feature rich, and highly customizable to meet your needs.

Note

This extension is being migrated into https://github.com/microsoft/PSRule. Currently this repository reflects the last stable release of v2.9.x. An improve PSRule extension for V3 will be release from the new repository. Please log an new issues at https://github.com/microsoft/PSRule/issues

---

This extension is available in two release channels:

Channel	Description	Version/ downloads
Preview	More frequent releases but more likely to contain bugs.
Stable	Less frequent releases, with more user testing, experimental features are disabled.

Features

CodeLens

• CodeLens shows links to create or edit markdown documentation from rules in YAML, JSON, or PowerShell.
  • Open documentation — Opens rule markdown documentation in the editor.
    • The location for storing documentation is configurable in the extension settings.
    • By default, a locale specific folder is created in the same directory as the rule file.
  • Create documentation — Creates a new markdown file for the rule based on a snippet.
    • New markdown documentation is created with the built-in Rule Doc snippet.
    • An alternative snippet can be specified by configuring extension settings.

IntelliSense

• Adds IntelliSense and validation support for configuring options and resources.
  • Workspace options — use IntelliSense to configure options for the workspace.
    • Type or trigger IntelliSense with Ctrl+Space from ps-rule.yaml.
  • Create resources — define baselines and selectors by using pre-built snippets and IntelliSense.

• Adds snippets for defining new rules.
  • Define rules with snippets and IntelliSense support.
    • Trigger IntelliSense by typing rule in a .Rule.ps1, .Rule.yaml, or .Rule.jsonc file. IntelliSense can also be triggered by using the shortcut Ctrl+Space.

• Adds snippets for creating markdown documentation.
  • Quick documentation — create rule documentation to provide rule recommendations and examples.
    • Trigger IntelliSense by typing rule in a .md file. IntelliSense can also be triggered by using the shortcut Ctrl+Space.

Quick tasks

• Adds quick tasks for analysis directly from Visual Studio Code.
  • Run analysis — runs rules against files in the current workspace.
    • Input path, Baseline, Modules, and Outcome options can be configured per task.
    • Output as, and showing a Not processed warning options can be configured by workspace or user.
    • Rule stored in .ps-rule/ are automatically used by default.
    • Use the built-in analysis task by running or configuring the task from the Terminal menu.

Configuration

In addition to configuring the ps-rule.yaml options file, the following settings are available.

Name	Description
PSRule.codeLens.ruleDocumentationLinks	Enables Code Lens that displays links to rule documentation. This is an experimental feature that requires experimental features to be enabled.
PSRule.documentation.path	The path to look for rule documentation. When not set, the path containing rules will be used.
PSRule.documentation.localePath	The locale path to use for locating rule documentation. The VS Code locale will be used by default.
PSRule.documentation.customSnippetPath	The path to a file containing a rule documentation snippet. When not set, built-in PSRule snippets will be used.
PSRule.documentation.snippet	The name of a snippet to use when creating new rule documentation. By default, the built-in Rule Doc snippet will be used.
PSRule.execution.notProcessedWarning	Warn when objects are not processed by any rule. This option is deprecated and replaced by PSRule.execution.unprocessedObject.
PSRule.execution.ruleExcluded	Determines how to handle excluded rules. When set to None, PSRule will use the default (Ignore), unless set by PSRule options.
PSRule.execution.ruleSuppressed	Determines how to handle suppressed rules. When set to None, PSRule will use the default (Warn), unless set by PSRule options.
PSRule.execution.unprocessedObject	Determines how to report objects that are not processed by any rule. When set to None, PSRule will use the default (Warn), unless set by PSRule options.
PSRule.experimental.enabled	Enables experimental features in the PSRule extension.
PSRule.notifications.showChannelUpgrade	Determines if a notification to switch to the stable channel is shown on start up.
PSRule.notifications.showPowerShellExtension	Determines if a notification to install the PowerShell extension is shown on start up.
PSRule.output.as	Configures the output of analysis tasks, either summary or detailed.
PSRule.rule.baseline	The name of the default baseline to use for executing rules. This setting can be overridden on individual PSRule tasks.

Support

This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates.

• For new issues, file your bug or feature request as a new issue.
• For help, discussion, and support questions about using this project, join or start a discussion.

Support for this project/ product is limited to the resources listed above.

Installing PSRule module

PSRule is available from the PowerShell Gallery and is required for this extension to work.

To install the module use the following command from a PowerShell prompt.

Install-Module -Name PSRule -Scope CurrentUser;

Installing the extension

You can install the latest release of the extension by following the steps in the Visual Studio Code documentation. In the Extensions pane, search for PSRule extension and install it there. You will get notified automatically about any future extension updates.

code --install-extension bewhite.psrule-vscode-preview

NOTE: If you are using VS Code Insiders, the command will be code-insiders.

Contributing

This project welcomes contributions and suggestions. If you are ready to contribute, please visit the contribution guide.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Maintainers

• Bernie White

License

This project is licensed under the MIT License.