PowerShell / PowerShell/PSScriptAnalyzer
[formatter] Comment to let formatter ignore contents
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
Summary of the new feature
A common feature of formatter is to ignore formatting for rest of lines/range of lines with special comments.
I propose this feature because formatting rules in pssa are rather bold, you can't get a finer control on the style, so ignoring certain part can save my code from being messed up.
# ignore a range of lines
# pssa: ignore format start
echo foo
echo bar
# pssa: ignore format end
# ignore the rest of lines
# pssa: ignore format
echo foo
Proposed technical implementation details (optional)
What is the latest version of PSScriptAnalyzer at the point of writing
I don't know, I use powershell-editor-services
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.
Research direction
No files, tests, or formatter entry points are named in the issue. Start by locating the PSScriptAnalyzer formatter implementation and its handling of comments, then inspect existing formatter tests. Done means supporting the proposed range markers and the single comment that ignores all following lines without formatting the enclosed code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100