microsoft / microsoft/TypeScript-TmLanguage
Be less strict about which characters can appear in a JSDoc property name
Open
Nobody has claimed this yet.
Accepting PRs
help wanted
- Dominant language
- TypeScript
- Stars
- 471
- Forks
- 149
- PR merge metrics
- No merged PRs in 30d
Description
From https://github.com/microsoft/TypeScript/issues/36047
TS and JS Grammar Extension version: 0.0.53 / latest
Code
/**
* @typedef Foo
* @property {string} bar Property shows in intellisense
* @property {string} @baz Property should show in intellisense but does not
* @property {string} even#ThisShouldBeAValidName! But the name is not parsed as expeted
*/
Bug
@baz and even#ThisShouldBeAValidName! are not parsed as single property names
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
Start with the TypeScript and JavaScript grammar extension linked in the issue and reproduce the JSDoc examples shown. Trace how property names are parsed, then verify that @baz and even#ThisShouldBeAValidName! are each treated as single names and appear in IntelliSense.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100