powershell.scriptAnalysis.settingsPath (Description): Warning Message Should Provide A Workaround
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- powershell, vscode
- Domain
- documentation
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.
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.
- Dominant language
- TypeScript
- Stars
- 1.9k
- Forks
- 548
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PowerShell/vscode-powershell
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
PowerShell/vscode-powershell#5599 · 3 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PowerShell/vscode-powershell#5592 · 2 comments · 1 reaction ·
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
PowerShell/vscode-powershell#5583 · 1 comment ·
-
nothing OpenIssue-Bug Needs: Triage
Difficulty 5/5 Over a week Newbie friendliness 5/100
PowerShell/vscode-powershell#5603 · 1 reaction ·
-
agentic-workflows
Difficulty 3/5 1-2 days Newbie friendliness 52/100
PowerShell/vscode-powershell#5602 ·
All issues in PowerShell/vscode-powershell
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100