microsoft / microsoft/TypeScript-TmLanguage
Highlighting for JSDoc 3.5.0 `@access package` missing
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 471
- Forks
- 149
- PR merge metrics
- No merged PRs in 30d
Description
Noticed it while looking for an explanation on why VSCode had highlighting for the apparently undocumented @api JSDoc tag, see microsoft/vscode#189812.
JSDoc 3.5.0 introduced support for the @package tag together with the corresponding package value for the @access tag. However, the value does not currently have special highlighting in VSCode like the other supported values (private, protected, public).
Contributor guide
No contributing guide indexed for this repository
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 points to VS Code's JSDoc highlighting and the @access values private, protected, and public; start by locating the grammar entry that defines those values. Add matching highlighting for package, then verify in VS Code that @access package is highlighted consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, vscode
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100