eslint-plugin-tsdoc: Missing rule to check for absence of a TSDoc comment
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
The documentation eslint-plugin-tsdoc is very vague, as I understand there is only one rule that validates the entire comment block for syntax adherence, but not much else that is necessary for a complete linting solution.
For example: what is the equivalent of jsdoc/require-jsdoc?
Do I need to use jsdoc and tsdoc on my ESLint configuration?
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 existing eslint-plugin-tsdoc rule and the ESLint configuration referenced in the issue. Compare the requested behavior with jsdoc/require-jsdoc and determine whether a TSDoc equivalent is needed; done means the supported configuration and resulting rule behavior are documented and covered by appropriate tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100