microsoft / microsoft/TypeScript
JSDoc : support @interface and @implements (and more)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
I would like to re-open an issue: https://github.com/microsoft/TypeScript/issues/16142
As it is locked I am to open this new issue.
I personally do not like TypeScript as a language, I do however, like TypeScript as a tool for my JavaScript projects, hence why I would like more support for JSDoc.
Code
In a JavaScript file, with checkJs option :
/**
* @interface Something
*/
/**
* @function
* @name Something#hello
* @param {string} name
*/
/**
* @implements {Something}
*/
const something = {};
Actual behavior:
No error.
Expected behavior:
An error should be raised. It's important in checkJs mode as JavaScript doesn't have native interfaces.
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 with the TypeScript checkJs path for the JavaScript example and inspect how the @interface, @implements, and @function JSDoc tags are currently interpreted. Reproduce the example, then define the diagnostics expected for the interface implementation and verify them with the relevant compiler tests; done means checkJs reports the missing interface contract.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100