Skip to content

Setting file keys are not matching cmdlet parameters exactly #1025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bergmeister opened this issue Jun 14, 2018 · 1 comment
Open

Setting file keys are not matching cmdlet parameters exactly #1025

bergmeister opened this issue Jun 14, 2018 · 1 comment

Comments

@bergmeister
Copy link
Collaborator

Raised due to this comment:

Invoke-ScriptAnalyzer has parameters IncludeRule and ExcludeRule parameters and the equivalent of those in the settings file are IncludeRules and ExcludeRules with an additional s, which makes it inconsistent, confusing and not intuitive to work with. The settings file also needs to support the singular form (since the plural form should not be removed for backcompat reasons)

Environment data

> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.17.1
@Halkcyon
Copy link
Contributor

Documentation on the -Settings parameter object in general would be greatly appreciated. It's been an increasingly frustrating experience of trial and error figuring out how the different keys/values interact especially when trying to customize formatting rules, custom rules, et al in vscode when I don't have time to dig through the source code for everything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants