Any plans for adding fixers to the eslint plugin rule?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
First off, thanks for the eslint plugin that provides the rule to check for valid TS Doc comments as per the TSDoc spec.
We recently adapted the plugin, but manually fixing thousands of lines of code is painful even if we come up with fancy regexes.
Are there any plans to add fixers to fix any of the invalid syntax?
Even if the infrastructure to fix 1 simple invalid syntax is put in place, we can help add the rest following the format.
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 rule that checks TypeScript doc comments against the TSDoc spec, then identify how invalid syntax is reported and where fixer support would fit. Define the infrastructure for fixing one simple invalid syntax and consider how additional fixers could follow the same format; done means the rule can safely apply and validate that first automatic fix.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100