Skip to content

fix(docs): pnpm dev:docs and build:docs work on Windows #205

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
jimmeryn wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −4
Open

fix(docs): pnpm dev:docs and build:docs work on Windows #205

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
18 changes: 14 additions & 4 deletions apps/docs/scripts/generate-ui-api.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import { execFile } from 'node:child_process';
import { existsSync, globSync, readFileSync } from 'node:fs';
import { mkdir, readFile, writeFile } from 'node:fs/promises';
import { createRequire } from 'node:module';
import path from 'node:path';
import process from 'node:process';
import { fileURLToPath } from 'node:url';
Expand All @@ -30,24 +31,33 @@ const uiApiReferenceEntryFile = path.resolve(documentsRoot, 'src/generated/ui-ty
const UI_BARREL_IMPORT = '@ui/index';
const uiApiReferenceCategoriesFile = path.resolve(documentsRoot, 'src/generated/ui-api-categories.json');
const tdJson = path.resolve(documentsRoot, 'node_modules/.cache/ui-typedoc.json');
// node_modules/.bin/typedoc is a POSIX shim that Windows cannot spawn; run the package's own bin with node.
const TYPEDOC_PACKAGE = createRequire(import.meta.url).resolve('typedoc/package.json');
const TYPEDOC_BIN = path.join(
path.dirname(TYPEDOC_PACKAGE),
JSON.parse(readFileSync(TYPEDOC_PACKAGE, 'utf8')).bin.typedoc,
);

// Engineering notes in the CSS, never public documentation.
const INTERNAL_NOTE_RE = /missing token/i;

// TypeDoc reads entry points as globs, where a Windows \ is an escape; the run's cwd is repoRoot.
const toGlob = (file) => path.relative(repoRoot, file).replaceAll(path.sep, '/');

async function runTypedoc() {
await mkdir(path.dirname(tdJson), { recursive: true });
const bin = path.resolve(documentsRoot, 'node_modules/.bin/typedoc');
await promisify(execFile)(
bin,
process.execPath,
[
TYPEDOC_BIN,
'--json',
tdJson,
// Whole tree, not the barrel: variant prop types are not re-exported.
'--entryPoints',
path.resolve(uiSource, 'components'),
toGlob(path.resolve(uiSource, 'components')),
// A type outside the entry tree gets no reflection and vanishes from the tables.
'--entryPoints',
path.resolve(uiSource, 'shared'),
toGlob(path.resolve(uiSource, 'shared')),
'--entryPointStrategy',
'expand',
'--tsconfig',
Expand Down
Loading