Validate

The validate command ensures that committed files match the expected output. It processes all page.mdx files to verify parent indexes are up-to-date, and all types.ts files to ensure generated types.md documentation is current.

pnpm docs-infra validate [paths...]

pnpm docs-infra validate

Processes all page.mdx files in src/app/ and app/ directories.

pnpm docs-infra validate docs-infra/components docs-infra/functions

Only validates indexes under the specified paths.

pnpm docs-infra validate --useVisibleDescription

Uses the first visible paragraph in each page as the description, instead of the meta tag.

pnpm docs-infra validate --indexes

Only processes page.mdx files, skipping types validation.

pnpm docs-infra validate --types

Only processes types.ts files, skipping index validation.

1. Find Files: Searches for all page.mdx files in the app directories
2. Process Metadata: Runs each file through the unified pipeline with transformMarkdownMetadata
3. Check Indexes: Compares generated metadata against existing index files
4. Report Results: Lists which indexes were updated and their paths

1. Find Files: Searches for all types.ts files in the app directories
2. Parse Factory Calls: Extracts createTypesMeta calls from each file
3. Sync Types: Runs syncTypes to regenerate type documentation
4. Report Results: Lists which types.md files were updated

In CI environments (CI=true), the command exits with error code 1 if any files changed, suggesting the command to run locally.

Validating committed files match expected output...

Processing 47 indexed page.mdx files...

Processing 12 types.md files...

No files needed updating

✓ 0 files updated in 1.23s [indexes: 0.85s, types: 0.38s]

Validating committed files match expected output...

Processing 47 indexed page.mdx files...

Updated index files:
  app/docs-infra/components/page.mdx
  app/docs-infra/functions/page.mdx

Processing 12 types.md files...

Updated types.md files:
  app/docs-infra/components/code-highlighter/types.md

Total: 3 files updated

✓ 3 files updated in 1.45s [indexes: 0.92s, types: 0.53s]

When running in CI (CI=true) and files are out of date:

Updated index files:
  app/docs-infra/components/page.mdx

Updated types.md files:
  app/docs-infra/components/code-highlighter/types.md

Total: 2 files updated

✓ 2 files updated in 1.23s [indexes: 0.85s, types: 0.38s]

✗ Generated files are out of date. Run this command locally:

  pnpm docs-infra validate docs-infra/components

Then commit the results.

Exit code: 1

The command uses marker files to track which indexes were updated:

• Location: .next/cache/docs-infra/index-updates/
• These files are temporary and cleaned up before each run
• Used to determine which paths to suggest in CI error messages

The validate command uses the transformMarkdownMetadata plugin internally:

const processor = unified()
  .use(remarkParse)
  .use(remarkMdx)
  .use(transformMarkdownMetadata, {
    extractToIndex: {
      include: includePatterns,
      exclude: [],
      baseDir: cwd,
      onlyUpdateIndexes: true,
      markerDir: '.next/cache/docs-infra/index-updates',
      useVisibleDescription,
    },
  });

• transformMarkdownMetadata - Remark plugin for metadata extraction
• syncPageIndex - Function that performs the actual index updates
• syncTypes - Function that generates type documentation
• createSitemap - Uses extracted metadata for search