eslint-plugin-tsdoc: suggest a rule to check misused function comment
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
raise a error for this:
bad:
// function comment not recognized by tsc
const getShortName = (name: string): string => {
...
}
tsc doesn't think this is a function comment and doesn't emit it in type definition.
good:
/**
* function comment not recognized by tsc
*/
const getShortName = (name: string): string => {
...
}
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 by reviewing the eslint-plugin-tsdoc rule area referenced in the issue title and compare the bad and good TypeScript examples. Define the diagnostic for a single-line function comment that is not recognized by tsc, while accepting the equivalent /** */ comment; done means the rule distinguishes these cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100