@metamask-previews/platform-api-docs 0.0.0-preview-a3545aef8 → 0.0.0-preview-1bd5239bf

package/README.md

@@ -6,7 +6,14 @@ When run within a project (such as `metamask-extension` or `metamask-mobile`), t
 
 ## Installation
 
-1. Add this package as a dependency (`yarn add --dev @metamask/platform-api-docs` or `npm install --save-dev @metamask/platform-api-docs`).
+1. Add this package as a development dependency:
+
+   `yarn add @metamask/platform-api-docs`
+
+   or
+
+   `npm install @metamask/platform-api-docs`
+
 2. Add a script to your project's `package.json`. For example:
    ```json
    {

package/dist/cli.cjs

@@ -70,7 +70,9 @@ async function runDocusaurus(command, cwd, extraEnv = {}) {
  * @param outDir - The output directory to set up.
  */
 async function setupSite(outDir) {
-    const siteDir = path.resolve(__dirname, '..', 'site');
+    const packageDir = path.resolve(__dirname, '..');
+    const siteDir = path.join(packageDir, 'site');
+    const packageNodeModules = path.join(packageDir, 'node_modules');
     const skip = new Set(['node_modules', 'docs', 'tsconfig.json']);
     console.log(`\nSetting up Docusaurus site in ${outDir}...`);
     // `fs.cp` has been available since Node 16.7 and only got the "stable"
@@ -81,6 +83,23 @@ async function setupSite(outDir) {
         recursive: true,
         filter: (source) => !skip.has(path.basename(source)),
     });
+    // Symlink this package's `node_modules` into the output so the copied
+    // `docusaurus.config.ts` and the rest of Docusaurus's bundling pipeline can
+    // resolve their deps the same way they do in the source tree. Without it,
+    // Node's resolver walks up from the output and can't reach our nested deps
+    // when the package is installed as a regular dependency by an external
+    // consumer (e.g. `metamask-extension`, `metamask-mobile`).
+    const linkPath = path.join(outDir, 'node_modules');
+    try {
+        // `'junction'` works cross-platform (POSIX ignores it; Windows uses it
+        // without admin) — `'dir'` would require admin on Windows.
+        await fs.symlink(packageNodeModules, linkPath, 'junction');
+    }
+    catch (error) {
+        if (error.code !== 'EEXIST') {
+            throw error;
+        }
+    }
     // Write a minimal package.json so Docusaurus doesn't warn about a missing one
     const pkgJsonPath = path.join(outDir, 'package.json');
     try {

package/dist/cli.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"cli.cjs","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,2DAA0B;AAC1B,qDAAuC;AACvC,gDAAkC;AAClC,0DAAiC;AACjC,kDAA0B;AAE1B,6CAAsD;AAEtD;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,OAAO,IAAA,mBAAQ,EAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,aAAa,CAC1B,OAAe,EACf,GAAW,EACX,WAAmC,EAAE;IAErC,MAAM,IAAA,eAAK,EAAC,iBAAiB,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE;QAC1C,GAAG;QACH,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE;KACrC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,SAAS,CAAC,MAAc;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhE,OAAO,CAAC,GAAG,CAAC,mCAAmC,MAAM,KAAK,CAAC,CAAC;IAE5D,uEAAuE;IACvE,uEAAuE;IACvE,uEAAuE;IACvE,mEAAmE;IACnE,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE;QAC3B,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KACrD,CAAC,CAAC;IAEH,8EAA8E;IAC9E,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtD,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,EAAE,CAAC,SAAS,CAChB,WAAW,EACX,IAAI,CAAC,SAAS,CACZ,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,IAAI,EAAE,EACjD,IAAI,EACJ,CAAC,CACF,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAAC,WAAmB;IACjD,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,eAAK,EAAC,KAAK,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE;YACtE,GAAG,EAAE,WAAW;SACjB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,MAAM,IAAA,eAAK,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC5C,OAAO,CACN,mBAAmB,EACnB,0HAA0H,EAC1H,CAAC,aAAa,EAAE,EAAE;QAChB,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE;YACvC,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6BAA6B;YAC1C,OAAO,EAAE,GAAG;SACb,CAAC,CAAC;IACL,CAAC,CACF;SACA,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,KAAK,EAAE;QACb,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EACT,4HAA4H;QAC9H,OAAO,EAAE,EAAc;KACxB,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kBAAkB;KAChC,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,yGAAyG;KAC5G,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,kFAAkF;KACrF,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,2EAA2E;KAC9E,CAAC;SACD,IAAI,EAAE,CAAC,IAAI,CAAC;IAEf,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAC1D,CAAC;IACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CACpC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CACpE,CAAC;IACF,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAClD,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAClD,CAAC;IACF,MAAM,YAAY,GAChB,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,QAAQ;QACzC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC;QAC9B,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QACvB,CAAC,CAAC,IAAI,CAAC;IACX,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,MAAM,IAAA,yBAAc,EAAC,mBAAmB,CAAC,CAAC;IAE1D,wBAAwB;IACxB,MAAM,IAAA,mBAAQ,EAAC;QACb,WAAW,EAAE,mBAAmB;QAChC,SAAS,EAAE,iBAAiB;QAC5B,QAAQ;QACR,YAAY;QACZ,SAAS;KACV,CAAC,CAAC;IAEH,mEAAmE;IACnE,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,MAAM,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAEnC,kEAAkE;QAClE,kEAAkE;QAClE,oEAAoE;QACpE,4CAA4C;QAC5C,MAAM,aAAa,GAA2B,EAAE,CAAC;QACjD,IAAI,YAAY,EAAE,CAAC;YACjB,aAAa,CAAC,kBAAkB,GAAG,YAAY,CAAC;QAClD,CAAC;QACD,IAAI,SAAS,EAAE,CAAC;YACd,aAAa,CAAC,eAAe,GAAG,SAAS,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxE,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,CAAC;QACD,IACE,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,QAAQ;YACzC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAChC,CAAC;YACD,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;YACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACjE,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACpC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;YACzC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YAE/D,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;gBACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport execa from 'execa';\nimport * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport npmWhich from 'npm-which';\nimport yargs from 'yargs';\n\nimport { generate, resolveRepoUrl } from './generate';\n\n/**\n * Locate the Docusaurus binary in this package's `node_modules/.bin`. Using\n * `npm-which` lets the lookup track wherever the installed Docusaurus puts\n * its binary, so a future Docusaurus upgrade can't break this path.\n *\n * @returns Absolute path to the `docusaurus` executable.\n */\nfunction resolveDocusaurus(): string {\n  return npmWhich(__dirname).sync('docusaurus');\n}\n\n/**\n * Run a Docusaurus command.\n *\n * @param command - The docusaurus command (start, build, serve).\n * @param cwd - The site directory.\n * @param extraEnv - Extra environment variables passed through to the\n * Docusaurus process (e.g. `DOCS_PROJECT_LABEL`, `DOCS_COMMIT_SHA`,\n * `DOCS_REPO_URL`).\n */\nasync function runDocusaurus(\n  command: string,\n  cwd: string,\n  extraEnv: Record<string, string> = {},\n): Promise<void> {\n  await execa(resolveDocusaurus(), [command], {\n    cwd,\n    stdio: 'inherit',\n    env: { ...process.env, ...extraEnv },\n  });\n}\n\n/**\n * Copy site files into the output directory, skipping `node_modules`, `docs`,\n * and `tsconfig.json`. `docs` is owned by the doc generator and shouldn't be\n * carried over from the source `site/` directory. `tsconfig.json` extends the\n * monorepo's `tsconfig.base.json` via a relative path that only resolves from\n * the source location — it's there for IDE / lint inheritance, not for\n * Docusaurus, which uses `jiti` and doesn't consult the tsconfig at runtime.\n *\n * @param outDir - The output directory to set up.\n */\nasync function setupSite(outDir: string): Promise<void> {\n  const siteDir = path.resolve(__dirname, '..', 'site');\n  const skip = new Set(['node_modules', 'docs', 'tsconfig.json']);\n\n  console.log(`\\nSetting up Docusaurus site in ${outDir}...`);\n\n  // `fs.cp` has been available since Node 16.7 and only got the \"stable\"\n  // marker in 22.3 — it's functional throughout our supported Node range\n  // (`^18.18 || >=20`), even though the linter flags the older versions.\n  // eslint-disable-next-line n/no-unsupported-features/node-builtins\n  await fs.cp(siteDir, outDir, {\n    recursive: true,\n    filter: (source) => !skip.has(path.basename(source)),\n  });\n\n  // Write a minimal package.json so Docusaurus doesn't warn about a missing one\n  const pkgJsonPath = path.join(outDir, 'package.json');\n  try {\n    await fs.access(pkgJsonPath);\n  } catch {\n    await fs.writeFile(\n      pkgJsonPath,\n      JSON.stringify(\n        { name: 'platform-api-docs-site', private: true },\n        null,\n        2,\n      ),\n    );\n  }\n}\n\n/**\n * Resolve the short Git commit SHA the docs are being generated from.\n * Returns null when the project isn't a git repo or git isn't available.\n *\n * @param projectPath - The project root path.\n * @returns The short SHA, or null on failure.\n */\nasync function resolveCommitSha(projectPath: string): Promise<string | null> {\n  try {\n    const { stdout } = await execa('git', ['rev-parse', '--short', 'HEAD'], {\n      cwd: projectPath,\n    });\n    const trimmed = stdout.trim();\n    return trimmed.length > 0 ? trimmed : null;\n  } catch {\n    return null;\n  }\n}\n\n/**\n * Main CLI entry point.\n */\nasync function main(): Promise<void> {\n  const argv = await yargs(process.argv.slice(2))\n    .command(\n      '$0 [project-path]',\n      'Produces documentation for the platform API, the set of actions and events available in clients through the message bus.',\n      (yargsInstance) => {\n        yargsInstance.positional('project-path', {\n          type: 'string',\n          description: 'Path to the project to scan',\n          default: '.',\n        });\n      },\n    )\n    .option('build', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and build a production-ready site',\n      default: false,\n    })\n    .option('serve', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a production-ready site',\n      default: false,\n    })\n    .option('dev', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a development-only site',\n      default: false,\n    })\n    .option('scan-dir', {\n      type: 'string',\n      array: true,\n      description:\n        'Additional directories within the project to scan for messenger actions and events (note: may be specified multiple times)',\n      default: [] as string[],\n    })\n    .option('output', {\n      type: 'string',\n      description: 'Output directory',\n    })\n    .option('project-label', {\n      type: 'string',\n      description:\n        'Short label identifying the project (e.g. \"Core\", \"Extension\") — stamped on the site title and headings',\n    })\n    .option('site-url', {\n      type: 'string',\n      description:\n        'Absolute URL the built site will be served from, e.g. https://metamask.github.io',\n    })\n    .option('site-base-url', {\n      type: 'string',\n      description:\n        'Path prefix the built site will be served under, e.g. /core/platform-api/',\n    })\n    .help().argv;\n\n  const projectPathArg = argv['project-path'];\n  const resolvedProjectPath = path.resolve(\n    typeof projectPathArg === 'string' ? projectPathArg : '.',\n  );\n  const resolvedOutputDir = path.resolve(\n    argv.output ?? path.join(resolvedProjectPath, '.platform-api-docs'),\n  );\n  const scanDirs = ['src', ...argv['scan-dir']].filter(\n    (dir, index, dirs) => dirs.indexOf(dir) === index,\n  );\n  const projectLabel =\n    typeof argv['project-label'] === 'string' &&\n    argv['project-label'].length > 0\n      ? argv['project-label']\n      : null;\n  const commitSha = await resolveCommitSha(resolvedProjectPath);\n  const repoUrl = await resolveRepoUrl(resolvedProjectPath);\n\n  // Step 1: Generate docs\n  await generate({\n    projectPath: resolvedProjectPath,\n    outputDir: resolvedOutputDir,\n    scanDirs,\n    projectLabel,\n    commitSha,\n  });\n\n  // Step 2: If --build, --serve, or --dev, set up and run Docusaurus\n  if (argv.build || argv.serve || argv.dev) {\n    await setupSite(resolvedOutputDir);\n\n    // Translate CLI flags into the environment variables Docusaurus's\n    // config reads. Keeping the CLI surface flag-only means consumers\n    // (workflow files, package.json scripts) don't have to know how the\n    // values are plumbed through to Docusaurus.\n    const docusaurusEnv: Record<string, string> = {};\n    if (projectLabel) {\n      docusaurusEnv.DOCS_PROJECT_LABEL = projectLabel;\n    }\n    if (commitSha) {\n      docusaurusEnv.DOCS_COMMIT_SHA = commitSha;\n    }\n    if (repoUrl) {\n      docusaurusEnv.DOCS_REPO_URL = repoUrl;\n    }\n    if (typeof argv['site-url'] === 'string' && argv['site-url'].length > 0) {\n      docusaurusEnv.DOCS_URL = argv['site-url'];\n    }\n    if (\n      typeof argv['site-base-url'] === 'string' &&\n      argv['site-base-url'].length > 0\n    ) {\n      docusaurusEnv.DOCS_BASE_URL = argv['site-base-url'];\n    }\n\n    if (argv.dev) {\n      console.log('\\nStarting dev server...');\n      await runDocusaurus('start', resolvedOutputDir, docusaurusEnv);\n    } else if (argv.build || argv.serve) {\n      console.log('\\nBuilding static site...');\n      await runDocusaurus('build', resolvedOutputDir, docusaurusEnv);\n\n      if (argv.serve) {\n        console.log('\\nServing static site...');\n        await runDocusaurus('serve', resolvedOutputDir, docusaurusEnv);\n      }\n    }\n  }\n}\n\nmain().catch((error) => {\n  console.error(error);\n  process.exitCode = 1;\n});\n"]}
+{"version":3,"file":"cli.cjs","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,2DAA0B;AAC1B,qDAAuC;AACvC,gDAAkC;AAClC,0DAAiC;AACjC,kDAA0B;AAE1B,6CAAsD;AAEtD;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,OAAO,IAAA,mBAAQ,EAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,aAAa,CAC1B,OAAe,EACf,GAAW,EACX,WAAmC,EAAE;IAErC,MAAM,IAAA,eAAK,EAAC,iBAAiB,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE;QAC1C,GAAG;QACH,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE;KACrC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,SAAS,CAAC,MAAc;IACrC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACjD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC9C,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACjE,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhE,OAAO,CAAC,GAAG,CAAC,mCAAmC,MAAM,KAAK,CAAC,CAAC;IAE5D,uEAAuE;IACvE,uEAAuE;IACvE,uEAAuE;IACvE,mEAAmE;IACnE,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE;QAC3B,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KACrD,CAAC,CAAC;IAEH,sEAAsE;IACtE,4EAA4E;IAC5E,0EAA0E;IAC1E,2EAA2E;IAC3E,uEAAuE;IACvE,2DAA2D;IAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACnD,IAAI,CAAC;QACH,uEAAuE;QACvE,2DAA2D;QAC3D,MAAM,EAAE,CAAC,OAAO,CAAC,kBAAkB,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACvD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtD,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,EAAE,CAAC,SAAS,CAChB,WAAW,EACX,IAAI,CAAC,SAAS,CACZ,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,IAAI,EAAE,EACjD,IAAI,EACJ,CAAC,CACF,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAAC,WAAmB;IACjD,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,eAAK,EAAC,KAAK,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE;YACtE,GAAG,EAAE,WAAW;SACjB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,MAAM,IAAA,eAAK,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC5C,OAAO,CACN,mBAAmB,EACnB,0HAA0H,EAC1H,CAAC,aAAa,EAAE,EAAE;QAChB,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE;YACvC,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6BAA6B;YAC1C,OAAO,EAAE,GAAG;SACb,CAAC,CAAC;IACL,CAAC,CACF;SACA,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,KAAK,EAAE;QACb,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EACT,4HAA4H;QAC9H,OAAO,EAAE,EAAc;KACxB,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kBAAkB;KAChC,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,yGAAyG;KAC5G,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,kFAAkF;KACrF,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,2EAA2E;KAC9E,CAAC;SACD,IAAI,EAAE,CAAC,IAAI,CAAC;IAEf,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAC1D,CAAC;IACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CACpC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CACpE,CAAC;IACF,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAClD,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAClD,CAAC;IACF,MAAM,YAAY,GAChB,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,QAAQ;QACzC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC;QAC9B,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QACvB,CAAC,CAAC,IAAI,CAAC;IACX,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,MAAM,IAAA,yBAAc,EAAC,mBAAmB,CAAC,CAAC;IAE1D,wBAAwB;IACxB,MAAM,IAAA,mBAAQ,EAAC;QACb,WAAW,EAAE,mBAAmB;QAChC,SAAS,EAAE,iBAAiB;QAC5B,QAAQ;QACR,YAAY;QACZ,SAAS;KACV,CAAC,CAAC;IAEH,mEAAmE;IACnE,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,MAAM,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAEnC,kEAAkE;QAClE,kEAAkE;QAClE,oEAAoE;QACpE,4CAA4C;QAC5C,MAAM,aAAa,GAA2B,EAAE,CAAC;QACjD,IAAI,YAAY,EAAE,CAAC;YACjB,aAAa,CAAC,kBAAkB,GAAG,YAAY,CAAC;QAClD,CAAC;QACD,IAAI,SAAS,EAAE,CAAC;YACd,aAAa,CAAC,eAAe,GAAG,SAAS,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxE,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,CAAC;QACD,IACE,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,QAAQ;YACzC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAChC,CAAC;YACD,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;YACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACjE,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACpC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;YACzC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YAE/D,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;gBACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport execa from 'execa';\nimport * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport npmWhich from 'npm-which';\nimport yargs from 'yargs';\n\nimport { generate, resolveRepoUrl } from './generate';\n\n/**\n * Locate the Docusaurus binary in this package's `node_modules/.bin`. Using\n * `npm-which` lets the lookup track wherever the installed Docusaurus puts\n * its binary, so a future Docusaurus upgrade can't break this path.\n *\n * @returns Absolute path to the `docusaurus` executable.\n */\nfunction resolveDocusaurus(): string {\n  return npmWhich(__dirname).sync('docusaurus');\n}\n\n/**\n * Run a Docusaurus command.\n *\n * @param command - The docusaurus command (start, build, serve).\n * @param cwd - The site directory.\n * @param extraEnv - Extra environment variables passed through to the\n * Docusaurus process (e.g. `DOCS_PROJECT_LABEL`, `DOCS_COMMIT_SHA`,\n * `DOCS_REPO_URL`).\n */\nasync function runDocusaurus(\n  command: string,\n  cwd: string,\n  extraEnv: Record<string, string> = {},\n): Promise<void> {\n  await execa(resolveDocusaurus(), [command], {\n    cwd,\n    stdio: 'inherit',\n    env: { ...process.env, ...extraEnv },\n  });\n}\n\n/**\n * Copy site files into the output directory, skipping `node_modules`, `docs`,\n * and `tsconfig.json`. `docs` is owned by the doc generator and shouldn't be\n * carried over from the source `site/` directory. `tsconfig.json` extends the\n * monorepo's `tsconfig.base.json` via a relative path that only resolves from\n * the source location — it's there for IDE / lint inheritance, not for\n * Docusaurus, which uses `jiti` and doesn't consult the tsconfig at runtime.\n *\n * @param outDir - The output directory to set up.\n */\nasync function setupSite(outDir: string): Promise<void> {\n  const packageDir = path.resolve(__dirname, '..');\n  const siteDir = path.join(packageDir, 'site');\n  const packageNodeModules = path.join(packageDir, 'node_modules');\n  const skip = new Set(['node_modules', 'docs', 'tsconfig.json']);\n\n  console.log(`\\nSetting up Docusaurus site in ${outDir}...`);\n\n  // `fs.cp` has been available since Node 16.7 and only got the \"stable\"\n  // marker in 22.3 — it's functional throughout our supported Node range\n  // (`^18.18 || >=20`), even though the linter flags the older versions.\n  // eslint-disable-next-line n/no-unsupported-features/node-builtins\n  await fs.cp(siteDir, outDir, {\n    recursive: true,\n    filter: (source) => !skip.has(path.basename(source)),\n  });\n\n  // Symlink this package's `node_modules` into the output so the copied\n  // `docusaurus.config.ts` and the rest of Docusaurus's bundling pipeline can\n  // resolve their deps the same way they do in the source tree. Without it,\n  // Node's resolver walks up from the output and can't reach our nested deps\n  // when the package is installed as a regular dependency by an external\n  // consumer (e.g. `metamask-extension`, `metamask-mobile`).\n  const linkPath = path.join(outDir, 'node_modules');\n  try {\n    // `'junction'` works cross-platform (POSIX ignores it; Windows uses it\n    // without admin) — `'dir'` would require admin on Windows.\n    await fs.symlink(packageNodeModules, linkPath, 'junction');\n  } catch (error) {\n    if ((error as NodeJS.ErrnoException).code !== 'EEXIST') {\n      throw error;\n    }\n  }\n\n  // Write a minimal package.json so Docusaurus doesn't warn about a missing one\n  const pkgJsonPath = path.join(outDir, 'package.json');\n  try {\n    await fs.access(pkgJsonPath);\n  } catch {\n    await fs.writeFile(\n      pkgJsonPath,\n      JSON.stringify(\n        { name: 'platform-api-docs-site', private: true },\n        null,\n        2,\n      ),\n    );\n  }\n}\n\n/**\n * Resolve the short Git commit SHA the docs are being generated from.\n * Returns null when the project isn't a git repo or git isn't available.\n *\n * @param projectPath - The project root path.\n * @returns The short SHA, or null on failure.\n */\nasync function resolveCommitSha(projectPath: string): Promise<string | null> {\n  try {\n    const { stdout } = await execa('git', ['rev-parse', '--short', 'HEAD'], {\n      cwd: projectPath,\n    });\n    const trimmed = stdout.trim();\n    return trimmed.length > 0 ? trimmed : null;\n  } catch {\n    return null;\n  }\n}\n\n/**\n * Main CLI entry point.\n */\nasync function main(): Promise<void> {\n  const argv = await yargs(process.argv.slice(2))\n    .command(\n      '$0 [project-path]',\n      'Produces documentation for the platform API, the set of actions and events available in clients through the message bus.',\n      (yargsInstance) => {\n        yargsInstance.positional('project-path', {\n          type: 'string',\n          description: 'Path to the project to scan',\n          default: '.',\n        });\n      },\n    )\n    .option('build', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and build a production-ready site',\n      default: false,\n    })\n    .option('serve', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a production-ready site',\n      default: false,\n    })\n    .option('dev', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a development-only site',\n      default: false,\n    })\n    .option('scan-dir', {\n      type: 'string',\n      array: true,\n      description:\n        'Additional directories within the project to scan for messenger actions and events (note: may be specified multiple times)',\n      default: [] as string[],\n    })\n    .option('output', {\n      type: 'string',\n      description: 'Output directory',\n    })\n    .option('project-label', {\n      type: 'string',\n      description:\n        'Short label identifying the project (e.g. \"Core\", \"Extension\") — stamped on the site title and headings',\n    })\n    .option('site-url', {\n      type: 'string',\n      description:\n        'Absolute URL the built site will be served from, e.g. https://metamask.github.io',\n    })\n    .option('site-base-url', {\n      type: 'string',\n      description:\n        'Path prefix the built site will be served under, e.g. /core/platform-api/',\n    })\n    .help().argv;\n\n  const projectPathArg = argv['project-path'];\n  const resolvedProjectPath = path.resolve(\n    typeof projectPathArg === 'string' ? projectPathArg : '.',\n  );\n  const resolvedOutputDir = path.resolve(\n    argv.output ?? path.join(resolvedProjectPath, '.platform-api-docs'),\n  );\n  const scanDirs = ['src', ...argv['scan-dir']].filter(\n    (dir, index, dirs) => dirs.indexOf(dir) === index,\n  );\n  const projectLabel =\n    typeof argv['project-label'] === 'string' &&\n    argv['project-label'].length > 0\n      ? argv['project-label']\n      : null;\n  const commitSha = await resolveCommitSha(resolvedProjectPath);\n  const repoUrl = await resolveRepoUrl(resolvedProjectPath);\n\n  // Step 1: Generate docs\n  await generate({\n    projectPath: resolvedProjectPath,\n    outputDir: resolvedOutputDir,\n    scanDirs,\n    projectLabel,\n    commitSha,\n  });\n\n  // Step 2: If --build, --serve, or --dev, set up and run Docusaurus\n  if (argv.build || argv.serve || argv.dev) {\n    await setupSite(resolvedOutputDir);\n\n    // Translate CLI flags into the environment variables Docusaurus's\n    // config reads. Keeping the CLI surface flag-only means consumers\n    // (workflow files, package.json scripts) don't have to know how the\n    // values are plumbed through to Docusaurus.\n    const docusaurusEnv: Record<string, string> = {};\n    if (projectLabel) {\n      docusaurusEnv.DOCS_PROJECT_LABEL = projectLabel;\n    }\n    if (commitSha) {\n      docusaurusEnv.DOCS_COMMIT_SHA = commitSha;\n    }\n    if (repoUrl) {\n      docusaurusEnv.DOCS_REPO_URL = repoUrl;\n    }\n    if (typeof argv['site-url'] === 'string' && argv['site-url'].length > 0) {\n      docusaurusEnv.DOCS_URL = argv['site-url'];\n    }\n    if (\n      typeof argv['site-base-url'] === 'string' &&\n      argv['site-base-url'].length > 0\n    ) {\n      docusaurusEnv.DOCS_BASE_URL = argv['site-base-url'];\n    }\n\n    if (argv.dev) {\n      console.log('\\nStarting dev server...');\n      await runDocusaurus('start', resolvedOutputDir, docusaurusEnv);\n    } else if (argv.build || argv.serve) {\n      console.log('\\nBuilding static site...');\n      await runDocusaurus('build', resolvedOutputDir, docusaurusEnv);\n\n      if (argv.serve) {\n        console.log('\\nServing static site...');\n        await runDocusaurus('serve', resolvedOutputDir, docusaurusEnv);\n      }\n    }\n  }\n}\n\nmain().catch((error) => {\n  console.error(error);\n  process.exitCode = 1;\n});\n"]}

package/dist/cli.mjs

@@ -68,7 +68,9 @@ async function runDocusaurus(command, cwd, extraEnv = {}) {
  * @param outDir - The output directory to set up.
  */
 async function setupSite(outDir) {
-    const siteDir = path.resolve($__dirname(import.meta.url), '..', 'site');
+    const packageDir = path.resolve($__dirname(import.meta.url), '..');
+    const siteDir = path.join(packageDir, 'site');
+    const packageNodeModules = path.join(packageDir, 'node_modules');
     const skip = new Set(['node_modules', 'docs', 'tsconfig.json']);
     console.log(`\nSetting up Docusaurus site in ${outDir}...`);
     // `fs.cp` has been available since Node 16.7 and only got the "stable"
@@ -79,6 +81,23 @@ async function setupSite(outDir) {
         recursive: true,
         filter: (source) => !skip.has(path.basename(source)),
     });
+    // Symlink this package's `node_modules` into the output so the copied
+    // `docusaurus.config.ts` and the rest of Docusaurus's bundling pipeline can
+    // resolve their deps the same way they do in the source tree. Without it,
+    // Node's resolver walks up from the output and can't reach our nested deps
+    // when the package is installed as a regular dependency by an external
+    // consumer (e.g. `metamask-extension`, `metamask-mobile`).
+    const linkPath = path.join(outDir, 'node_modules');
+    try {
+        // `'junction'` works cross-platform (POSIX ignores it; Windows uses it
+        // without admin) — `'dir'` would require admin on Windows.
+        await fs.symlink(packageNodeModules, linkPath, 'junction');
+    }
+    catch (error) {
+        if (error.code !== 'EEXIST') {
+            throw error;
+        }
+    }
     // Write a minimal package.json so Docusaurus doesn't warn about a missing one
     const pkgJsonPath = path.join(outDir, 'package.json');
     try {

package/dist/cli.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"cli.mjs","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,MAAK,uBAAc;;AAC1B,OAAO,KAAK,EAAE,yBAAyB;AACvC,OAAO,KAAK,IAAI,kBAAkB;AAClC,OAAO,SAAQ,kBAAkB;;AACjC,OAAO,KAAK,cAAc;AAE1B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,uBAAmB;AAEtD;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,OAAO,QAAQ,6BAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,aAAa,CAC1B,OAAe,EACf,GAAW,EACX,WAAmC,EAAE;IAErC,MAAM,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE;QAC1C,GAAG;QACH,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE;KACrC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,SAAS,CAAC,MAAc;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,8BAAY,IAAI,EAAE,MAAM,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhE,OAAO,CAAC,GAAG,CAAC,mCAAmC,MAAM,KAAK,CAAC,CAAC;IAE5D,uEAAuE;IACvE,uEAAuE;IACvE,uEAAuE;IACvE,mEAAmE;IACnE,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE;QAC3B,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KACrD,CAAC,CAAC;IAEH,8EAA8E;IAC9E,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtD,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,EAAE,CAAC,SAAS,CAChB,WAAW,EACX,IAAI,CAAC,SAAS,CACZ,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,IAAI,EAAE,EACjD,IAAI,EACJ,CAAC,CACF,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAAC,WAAmB;IACjD,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE;YACtE,GAAG,EAAE,WAAW;SACjB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC5C,OAAO,CACN,mBAAmB,EACnB,0HAA0H,EAC1H,CAAC,aAAa,EAAE,EAAE;QAChB,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE;YACvC,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6BAA6B;YAC1C,OAAO,EAAE,GAAG;SACb,CAAC,CAAC;IACL,CAAC,CACF;SACA,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,KAAK,EAAE;QACb,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EACT,4HAA4H;QAC9H,OAAO,EAAE,EAAc;KACxB,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kBAAkB;KAChC,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,yGAAyG;KAC5G,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,kFAAkF;KACrF,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,2EAA2E;KAC9E,CAAC;SACD,IAAI,EAAE,CAAC,IAAI,CAAC;IAEf,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAC1D,CAAC;IACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CACpC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CACpE,CAAC;IACF,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAClD,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAClD,CAAC;IACF,MAAM,YAAY,GAChB,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,QAAQ;QACzC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC;QAC9B,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QACvB,CAAC,CAAC,IAAI,CAAC;IACX,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAE1D,wBAAwB;IACxB,MAAM,QAAQ,CAAC;QACb,WAAW,EAAE,mBAAmB;QAChC,SAAS,EAAE,iBAAiB;QAC5B,QAAQ;QACR,YAAY;QACZ,SAAS;KACV,CAAC,CAAC;IAEH,mEAAmE;IACnE,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,MAAM,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAEnC,kEAAkE;QAClE,kEAAkE;QAClE,oEAAoE;QACpE,4CAA4C;QAC5C,MAAM,aAAa,GAA2B,EAAE,CAAC;QACjD,IAAI,YAAY,EAAE,CAAC;YACjB,aAAa,CAAC,kBAAkB,GAAG,YAAY,CAAC;QAClD,CAAC;QACD,IAAI,SAAS,EAAE,CAAC;YACd,aAAa,CAAC,eAAe,GAAG,SAAS,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxE,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,CAAC;QACD,IACE,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,QAAQ;YACzC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAChC,CAAC;YACD,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;YACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACjE,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACpC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;YACzC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YAE/D,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;gBACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport execa from 'execa';\nimport * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport npmWhich from 'npm-which';\nimport yargs from 'yargs';\n\nimport { generate, resolveRepoUrl } from './generate';\n\n/**\n * Locate the Docusaurus binary in this package's `node_modules/.bin`. Using\n * `npm-which` lets the lookup track wherever the installed Docusaurus puts\n * its binary, so a future Docusaurus upgrade can't break this path.\n *\n * @returns Absolute path to the `docusaurus` executable.\n */\nfunction resolveDocusaurus(): string {\n  return npmWhich(__dirname).sync('docusaurus');\n}\n\n/**\n * Run a Docusaurus command.\n *\n * @param command - The docusaurus command (start, build, serve).\n * @param cwd - The site directory.\n * @param extraEnv - Extra environment variables passed through to the\n * Docusaurus process (e.g. `DOCS_PROJECT_LABEL`, `DOCS_COMMIT_SHA`,\n * `DOCS_REPO_URL`).\n */\nasync function runDocusaurus(\n  command: string,\n  cwd: string,\n  extraEnv: Record<string, string> = {},\n): Promise<void> {\n  await execa(resolveDocusaurus(), [command], {\n    cwd,\n    stdio: 'inherit',\n    env: { ...process.env, ...extraEnv },\n  });\n}\n\n/**\n * Copy site files into the output directory, skipping `node_modules`, `docs`,\n * and `tsconfig.json`. `docs` is owned by the doc generator and shouldn't be\n * carried over from the source `site/` directory. `tsconfig.json` extends the\n * monorepo's `tsconfig.base.json` via a relative path that only resolves from\n * the source location — it's there for IDE / lint inheritance, not for\n * Docusaurus, which uses `jiti` and doesn't consult the tsconfig at runtime.\n *\n * @param outDir - The output directory to set up.\n */\nasync function setupSite(outDir: string): Promise<void> {\n  const siteDir = path.resolve(__dirname, '..', 'site');\n  const skip = new Set(['node_modules', 'docs', 'tsconfig.json']);\n\n  console.log(`\\nSetting up Docusaurus site in ${outDir}...`);\n\n  // `fs.cp` has been available since Node 16.7 and only got the \"stable\"\n  // marker in 22.3 — it's functional throughout our supported Node range\n  // (`^18.18 || >=20`), even though the linter flags the older versions.\n  // eslint-disable-next-line n/no-unsupported-features/node-builtins\n  await fs.cp(siteDir, outDir, {\n    recursive: true,\n    filter: (source) => !skip.has(path.basename(source)),\n  });\n\n  // Write a minimal package.json so Docusaurus doesn't warn about a missing one\n  const pkgJsonPath = path.join(outDir, 'package.json');\n  try {\n    await fs.access(pkgJsonPath);\n  } catch {\n    await fs.writeFile(\n      pkgJsonPath,\n      JSON.stringify(\n        { name: 'platform-api-docs-site', private: true },\n        null,\n        2,\n      ),\n    );\n  }\n}\n\n/**\n * Resolve the short Git commit SHA the docs are being generated from.\n * Returns null when the project isn't a git repo or git isn't available.\n *\n * @param projectPath - The project root path.\n * @returns The short SHA, or null on failure.\n */\nasync function resolveCommitSha(projectPath: string): Promise<string | null> {\n  try {\n    const { stdout } = await execa('git', ['rev-parse', '--short', 'HEAD'], {\n      cwd: projectPath,\n    });\n    const trimmed = stdout.trim();\n    return trimmed.length > 0 ? trimmed : null;\n  } catch {\n    return null;\n  }\n}\n\n/**\n * Main CLI entry point.\n */\nasync function main(): Promise<void> {\n  const argv = await yargs(process.argv.slice(2))\n    .command(\n      '$0 [project-path]',\n      'Produces documentation for the platform API, the set of actions and events available in clients through the message bus.',\n      (yargsInstance) => {\n        yargsInstance.positional('project-path', {\n          type: 'string',\n          description: 'Path to the project to scan',\n          default: '.',\n        });\n      },\n    )\n    .option('build', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and build a production-ready site',\n      default: false,\n    })\n    .option('serve', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a production-ready site',\n      default: false,\n    })\n    .option('dev', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a development-only site',\n      default: false,\n    })\n    .option('scan-dir', {\n      type: 'string',\n      array: true,\n      description:\n        'Additional directories within the project to scan for messenger actions and events (note: may be specified multiple times)',\n      default: [] as string[],\n    })\n    .option('output', {\n      type: 'string',\n      description: 'Output directory',\n    })\n    .option('project-label', {\n      type: 'string',\n      description:\n        'Short label identifying the project (e.g. \"Core\", \"Extension\") — stamped on the site title and headings',\n    })\n    .option('site-url', {\n      type: 'string',\n      description:\n        'Absolute URL the built site will be served from, e.g. https://metamask.github.io',\n    })\n    .option('site-base-url', {\n      type: 'string',\n      description:\n        'Path prefix the built site will be served under, e.g. /core/platform-api/',\n    })\n    .help().argv;\n\n  const projectPathArg = argv['project-path'];\n  const resolvedProjectPath = path.resolve(\n    typeof projectPathArg === 'string' ? projectPathArg : '.',\n  );\n  const resolvedOutputDir = path.resolve(\n    argv.output ?? path.join(resolvedProjectPath, '.platform-api-docs'),\n  );\n  const scanDirs = ['src', ...argv['scan-dir']].filter(\n    (dir, index, dirs) => dirs.indexOf(dir) === index,\n  );\n  const projectLabel =\n    typeof argv['project-label'] === 'string' &&\n    argv['project-label'].length > 0\n      ? argv['project-label']\n      : null;\n  const commitSha = await resolveCommitSha(resolvedProjectPath);\n  const repoUrl = await resolveRepoUrl(resolvedProjectPath);\n\n  // Step 1: Generate docs\n  await generate({\n    projectPath: resolvedProjectPath,\n    outputDir: resolvedOutputDir,\n    scanDirs,\n    projectLabel,\n    commitSha,\n  });\n\n  // Step 2: If --build, --serve, or --dev, set up and run Docusaurus\n  if (argv.build || argv.serve || argv.dev) {\n    await setupSite(resolvedOutputDir);\n\n    // Translate CLI flags into the environment variables Docusaurus's\n    // config reads. Keeping the CLI surface flag-only means consumers\n    // (workflow files, package.json scripts) don't have to know how the\n    // values are plumbed through to Docusaurus.\n    const docusaurusEnv: Record<string, string> = {};\n    if (projectLabel) {\n      docusaurusEnv.DOCS_PROJECT_LABEL = projectLabel;\n    }\n    if (commitSha) {\n      docusaurusEnv.DOCS_COMMIT_SHA = commitSha;\n    }\n    if (repoUrl) {\n      docusaurusEnv.DOCS_REPO_URL = repoUrl;\n    }\n    if (typeof argv['site-url'] === 'string' && argv['site-url'].length > 0) {\n      docusaurusEnv.DOCS_URL = argv['site-url'];\n    }\n    if (\n      typeof argv['site-base-url'] === 'string' &&\n      argv['site-base-url'].length > 0\n    ) {\n      docusaurusEnv.DOCS_BASE_URL = argv['site-base-url'];\n    }\n\n    if (argv.dev) {\n      console.log('\\nStarting dev server...');\n      await runDocusaurus('start', resolvedOutputDir, docusaurusEnv);\n    } else if (argv.build || argv.serve) {\n      console.log('\\nBuilding static site...');\n      await runDocusaurus('build', resolvedOutputDir, docusaurusEnv);\n\n      if (argv.serve) {\n        console.log('\\nServing static site...');\n        await runDocusaurus('serve', resolvedOutputDir, docusaurusEnv);\n      }\n    }\n  }\n}\n\nmain().catch((error) => {\n  console.error(error);\n  process.exitCode = 1;\n});\n"]}
+{"version":3,"file":"cli.mjs","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,MAAK,uBAAc;;AAC1B,OAAO,KAAK,EAAE,yBAAyB;AACvC,OAAO,KAAK,IAAI,kBAAkB;AAClC,OAAO,SAAQ,kBAAkB;;AACjC,OAAO,KAAK,cAAc;AAE1B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,uBAAmB;AAEtD;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,OAAO,QAAQ,6BAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,aAAa,CAC1B,OAAe,EACf,GAAW,EACX,WAAmC,EAAE;IAErC,MAAM,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE;QAC1C,GAAG;QACH,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE;KACrC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,SAAS,CAAC,MAAc;IACrC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,8BAAY,IAAI,CAAC,CAAC;IACjD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC9C,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACjE,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhE,OAAO,CAAC,GAAG,CAAC,mCAAmC,MAAM,KAAK,CAAC,CAAC;IAE5D,uEAAuE;IACvE,uEAAuE;IACvE,uEAAuE;IACvE,mEAAmE;IACnE,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE;QAC3B,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KACrD,CAAC,CAAC;IAEH,sEAAsE;IACtE,4EAA4E;IAC5E,0EAA0E;IAC1E,2EAA2E;IAC3E,uEAAuE;IACvE,2DAA2D;IAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACnD,IAAI,CAAC;QACH,uEAAuE;QACvE,2DAA2D;QAC3D,MAAM,EAAE,CAAC,OAAO,CAAC,kBAAkB,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACvD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtD,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,EAAE,CAAC,SAAS,CAChB,WAAW,EACX,IAAI,CAAC,SAAS,CACZ,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,IAAI,EAAE,EACjD,IAAI,EACJ,CAAC,CACF,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAAC,WAAmB;IACjD,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE;YACtE,GAAG,EAAE,WAAW;SACjB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC5C,OAAO,CACN,mBAAmB,EACnB,0HAA0H,EAC1H,CAAC,aAAa,EAAE,EAAE;QAChB,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE;YACvC,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6BAA6B;YAC1C,OAAO,EAAE,GAAG;SACb,CAAC,CAAC;IACL,CAAC,CACF;SACA,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,KAAK,EAAE;QACb,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EACT,4HAA4H;QAC9H,OAAO,EAAE,EAAc;KACxB,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kBAAkB;KAChC,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,yGAAyG;KAC5G,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,kFAAkF;KACrF,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,2EAA2E;KAC9E,CAAC;SACD,IAAI,EAAE,CAAC,IAAI,CAAC;IAEf,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAC1D,CAAC;IACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CACpC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CACpE,CAAC;IACF,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAClD,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAClD,CAAC;IACF,MAAM,YAAY,GAChB,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,QAAQ;QACzC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC;QAC9B,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QACvB,CAAC,CAAC,IAAI,CAAC;IACX,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAE1D,wBAAwB;IACxB,MAAM,QAAQ,CAAC;QACb,WAAW,EAAE,mBAAmB;QAChC,SAAS,EAAE,iBAAiB;QAC5B,QAAQ;QACR,YAAY;QACZ,SAAS;KACV,CAAC,CAAC;IAEH,mEAAmE;IACnE,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,MAAM,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAEnC,kEAAkE;QAClE,kEAAkE;QAClE,oEAAoE;QACpE,4CAA4C;QAC5C,MAAM,aAAa,GAA2B,EAAE,CAAC;QACjD,IAAI,YAAY,EAAE,CAAC;YACjB,aAAa,CAAC,kBAAkB,GAAG,YAAY,CAAC;QAClD,CAAC;QACD,IAAI,SAAS,EAAE,CAAC;YACd,aAAa,CAAC,eAAe,GAAG,SAAS,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxE,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,CAAC;QACD,IACE,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,QAAQ;YACzC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAChC,CAAC;YACD,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;YACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACjE,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACpC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;YACzC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YAE/D,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;gBACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport execa from 'execa';\nimport * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport npmWhich from 'npm-which';\nimport yargs from 'yargs';\n\nimport { generate, resolveRepoUrl } from './generate';\n\n/**\n * Locate the Docusaurus binary in this package's `node_modules/.bin`. Using\n * `npm-which` lets the lookup track wherever the installed Docusaurus puts\n * its binary, so a future Docusaurus upgrade can't break this path.\n *\n * @returns Absolute path to the `docusaurus` executable.\n */\nfunction resolveDocusaurus(): string {\n  return npmWhich(__dirname).sync('docusaurus');\n}\n\n/**\n * Run a Docusaurus command.\n *\n * @param command - The docusaurus command (start, build, serve).\n * @param cwd - The site directory.\n * @param extraEnv - Extra environment variables passed through to the\n * Docusaurus process (e.g. `DOCS_PROJECT_LABEL`, `DOCS_COMMIT_SHA`,\n * `DOCS_REPO_URL`).\n */\nasync function runDocusaurus(\n  command: string,\n  cwd: string,\n  extraEnv: Record<string, string> = {},\n): Promise<void> {\n  await execa(resolveDocusaurus(), [command], {\n    cwd,\n    stdio: 'inherit',\n    env: { ...process.env, ...extraEnv },\n  });\n}\n\n/**\n * Copy site files into the output directory, skipping `node_modules`, `docs`,\n * and `tsconfig.json`. `docs` is owned by the doc generator and shouldn't be\n * carried over from the source `site/` directory. `tsconfig.json` extends the\n * monorepo's `tsconfig.base.json` via a relative path that only resolves from\n * the source location — it's there for IDE / lint inheritance, not for\n * Docusaurus, which uses `jiti` and doesn't consult the tsconfig at runtime.\n *\n * @param outDir - The output directory to set up.\n */\nasync function setupSite(outDir: string): Promise<void> {\n  const packageDir = path.resolve(__dirname, '..');\n  const siteDir = path.join(packageDir, 'site');\n  const packageNodeModules = path.join(packageDir, 'node_modules');\n  const skip = new Set(['node_modules', 'docs', 'tsconfig.json']);\n\n  console.log(`\\nSetting up Docusaurus site in ${outDir}...`);\n\n  // `fs.cp` has been available since Node 16.7 and only got the \"stable\"\n  // marker in 22.3 — it's functional throughout our supported Node range\n  // (`^18.18 || >=20`), even though the linter flags the older versions.\n  // eslint-disable-next-line n/no-unsupported-features/node-builtins\n  await fs.cp(siteDir, outDir, {\n    recursive: true,\n    filter: (source) => !skip.has(path.basename(source)),\n  });\n\n  // Symlink this package's `node_modules` into the output so the copied\n  // `docusaurus.config.ts` and the rest of Docusaurus's bundling pipeline can\n  // resolve their deps the same way they do in the source tree. Without it,\n  // Node's resolver walks up from the output and can't reach our nested deps\n  // when the package is installed as a regular dependency by an external\n  // consumer (e.g. `metamask-extension`, `metamask-mobile`).\n  const linkPath = path.join(outDir, 'node_modules');\n  try {\n    // `'junction'` works cross-platform (POSIX ignores it; Windows uses it\n    // without admin) — `'dir'` would require admin on Windows.\n    await fs.symlink(packageNodeModules, linkPath, 'junction');\n  } catch (error) {\n    if ((error as NodeJS.ErrnoException).code !== 'EEXIST') {\n      throw error;\n    }\n  }\n\n  // Write a minimal package.json so Docusaurus doesn't warn about a missing one\n  const pkgJsonPath = path.join(outDir, 'package.json');\n  try {\n    await fs.access(pkgJsonPath);\n  } catch {\n    await fs.writeFile(\n      pkgJsonPath,\n      JSON.stringify(\n        { name: 'platform-api-docs-site', private: true },\n        null,\n        2,\n      ),\n    );\n  }\n}\n\n/**\n * Resolve the short Git commit SHA the docs are being generated from.\n * Returns null when the project isn't a git repo or git isn't available.\n *\n * @param projectPath - The project root path.\n * @returns The short SHA, or null on failure.\n */\nasync function resolveCommitSha(projectPath: string): Promise<string | null> {\n  try {\n    const { stdout } = await execa('git', ['rev-parse', '--short', 'HEAD'], {\n      cwd: projectPath,\n    });\n    const trimmed = stdout.trim();\n    return trimmed.length > 0 ? trimmed : null;\n  } catch {\n    return null;\n  }\n}\n\n/**\n * Main CLI entry point.\n */\nasync function main(): Promise<void> {\n  const argv = await yargs(process.argv.slice(2))\n    .command(\n      '$0 [project-path]',\n      'Produces documentation for the platform API, the set of actions and events available in clients through the message bus.',\n      (yargsInstance) => {\n        yargsInstance.positional('project-path', {\n          type: 'string',\n          description: 'Path to the project to scan',\n          default: '.',\n        });\n      },\n    )\n    .option('build', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and build a production-ready site',\n      default: false,\n    })\n    .option('serve', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a production-ready site',\n      default: false,\n    })\n    .option('dev', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a development-only site',\n      default: false,\n    })\n    .option('scan-dir', {\n      type: 'string',\n      array: true,\n      description:\n        'Additional directories within the project to scan for messenger actions and events (note: may be specified multiple times)',\n      default: [] as string[],\n    })\n    .option('output', {\n      type: 'string',\n      description: 'Output directory',\n    })\n    .option('project-label', {\n      type: 'string',\n      description:\n        'Short label identifying the project (e.g. \"Core\", \"Extension\") — stamped on the site title and headings',\n    })\n    .option('site-url', {\n      type: 'string',\n      description:\n        'Absolute URL the built site will be served from, e.g. https://metamask.github.io',\n    })\n    .option('site-base-url', {\n      type: 'string',\n      description:\n        'Path prefix the built site will be served under, e.g. /core/platform-api/',\n    })\n    .help().argv;\n\n  const projectPathArg = argv['project-path'];\n  const resolvedProjectPath = path.resolve(\n    typeof projectPathArg === 'string' ? projectPathArg : '.',\n  );\n  const resolvedOutputDir = path.resolve(\n    argv.output ?? path.join(resolvedProjectPath, '.platform-api-docs'),\n  );\n  const scanDirs = ['src', ...argv['scan-dir']].filter(\n    (dir, index, dirs) => dirs.indexOf(dir) === index,\n  );\n  const projectLabel =\n    typeof argv['project-label'] === 'string' &&\n    argv['project-label'].length > 0\n      ? argv['project-label']\n      : null;\n  const commitSha = await resolveCommitSha(resolvedProjectPath);\n  const repoUrl = await resolveRepoUrl(resolvedProjectPath);\n\n  // Step 1: Generate docs\n  await generate({\n    projectPath: resolvedProjectPath,\n    outputDir: resolvedOutputDir,\n    scanDirs,\n    projectLabel,\n    commitSha,\n  });\n\n  // Step 2: If --build, --serve, or --dev, set up and run Docusaurus\n  if (argv.build || argv.serve || argv.dev) {\n    await setupSite(resolvedOutputDir);\n\n    // Translate CLI flags into the environment variables Docusaurus's\n    // config reads. Keeping the CLI surface flag-only means consumers\n    // (workflow files, package.json scripts) don't have to know how the\n    // values are plumbed through to Docusaurus.\n    const docusaurusEnv: Record<string, string> = {};\n    if (projectLabel) {\n      docusaurusEnv.DOCS_PROJECT_LABEL = projectLabel;\n    }\n    if (commitSha) {\n      docusaurusEnv.DOCS_COMMIT_SHA = commitSha;\n    }\n    if (repoUrl) {\n      docusaurusEnv.DOCS_REPO_URL = repoUrl;\n    }\n    if (typeof argv['site-url'] === 'string' && argv['site-url'].length > 0) {\n      docusaurusEnv.DOCS_URL = argv['site-url'];\n    }\n    if (\n      typeof argv['site-base-url'] === 'string' &&\n      argv['site-base-url'].length > 0\n    ) {\n      docusaurusEnv.DOCS_BASE_URL = argv['site-base-url'];\n    }\n\n    if (argv.dev) {\n      console.log('\\nStarting dev server...');\n      await runDocusaurus('start', resolvedOutputDir, docusaurusEnv);\n    } else if (argv.build || argv.serve) {\n      console.log('\\nBuilding static site...');\n      await runDocusaurus('build', resolvedOutputDir, docusaurusEnv);\n\n      if (argv.serve) {\n        console.log('\\nServing static site...');\n        await runDocusaurus('serve', resolvedOutputDir, docusaurusEnv);\n      }\n    }\n  }\n}\n\nmain().catch((error) => {\n  console.error(error);\n  process.exitCode = 1;\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/platform-api-docs",
-  "version": "0.0.0-preview-a3545aef8",
+  "version": "0.0.0-preview-1bd5239bf",
   "description": "Produces documentation for the platform API, the set of actions and events available in the clients through the message bus",
   "keywords": [
     "Ethereum",
@@ -45,13 +45,13 @@
     "@docusaurus/types": "^3.10.1",
     "@easyops-cn/docusaurus-search-local": "^0.55.1",
     "@mdx-js/react": "^3.1.1",
-    "@metamask/utils": "^11.9.0",
+    "@metamask/utils": "^11.11.0",
     "execa": "^5.0.0",
     "glob": "^13.0.6",
     "npm-which": "^3.0.1",
     "prism-react-renderer": "^2.4.1",
-    "react": "^19.2.6",
-    "react-dom": "^19.2.6",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
     "ts-morph": "^28.0.0",
     "yargs": "^17.7.2"
   },
@@ -61,7 +61,7 @@
     "@types/jest": "^29.5.14",
     "@types/node": "^16.18.54",
     "@types/npm-which": "^3",
-    "@types/react": "^19.2.14",
+    "@types/react": "^19.0.0",
     "@types/yargs": "^17.0.32",
     "deepmerge": "^4.2.2",
     "jest": "^29.7.0",