You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When using PSUseCompatible* rules with target profiles for PSv3, PSSA generates a whole bunch of issues for Pester tests that I have inside of my Script/Module projects. My Dev machine, as well as build machines run latest version of PowerShell, and the tests don't get bundled with my script/modules, hence I don't really care whether they'd run on versions other than latest. It would be really great if I could exclude my Test scripts (by path, by name pattern, or by name) just for these rules, and keep the rest of the rules active.
Proposed technical implementation details (optional)
Introduce an additional configuration setting for PSUseCompatible* rules, i.e. IgnoreScriptPath as follows:
@{
Rules=@{
PSUseCompatibleCommands=@{
Enable=$trueTargetProfiles=@(...);
IgnoreScriptPath=@(
'./Tests/',# Ignore any scripts within the Tests sub-folder'./*.ps1',# Ignore all PowerShell scripts withing the root folder (i.e. build scripts)'./HelperScripts/SomeHelperScriptForMyBuild.ps1'# Ignore a single helper file
)
};
PSUseCompatibleSyntax=@{
Enable=$trueTargetedVersions=@(...)
IgnoreScriptPath=@(
'./Tests/',# Ignore any scripts within the Tests sub-folder'./*.ps1',# Ignore all PowerShell scripts withing the root folder (i.e. build scripts)'./HelperScripts/SomeHelperScriptForMyBuild.ps1'# Ignore a single helper file
)
};
PSUseCompatibleTypes=@{
Enable=$trueTargetProfiles=@(...)
IgnoreScriptPath=@(
'./Tests/',# Ignore any scripts within the Tests sub-folder'./*.ps1',# Ignore all PowerShell scripts withing the root folder (i.e. build scripts)'./HelperScripts/SomeHelperScriptForMyBuild.ps1'# Ignore a single helper file
)
};
'PSUseCompatibleCmdlets'=@{
'compatibility'=@(...)
'IgnoreScriptPath'=@(
'./Tests/',# Ignore any scripts within the Tests sub-folder'./*.ps1',# Ignore all PowerShell scripts withing the root folder (i.e. build scripts)'./HelperScripts/SomeHelperScriptForMyBuild.ps1'# Ignore a single helper file
)
}
}
}
Alternatively, given that the collection of paths to ignore would most likely be identical for all the PSUseCompatible* rules, it might actually be easier to mention it once in a separate place, i.e.:
@{
Rules=@{
...
}
'PSUseCompatibleRulesIgnoreScriptPath'=@(
'./Tests/',# Ignore any scripts within the Tests sub-folder'./*.ps1',# Ignore all PowerShell scripts withing the root folder (i.e. build scripts)'./HelperScripts/SomeHelperScriptForMyBuild.ps1'# Ignore a single helper file
)
}
What is the latest version of PSScriptAnalyzer at the point of writing
1.18.3
The text was updated successfully, but these errors were encountered:
Summary of the new feature
When using
PSUseCompatible*
rules with target profiles for PSv3, PSSA generates a whole bunch of issues for Pester tests that I have inside of my Script/Module projects. My Dev machine, as well as build machines run latest version of PowerShell, and the tests don't get bundled with my script/modules, hence I don't really care whether they'd run on versions other than latest. It would be really great if I could exclude my Test scripts (by path, by name pattern, or by name) just for these rules, and keep the rest of the rules active.Proposed technical implementation details (optional)
Introduce an additional configuration setting for
PSUseCompatible*
rules, i.e.IgnoreScriptPath
as follows:Alternatively, given that the collection of paths to ignore would most likely be identical for all the
PSUseCompatible*
rules, it might actually be easier to mention it once in a separate place, i.e.:What is the latest version of PSScriptAnalyzer at the point of writing
1.18.3
The text was updated successfully, but these errors were encountered: