PowerShell / PowerShell/PSScriptAnalyzer
Unable to run rules with hashtable that run fine with settings file
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- C#
- Star
- 2.2k
- Fork
- 414
- Merge trung bình
- 13 giờ 1 phút
- Pull request đã merge (30 ngày)
- 2
Mô tả
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.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Trước tiên, hãy chạy repro.ps1 với PSScriptAnalyzerSettings.psd1 trong các môi trường PowerShell 7.4.6 và 5.1 được báo cáo, sau đó truy vết cách Invoke-ScriptAnalyzer xử lý đường dẫn tệp so với hashtable settings đã import. Hoàn thành nghĩa là mục ExcludeRules suppress PSUseDeclaredVarsMoreThanAssignments trong cả hai lần gọi, với kiểm thử hồi quy bao quát hành vi khác nhau của PowerShell.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- powershell
- Lĩnh vực
- tooling
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100