Skip to content

Setting file keys are not matching cmdlet parameters exactly #1025

Open

Description

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

Activity

  1. morsley commented on Sep 10, 2018

    @morsley
    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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions