Skip to content

Add tsdoc-unsupported-html-name to allTsdocMessageIds. Fixes #453 - #484

Open
Christopher Pruijsen (cpruijsen) wants to merge 1 commit into
microsoft:mainfrom
cpruijsen:fix/issue-453
Open

Add tsdoc-unsupported-html-name to allTsdocMessageIds. Fixes #453#484
Christopher Pruijsen (cpruijsen) wants to merge 1 commit into
microsoft:mainfrom
cpruijsen:fix/issue-453

Conversation

@cpruijsen

Copy link
Copy Markdown

Summary

Decision

  • Chose: add 'tsdoc-unsupported-html-name' to the explicit allTsdocMessageIds array, matching Add tsdoc-characters-after-block-tag in allTsdocMessageIds #212, plus a completeness test so the two lists cannot silently drift again.
  • Alternative: derive allTsdocMessageIds from the enum (const enums were removed in 0.15.0), and/or also add an eslint-plugin-tsdoc patch changefile so a plugin republish depends on the patched @microsoft/tsdoc.
  • Why: smallest reversible fix that matches how this repo already solved the identical ESLint crash. The test is what Add tsdoc-characters-after-block-tag in allTsdocMessageIds #212 did not add, which is why this happened again. Happy to switch to an enum-derived catalog and/or a plugin patch bump if you want that in this PR.

The reporter's stack on #453 names tsdoc-unsupported-html-name as the missing messageId. NodeParser already emits TSDocMessageId.UnsupportedHtmlElementName when reportUnsupportedHtmlElements is true. This is not a missing ESLint rule; there is still one rule, tsdoc/syntax.

Test plan

  • allTsdocMessageIds includes every TSDocMessageId enum value fails without the catalog line and passes with it
  • unsupported HTML elements report a known message id fails without the catalog line and passes with it
  • Full @microsoft/tsdoc tests (257) pass
  • rush change --verify accepts the patch changefile under common/changes/@microsoft/tsdoc/
  • After publish, confirm eslint-plugin-tsdoc with reportUnsupportedHtmlElements: true reports tsdoc-unsupported-html-name instead of throwing (needs an eslint-plugin-tsdoc release whose @microsoft/tsdoc dependency includes this patch)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Eslint-plugin-tsdoc - no messageId / support for "tsdoc-unsupported-html-name" rule

1 participant