powershell.scriptAnalysis.settingsPath (Description): Warning Message Should Provide A Workaround

[Zian]

Prerequisites

• I have written a descriptive issue title.
• I have searched all issues to ensure it has not already been reported.

Summary

The "powershell.scriptAnalysis.settingsPath" setting currently says "This setting may not work as expected currently!".

The description doesn't provide a workaround or a way to learn more about the issue. It makes me think that I will never be able to customize the PSScriptAnalyzer settings.

I would like to be able to get more information about the problem and any workarounds that might exist.

Proposed Design

Make "This setting may not work as expected currently!" a hyperlink that goes to the corresponding issue's web page. After a quick GitHub search, it seems that #3168 might be the one.

If it is not a simple situation (e.g. multiple GitHub issues exist), then link to a page in the documentation that explains the matter.

[Zian]

System Information:

code --version:
1.80.0
660393deaaa6d1996740ff4880f1bad43768c814
x64

code --list-extensions --show-versions | Select-String powershell:
ms-vscode.powershell@2023.6.0

$psEditor.EditorServicesVersion says:
Major Minor Build Revision

---

3 8 7 0

$PSVersionTable:
Name Value

---

PSVersion 7.2.12
PSEdition Core
GitCommitId 7.2.12
OS Microsoft Windows 10.0.17763
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0

[andyleejordan]

Good idea, thanks for it. We have fixing up the PSSA settings on our short list!