Repository navigation
Report docs previews dropped for a missing example file - #65
Open
ryoaonetsuki wants to merge 1 commit into
Open
ryoaonetsuki wants to merge 1 commit into
ryoaonetsuki wants to merge 1 commit into
Conversation
Signed-off-by: ryoaonetsuki <ryoaonetsuki@users.noreply.github.com>
This branch has not been deployed
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.
Why
scripts/build-docs.mjssilently drops a<ComponentPreview>whose examplefile does not exist. Today that hides 11 previews:
bubble-variants,calendar-hijri, and 8 on the Message Scroller page (message-scroller-demo,-anchoring,-previous-context,-streaming,-load-history,-animation,-commands,-visibility,-scrollable). A section that says "in the examplebelow" then shows no example, and nobody finds out from the build.
What changes
build-docsnow prints every dropped preview to stderr, with its page, at theend of a successful run. Names ending in
-rtlare exempt: those examples arenever files, and the RTL heading they sit under is skipped anyway, so nothing
is lost there.
This is a warning, not a failure, on purpose: those 11 drops already ship, and
failing here would block the build until each missing example is written. The
list is the work to do, not a reason to stop.
How it was checked
node scripts/build-docs.mjsprints exactly the 11 drops above, no-rtlnames, and exits 0; the generated pages are otherwise unchanged.
node --test scripts/block-metadata.test.mjs(8 pass),npm run typecheck,and
npm run buildpass;registry.jsonis unchanged.