eslint-plugin-tsdoc: option to allow dots in parameters name? (feature request)
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Until https://github.com/microsoft/tsdoc/issues/19 is resolved it would be nice if eslint-plugin-tsdoc could offer an option to allow dots in parameter names like typeDoc supports. Now we either have to disable TSDoc linting completely or filter out the error like https://www.npmjs.com/package/eslint-plugin-verify-tsdoc/v/1.0.5 does
Alternatively it could be an option in tsdoc.json ?
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 checking how eslint-plugin-tsdoc handles parameter names and whether this repository owns that plugin or only the TSDoc specification. Read microsoft/tsdoc#19, the referenced tsdoc.json and api-extractor/extends/tsdoc-base.json, and compare TypeDoc and eslint-plugin-verify-tsdoc behavior. Done means the supported configuration location and dot-handling behavior are defined and documented.
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