microsoft / microsoft/TypeScript
Support a @nonnull/@nonnullable JSDoc assertion comment
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
This could be used in place of the non-null assertion operator, and solve #23403.
while (queue.length) {
(/** @nonnull */ queue.pop())();
}
Related is #23217, which tracks definite assignment assertions.
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 issue's @nonnull example and review related issues #23403 and #23217 to understand the intended assertion behavior and its relationship to non-null and definite-assignment assertions. Done means agreeing on the supported JSDoc syntax and semantics and adding compiler coverage for the proposed usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100