eslint-plugin-esdoc not respecting noStandardTags default (false)
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- documentation, tooling
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.
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"
}
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
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.
More from microsoft/tsdoc
-
Difficulty 3/5 1-2 days Newbie friendliness 72/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·