Include CustomRulePath in Settings file

[kapilmb]

Currently, the settings file can include on the following keys:

• IncludeRules
• 'ExcludeRules'
• 'Severity`
• 'Rules`

We would like to add CustomRulePath and IncludeDefaultRules to the settings file so that VSCode users can point to such a settings file and run a custom set of rules while authoring PS scripts.

[mattmcnabb]

Yes please!

[LaurentDardenne]

What about this demand for evolution ?

[kapilmb]

We will try to get this thing in in the next couple of releases.

[ECNU3D]

@kapilmb
Hi,
I tried to use CustomRulePath in the setting files, and surprisingly, it works. However, once you used CustomRulePath, your InculdeRules and ExcludeRules setting won't take effect.

Do you have any idea what happened?

[Ryan2065]

I am having the same problem ECNU3D is having. CustomRulePath seems to override IncludeRules and ExcludeRules.

[bergmeister]

@ECNU3D @Ryan2065
Update: This seems to be by design, you need to also specify the -IncludeDefaultRules in this case. The current behaviour is:

• When CustomRulePath is used (either via command line or settings file), then only the custom rules are going to be used. If you want to ADD the custom rules to the existing default rules, then you need to additionally supply -IncludeDefaultRules
• When a parameter (CustomRulePath, IncludeRule, etc.) is passed in via the cmdlet, then it overrides its value in the the settings file
• The behaviour of -IncludeRule is to only include the given rules. When a mix of built in and custom rules should be run then this can be achieved e.g. with the following parameters -IncludeRule @('PSAvoidUsingCmdletAliases','MyCustomRuleStopUsingWriteHost') -IncludeDefaultRules
• Similarly for -ExcludeRule, one needs the -IncludeDefaultRules when mixing with -CustomRulePath

I agree that the current design does not seem to very intuitive but the current design seems to allow all possible situations.
Therefore the implementation of using CustomRulePath and IncludeDefaultRules seems to be done, but it probably needs better documentation and examples.
Here is an example of a settings file

@{
    CustomRulePath='path\to\CustomRuleModule.psm1'
	IncludeDefaultRules=$true
	 ExcludeRules = @(
        'PSAvoidUsingWriteHost',
        'PSAvoidGlobalVars'
    )
}