PowerShell / PowerShell/vscode-powershell

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

Open Beginner friendly
#4,653 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Code Formatting Issue-Enhancement
Dominant language
TypeScript
Stars
1.9k
Forks
547
PR merge metrics
No merged PRs in 30d

Description

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 https://github.com/PowerShell/vscode-powershell/issues/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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open package.json and locate the powershell.scriptAnalysis.settingsPath description around the referenced setting. Check issue 3168 and the surrounding issue context first, then update the warning so it links to the relevant issue or documentation page. Done means the setting description provides a useful path to a workaround or further explanation.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell, vscode
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.