Skip to content
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

Unable to run rules with hashtable that run fine with settings file #2047

Open
pickscrape opened this issue Dec 6, 2024 · 0 comments
Open

Comments

@pickscrape
Copy link

Steps to reproduce

This is essentially the opposite of #1160

The attached zip file concisely contains the repro:

PSScriptAnalyzerSettingsHashtableRepro.zip

But here it is in plain text too

# repro.ps1

Write-Output "Using settings file"

Invoke-ScriptAnalyzer -Path .\repro.ps1 -Settings '.\PSScriptAnalyzerSettings.psd1'

# Create an unused variable which triggers a warning that the settings file should suppress
$unusedVariable = 1

$settings = Import-PowerShellDataFile -Path '.\PSScriptAnalyzerSettings.psd1'

Write-Output "Loaded settings to hashtable:"

$settings | ConvertTo-Json | Write-Output

Write-Output "Using setting hashtable"

Invoke-ScriptAnalyzer -Path .\repro.ps1 -Settings $settings
# PSScriptAnalyzerSettings.psd1

@{
    ExcludeRules = @(
        'PSUseDeclaredVarsMoreThanAssignments'
    )
}

Expected behavior

The warning should be suppressed in both calls to Invoke-ScriptAnalyzer. Output from the repro script should be this:

Using settings file
Loaded settings to hashtable:
{
    "ExcludeRules":  [
                         "PSUseDeclaredVarsMoreThanAssignments"
                     ]
}
Using setting hashtable

Actual behavior

The warning is only suppressed in the first call (the one that references the file directly). The call that passes the settings hashtable does not suppress the error. Output from the repro script is this:

Using settings file
Loaded settings to hashtable:
{
  "ExcludeRules": [
    "PSUseDeclaredVarsMoreThanAssignments"
  ]
}
Using setting hashtable

RuleName                            Severity     ScriptName Line  Message
--------                            --------     ---------- ----  -------
PSUseDeclaredVarsMoreThanAssignment Warning      repro.ps1  6     The variable 'unusedVariable' is assigned but never
s                                                                 used.

Environment data

> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      7.4.6
PSEdition                      Core
GitCommitId                    7.4.6
OS                             Microsoft Windows 10.0.26100
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.23.0

Note that this issue does NOT happen in this environment (i.e. the warning is suppressed in both calls):

> $PSVersionTable
Name                           Value
----                           -----
PSVersion                      5.1.26100.2161
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.26100.2161
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

> (Get-Module -ListAvailable PSScriptAnalyzer).
Version | ForEach-Object { $_.ToString() }
1.23.0

It appears to be related to the Powershell version.

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

No branches or pull requests

1 participant