Skip to content

Report docs previews dropped for a missing example file #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryoaonetsuki wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Report docs previews dropped for a missing example file #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions scripts/build-docs.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ const slug = (text) =>
// The whole name: "className" must not be found inside "previewClassName".
const attr = (tag, name) => tag.match(new RegExp(`(?:^|[\\s<])${name}="([^"]*)"`))?.[1]

// Previews dropped because their example file does not exist, by page. A name
// ending in -rtl is not one: those examples are never files, and the RTL
// heading they sit under is skipped below, so nothing is lost.
const dropped = []

function parse(file, section) {
const raw = readFileSync(file, "utf8")
const front = raw.match(/^---\n([\s\S]*?)\n---\n/)
Expand Down Expand Up @@ -98,6 +103,7 @@ function parse(file, section) {
flush()
const [tag, end] = tagAt(i)
const name = attr(tag, "name")
if (name && !hasExample(name) && !name.endsWith("-rtl")) dropped.push(`${file.slice(root.length + 1)}: ${name}`)
if (name && hasExample(name)) {
blocks.push({
type: "preview",
Expand Down Expand Up @@ -214,3 +220,10 @@ const legacy = join(out, "generated.json")
if (existsSync(legacy)) unlinkSync(legacy)

console.log(`docs: ${pages.length} pages -> src/docs/catalog.json + src/docs/pages/`)
if (dropped.length) {
// A warning, not a failure: the pages below already ship without these
// examples, and failing here would block the build until each one is
// written. The list is the work to do, not a reason to stop.
console.error(`docs: ${dropped.length} preview(s) dropped, no example file:`)
for (const entry of dropped) console.error(` ${entry}`)
}