Eslint-plugin-tsdoc - no messageId / support for "tsdoc-unsupported-html-name" rule
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
If you set the suppported config option in your tsdoc.json file:
"reportUnsupportedHtmlElements": true,
then you cannot use the eslint-plugin-tsdoc, as it crashes due to not having support for the tsdoc rule.
\ Processing: electron\managers\MonitorManager.ts
Oops! Something went wrong! :(
ESLint: 9.39.1
TypeError: context.report() called with a messageId of 'tsdoc-unsupported-html-name' which is not present in the 'messages' config: {
"error-loading-config-file": "Error loading TSDoc config file:\n{{details}}",
"error-applying-config": "Error applying TSDoc configuration: {{details}}",
"tsdoc-at-sign-in-word": "tsdoc-at-sign-in-word: {{unformattedText}}",
"tsdoc-at-sign-without-tag-name": "tsdoc-at-sign-without-tag-name: {{unformattedText}}",
"tsdoc-characters-after-block-tag": "tsdoc-characters-after-block-tag: {{unformattedText}}",
"tsdoc-characters-after-inline-tag": "tsdoc-characters-after-inline-tag: {{unformattedText}}",
"tsdoc-code-fence-closing-indent": "tsdoc-code-fence-closing-indent: {{unformattedText}}",
"tsdoc-code-fence-closing-syntax": "tsdoc-code-fence-closing-syntax: {{unformattedText}}",
"tsdoc-code-fence-missing-delimiter": "tsdoc-code-fence-missing-delimiter: {{unformattedText}}",
"tsdoc-code-fence-opening-indent": "tsdoc-code-fence-opening-indent: {{unformattedText}}",
"tsdoc-code-fence-specifier-syntax": "tsdoc-code-fence-specifier-syntax: {{unformattedText}}",
"tsdoc-code-span-empty": "tsdoc-code-span-empty: {{unformattedText}}",
"tsdoc-code-span-missing-delimiter": "tsdoc-code-span-missing-delimiter: {{unformattedText}}",
"tsdoc-comment-missing-closing-delimiter": "tsdoc-comment-missing-closing-delimiter: {{unformattedText}}",
"tsdoc-comment-missing-opening-delimiter": "tsdoc-comment-missing-opening-delimiter: {{unformattedText}}",
"tsdoc-comment-not-found": "tsdoc-comment-not-found: {{unformattedText}}",
"tsdoc-config-cyclic-extends": "tsdoc-config-cyclic-extends: {{unformattedText}}",
"tsdoc-config-duplicate-tag-name": "tsdoc-config-duplicate-tag-name: {{unformattedText}}",
"tsdoc-config-file-not-found": "tsdoc-config-file-not-found: {{unformattedText}}",
"tsdoc-config-invalid-json": "tsdoc-config-invalid-json: {{unformattedText}}",
"tsdoc-config-invalid-tag-name": "tsdoc-config-invalid-tag-name: {{unformattedText}}",
"tsdoc-config-schema-error": "tsdoc-config-schema-error: {{unformattedText}}",
"tsdoc-config-undefined-tag": "tsdoc-config-undefined-tag: {{unformattedText}}",
"tsdoc-config-unresolved-extends": "tsdoc-config-unresolved-extends: {{unformattedText}}",
"tsdoc-config-unsupported-schema": "tsdoc-config-unsupported-schema: {{unformattedText}}",
"tsdoc-escape-greater-than": "tsdoc-escape-greater-than: {{unformattedText}}",
"tsdoc-escape-right-brace": "tsdoc-escape-right-brace: {{unformattedText}}",
"tsdoc-extra-inheritdoc-tag": "tsdoc-extra-inheritdoc-tag: {{unformattedText}}",
"tsdoc-html-string-missing-quote": "tsdoc-html-string-missing-quote: {{unformattedText}}",
"tsdoc-html-tag-missing-equals": "tsdoc-html-tag-missing-equals: {{unformattedText}}",
"tsdoc-html-tag-missing-greater-than": "tsdoc-html-tag-missing-greater-than: {{unformattedText}}",
"tsdoc-html-tag-missing-string": "tsdoc-html-tag-missing-string: {{unformattedText}}",
"tsdoc-inheritdoc-incompatible-summary": "tsdoc-inheritdoc-incompatible-summary: {{unformattedText}}",
"tsdoc-inheritdoc-incompatible-tag": "tsdoc-inheritdoc-incompatible-tag: {{unformattedText}}",
"tsdoc-inheritdoc-tag-syntax": "tsdoc-inheritdoc-tag-syntax: {{unformattedText}}",
"tsdoc-inline-tag-missing-braces": "tsdoc-inline-tag-missing-braces: {{unformattedText}}",
"tsdoc-inline-tag-missing-right-brace": "tsdoc-inline-tag-missing-right-brace: {{unformattedText}}",
"tsdoc-inline-tag-unescaped-brace": "tsdoc-inline-tag-unescaped-brace: {{unformattedText}}",
"tsdoc-link-tag-destination-syntax": "tsdoc-link-tag-destination-syntax: {{unformattedText}}",
"tsdoc-link-tag-empty": "tsdoc-link-tag-empty: {{unformattedText}}",
"tsdoc-link-tag-invalid-url": "tsdoc-link-tag-invalid-url: {{unformattedText}}",
"tsdoc-link-tag-unescaped-text": "tsdoc-link-tag-unescaped-text: {{unformattedText}}",
"tsdoc-malformed-html-name": "tsdoc-malformed-html-name: {{unformattedText}}",
"tsdoc-malformed-inline-tag": "tsdoc-malformed-inline-tag: {{unformattedText}}",
"tsdoc-malformed-tag-name": "tsdoc-malformed-tag-name: {{unformattedText}}",
"tsdoc-missing-deprecation-message": "tsdoc-missing-deprecation-message: {{unformattedText}}",
"tsdoc-missing-html-end-tag": "tsdoc-missing-html-end-tag: {{unformattedText}}",
"tsdoc-missing-reference": "tsdoc-missing-reference: {{unformattedText}}",
"tsdoc-missing-tag": "tsdoc-missing-tag: {{unformattedText}}",
"tsdoc-param-tag-missing-hyphen": "tsdoc-param-tag-missing-hyphen: {{unformattedText}}",
"tsdoc-param-tag-with-invalid-name": "tsdoc-param-tag-with-invalid-name: {{unformattedText}}",
"tsdoc-param-tag-with-invalid-optional-name": "tsdoc-param-tag-with-invalid-optional-name: {{unformattedText}}",
"tsdoc-param-tag-with-invalid-type": "tsdoc-param-tag-with-invalid-type: {{unformattedText}}",
"tsdoc-reference-empty-identifier": "tsdoc-reference-empty-identifier: {{unformattedText}}",
"tsdoc-reference-hash-syntax": "tsdoc-reference-hash-syntax: {{unformattedText}}",
"tsdoc-reference-malformed-import-path": "tsdoc-reference-malformed-import-path: {{unformattedText}}",
"tsdoc-reference-malformed-package-name": "tsdoc-reference-malformed-package-name: {{unformattedText}}",
"tsdoc-reference-missing-colon": "tsdoc-reference-missing-colon: {{unformattedText}}",
"tsdoc-reference-missing-dot": "tsdoc-reference-missing-dot: {{unformattedText}}",
"tsdoc-reference-missing-hash": "tsdoc-reference-missing-hash: {{unformattedText}}",
"tsdoc-reference-missing-identifier": "tsdoc-reference-missing-identifier: {{unformattedText}}",
"tsdoc-reference-missing-label": "tsdoc-reference-missing-label: {{unformattedText}}",
"tsdoc-reference-missing-quote": "tsdoc-reference-missing-quote: {{unformattedText}}",
"tsdoc-reference-missing-right-bracket": "tsdoc-reference-missing-right-bracket: {{unformattedText}}",
"tsdoc-reference-missing-right-paren": "tsdoc-reference-missing-right-paren: {{unformattedText}}",
"tsdoc-reference-selector-missing-parens": "tsdoc-reference-selector-missing-parens: {{unformattedText}}",
"tsdoc-reference-selector-syntax": "tsdoc-reference-selector-syntax: {{unformattedText}}",
"tsdoc-reference-symbol-syntax": "tsdoc-reference-symbol-syntax: {{unformattedText}}",
"tsdoc-reference-unquoted-identifier": "tsdoc-reference-unquoted-identifier: {{unformattedText}}",
"tsdoc-tag-should-not-have-braces": "tsdoc-tag-should-not-have-braces: {{unformattedText}}",
"tsdoc-text-after-html-string": "tsdoc-text-after-html-string: {{unformattedText}}",
"tsdoc-undefined-tag": "tsdoc-undefined-tag: {{unformattedText}}",
"tsdoc-unnecessary-backslash": "tsdoc-unnecessary-backslash: {{unformattedText}}",
"tsdoc-unsupported-tag": "tsdoc-unsupported-tag: {{unformattedText}}"
}
Occurred while linting C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\electron\managers\MonitorManager.ts:11
Rule: "tsdoc/syntax"
at computeMessageFromDescriptor (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\file-report.js:458:10)
at FileReport.addRuleMessage (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\file-report.js:540:27)
at FileContext.report (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\linter.js:1111:28)
at checkCommentBlocks (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint-plugin-tsdoc\lib\index.js:115:37)
at ruleErrorHandler (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\linter.js:1173:33)
at C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\source-code-visitor.js:76:46
at Array.forEach (<anonymous>)
at SourceCodeVisitor.callSync (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\source-code-visitor.js:76:30)
at C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\source-code-traverser.js:291:18
at Array.forEach (<anonymous>)
at SourceCodeTraverser.traverseSync (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\source-code-traverser.js:290:10)
at runRules (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\linter.js:1214:12)
at #flatVerifyWithoutProcessors (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\linter.js:2101:4)
at Linter._verifyWithFlatConfigArrayAndWithoutProcessors (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\linter.js:2189:43)
at Linter._verifyWithFlatConfigArray (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\linter.js:2292:15)
at Linter.verify (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\linter.js:1677:10)
at ESLinter.verify (file:///C:/Users/Nick/Dropbox/PC%20(2)/Documents/GitHub/Uptime-Watcher/node_modules/eslint-plugin-mdx/lib/processors/options.js:17:19)
at Linter.verifyAndFix (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\linter\linter.js:2557:20)
at verifyText (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\eslint\eslint-helpers.js:1180:45)
at readAndVerifyFile (C:\Users\Nick\Dropbox\PC (2)\Documents\GitHub\Uptime-Watcher\node_modules\eslint\lib\eslint\eslint-helpers.js:1321:10)
Is this out of scope or something that could be fixed?
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 reproducing the failure with tsdoc.json set to reportUnsupportedHtmlElements: true and inspect eslint-plugin-tsdoc/lib/index.js, especially the tsdoc/syntax rule. Confirm how the unsupported HTML diagnostic reaches context.report(). Done means linting reports the diagnostic without crashing and coverage verifies the new messageId support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100