PowerShell / PowerShell/vscode-powershell
Outline - Optionally treat and show `#` as H1, `##` as H2
Nobody has claimed this yet.
- 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
I've written so much markdown that I format my PowerShell scripts and comments by markdown headings.
# First section
## I do something
do-something
## Then I do something else
do-somethingelse
# Second section
do-somethingwithoutputfromfirstsection
It'd be very useful with the ability to show these comments as sections in the outline pane, treat them as markdown headings.
#as H1 / level 1##as H2 / level 2###as H3 / level 3
Etc.
I know I can use #region, but I don't like how it looks.
Proposed Design
Maybe a farfetched idea? Not something that should be enabled by default.
{
"powershell.treatCommentsAsMarkdownHeadings": true
}
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
Start by locating the PowerShell outline implementation and the extension settings registration. Use the proposed powershell.treatCommentsAsMarkdownHeadings setting and the example comments as the behavioral guide; done means enabled comments appear in the outline at matching heading levels while the default behavior remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, typescript, vscode
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100