Add tsdoc-unsupported-html-name to allTsdocMessageIds. Fixes #453 - #484
Open
Christopher Pruijsen (cpruijsen) wants to merge 1 commit into
Open
Add tsdoc-unsupported-html-name to allTsdocMessageIds. Fixes #453#484Christopher Pruijsen (cpruijsen) wants to merge 1 commit into
Christopher Pruijsen (cpruijsen) wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
eslint-plugin-tsdoccrashes on ESLint 9 whenreportUnsupportedHtmlElementsis enabled, because the parser emitstsdoc-unsupported-html-nameand that id was missing fromTSDocConfiguration.allTsdocMessageIds(the list the plugin copies intometa.messages).tsdoc-malformed-html-name, matching enum order) and a test that everyTSDocMessageIdis known, including the unsupported-HTML parse path.Decision
'tsdoc-unsupported-html-name'to the explicitallTsdocMessageIdsarray, matching Add tsdoc-characters-after-block-tag in allTsdocMessageIds #212, plus a completeness test so the two lists cannot silently drift again.allTsdocMessageIdsfrom the enum (const enums were removed in 0.15.0), and/or also add aneslint-plugin-tsdocpatch changefile so a plugin republish depends on the patched@microsoft/tsdoc.The reporter's stack on #453 names
tsdoc-unsupported-html-nameas the missingmessageId.NodeParseralready emitsTSDocMessageId.UnsupportedHtmlElementNamewhenreportUnsupportedHtmlElementsis true. This is not a missing ESLint rule; there is still one rule,tsdoc/syntax.Test plan
allTsdocMessageIds includes every TSDocMessageId enum valuefails without the catalog line and passes with itunsupported HTML elements report a known message idfails without the catalog line and passes with it@microsoft/tsdoctests (257) passrush change --verifyaccepts the patch changefile undercommon/changes/@microsoft/tsdoc/eslint-plugin-tsdocwithreportUnsupportedHtmlElements: truereportstsdoc-unsupported-html-nameinstead of throwing (needs aneslint-plugin-tsdocrelease whose@microsoft/tsdocdependency includes this patch)