|
2 | 2 |
|
3 | 3 | Generate and serve Messenger API documentation for MetaMask controller packages. |
4 | 4 |
|
| 5 | +Scans TypeScript source files and declaration files for messenger action/event types, then generates a searchable Docusaurus site with per-namespace documentation. |
| 6 | + |
5 | 7 | ## Installation |
6 | 8 |
|
7 | 9 | `yarn add @metamask/messenger-docs` |
|
12 | 14 |
|
13 | 15 | ## Usage |
14 | 16 |
|
| 17 | +### Core monorepo |
| 18 | + |
| 19 | +The package includes workspace scripts for development: |
| 20 | + |
15 | 21 | ```bash |
16 | | -# Default: scans cwd for node_modules/@metamask controller/service packages |
17 | | -npx @metamask/messenger-docs |
| 22 | +# Generate docs from all packages |
| 23 | +yarn workspace @metamask/messenger-docs docs:generate |
18 | 24 |
|
19 | | -# Scan a specific project |
20 | | -npx @metamask/messenger-docs /path/to/project |
| 25 | +# Generate + start dev server with hot reload |
| 26 | +yarn workspace @metamask/messenger-docs docs:dev |
21 | 27 |
|
22 | 28 | # Generate + build static site |
23 | | -npx @metamask/messenger-docs --build |
| 29 | +yarn workspace @metamask/messenger-docs docs:build |
| 30 | + |
| 31 | +# Generate + build + serve |
| 32 | +yarn workspace @metamask/messenger-docs docs:serve |
| 33 | +``` |
| 34 | + |
| 35 | +### Client projects (Extension, Mobile) |
| 36 | + |
| 37 | +Add `@metamask/messenger-docs` as a dev dependency, then add a script to your `package.json`: |
| 38 | + |
| 39 | +```json |
| 40 | +{ |
| 41 | + "scripts": { |
| 42 | + "docs:messenger": "messenger-docs --serve" |
| 43 | + } |
| 44 | +} |
| 45 | +``` |
24 | 46 |
|
25 | | -# Generate + serve (build + http server) |
26 | | -npx @metamask/messenger-docs --serve |
| 47 | +By default, the tool scans `src/` for `.ts` files and `node_modules/@metamask/` for `.d.cts` declaration files. If your project has source files in other directories, configure `scanDirs` in `package.json`: |
27 | 48 |
|
28 | | -# Generate + dev server (hot reload) |
29 | | -npx @metamask/messenger-docs --dev |
| 49 | +```json |
| 50 | +{ |
| 51 | + "messenger-docs": { |
| 52 | + "scanDirs": ["app", "src"] |
| 53 | + } |
| 54 | +} |
| 55 | +``` |
| 56 | + |
| 57 | +Or pass `--scan-dir` flags: |
| 58 | + |
| 59 | +```bash |
| 60 | +messenger-docs --scan-dir app --scan-dir shared --serve |
| 61 | +``` |
| 62 | + |
| 63 | +### CLI options |
| 64 | + |
| 65 | +``` |
| 66 | +messenger-docs [project-path] [options] |
30 | 67 |
|
31 | | -# Scan source .ts files instead of .d.cts (for monorepo development) |
32 | | -npx @metamask/messenger-docs --source |
| 68 | +Arguments: |
| 69 | + project-path Path to the project to scan (default: current directory) |
33 | 70 |
|
34 | | -# Custom output directory (default: .messenger-docs) |
35 | | -npx @metamask/messenger-docs --output ./my-docs |
| 71 | +Options: |
| 72 | + --build Generate docs and build static site |
| 73 | + --serve Generate docs, build, and serve static site |
| 74 | + --dev Generate docs and start dev server with hot reload |
| 75 | + --scan-dir <dir> Extra source directory to scan (repeatable) |
| 76 | + --output <dir> Output directory (default: <project-path>/.messenger-docs) |
| 77 | + --help Show this help message |
36 | 78 | ``` |
37 | 79 |
|
38 | 80 | ## Contributing |
|
0 commit comments