eslint-plugin-esdoc not respecting noStandardTags default (false)
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
If I use this tsdoc.json
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"supportForTags": {
"@fileoverview": true,
"@name": true
},
"tagDefinitions": [
{
"tagName": "@fileoverview",
"syntaxKind": "block",
"allowMultiple": false
},
{
"tagName": "@name",
"syntaxKind": "modifier",
"allowMultiple": false
}
]
}
Then all the standard tags are giving errors:
Same result if I explicitly set noStandardTags: false
Do I have to add them all to supportForTags?
Or is there a reference file I can add to extends?
Neither of those options make sense as tagDefinitions says "Additional tags to support when parsing documentation comments with TSDoc" which implies they're additional to the standard tags.
eslint versions:
{
"@eslint/js": "^9.9.1",
"eslint": "^9.9.1",
"eslint-plugin-tsdoc": "^0.3.0",
"typescript-eslint": "^8.3.0"
}
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
No repository file or test is named. Reproduce the report with the supplied tsdoc.json and ESLint versions, then trace how eslint-plugin-tsdoc handles noStandardTags and standard tags; done means standard tags no longer error when noStandardTags is false.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100