microsoft / microsoft/TypeScript
[Salsa] Support jsdoc `@namespace`
Open
Nobody has claimed this yet.
Committed
Domain: JavaScript
Domain: JSDoc
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Support treating variable declarations with @namespace JSDoc tag as TS namespaces.
/** @namespace */
var Documents = {
/**
* An ordinary newspaper.
*/
Newspaper: 1,
/**
* My diary.
* @private
*/
Diary: 2
};
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 Salsa's handling of JSDoc tags on variable declarations and its representation of TypeScript namespaces. Use the issue's @namespace example as the acceptance case: the declaration should be treated as a TS namespace, with the public Newspaper member and private Diary member represented accordingly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100