https://github.com/dsccommunity/dscresource.analysis
PowerShell Module for Analysing the health and other properties of a DSC Resource repository
https://github.com/dsccommunity/dscresource.analysis
Last synced: 11 months ago
JSON representation
PowerShell Module for Analysing the health and other properties of a DSC Resource repository
- Host: GitHub
- URL: https://github.com/dsccommunity/dscresource.analysis
- Owner: dsccommunity
- License: mit
- Created: 2019-07-12T21:39:36.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-19T10:53:00.000Z (over 6 years ago)
- Last Synced: 2024-11-13T23:39:52.250Z (over 1 year ago)
- Language: PowerShell
- Size: 29.3 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# DscResource.Analysis
This PowerShell module is used to perform analysis on PowerShell DSC Resource module repositories to
report on health and other properties.
## Instructions
To assemble the module analysis information object for all repositories listed in the DSC Resource
Kit, run the following command:
```powershell
Get-DscResourceKitInformation
```
## Exmples
The following section contains examples of how to use this module.
### Example 1
To list all Repositories opted in to the 'Common Tests - Custom Script Analyzer Rules'
meta test
```powershell
(Get-DscResourceKitInformation | Where-Object -FilterScript { $_.MetaTestOptIn -contains 'Common Tests - Custom Script Analyzer Rules' }).Name
```
### Example 2
To execute the 'Common Tests - PS Script Analyzer on Resource Files' Meta
Tests on all the DSC Resource modules in the DSC Resource Kit that have
been opted in to 'Common Tests - Custom Script Analyzer Rules'.
The DSCResource.Tests repository that will be used is
'https://github.com/SSvilen/DscResource.Tests' and the branch will be
'KeywordsCheck'.
```powershell
Get-DscResourceKitInformation |
Where-Object -FilterScript { $_.MetaTestOptIn -contains 'Common Tests - Custom Script Analyzer Rules' } |
Start-DscResourceKitMetaTest `
-TestFrameworkUri 'https://github.com/SSvilen/DscResource.Tests' `
-TestFrameworkBranch 'KeywordsCheck' `
-TestName 'Common Tests - PS Script Analyzer on Resource Files'
```