PowerShell / PowerShell/vscode-powershell
Allow customization of default values for comment help fields like SYNOPSIS, LINK, and NOTES
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.9k
- Forks
- 547
- PR merge metrics
- No merged PRs in 30d
Description
A customizable file header type situation would be pretty cool.
Things like a default synopsis that includes a custom heading with author that pulls current user, update time, created time, stuff like that.
Also a .LINK comment with a customizable text entry to make linking to internal online powershell documentation easier.
Also thanks for making the comment block snippet at all, it's amazing.
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
The issue names no files, tests, or entry points. Start by locating the comment block snippet implementation in the VS Code extension and review how its default fields are defined; done should mean users can customize defaults for fields such as SYNOPSIS, LINK, and NOTES.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100