Enforce documentation.yml toc coverage via ESLint#2435
Merged
Conversation
JSDoc documented items missing from the documentation.yml toc render at an arbitrary spot at the end of the generated docs. Since the docs workflow only runs on master, this used to go unnoticed until after publishing. Add a custom ESLint rule that reports documented top level items that are not listed in the toc, giving fast feedback from lint runs. The rule lives in the pageflow package's shared config directory, like the jest and webpack configs reused by entry type packages. Add toc entries for previously unlisted items. Document the error boundary property via the established underscored @name pattern: only an explicit @name suppresses the inferred memberof, which would otherwise prevent toc matching, and the docs theme renders the underscore as a dot (frontend.contentElementErrorBoundary).
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
1 participant
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.
JSDoc documented items missing from the documentation.yml toc render at an arbitrary spot at the end of the generated docs. Since the docs workflow only runs on master, this used to go unnoticed until after publishing.
Add a custom ESLint rule that reports documented top level items that are not listed in the toc, giving fast feedback from lint runs. The rule lives in the pageflow package's shared config directory, like the jest and webpack configs reused by entry type packages.
Add toc entries for previously unlisted items. Document the error boundary property via the established underscored @name pattern: only an explicit @name suppresses the inferred memberof, which would otherwise prevent toc matching, and the docs theme renders the underscore as a dot (frontend.contentElementErrorBoundary).