Bug: No existing ESLint rules for unused @typedefs in project
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 38
- Forks
- 23
- Avg merge
- 11m
- Merged PRs (30d)
- 4
Description
Bug Description:
Currently, we're utilizing eslint-plugin-jsdoc for our linting when it comes to JSDoc. However, it does not cover everything such as picking up unused @typedefs. At the moment, the plugin does not have rules for that like it does with no-unused-vars within its configuration, thus people had to manually remove unused @typedefs when found.
Possible Solution (optional):
- Found another plugin or library which assists with existing ESLint rules.
- Create a custom rule for unused
@typedefs - Change syntax for importing
typedefssimilar to that of importing variables/libraries from other files (See screenshots below)
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 project's eslint-plugin-jsdoc configuration and the available ESLint rules for unused @typedef declarations. Compare an existing plugin or library with the custom-rule and import-syntax alternatives described in the issue. Done means the project can reliably identify unused @typedefs without manual removal.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, javascript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100