chore(monorepo): move everything into packages/core

Author: avivkeller

.c8rc.json

@@ -3,8 +3,8 @@
   "exclude": [
     "eslint.config.mjs",
     "**/fixtures",
-    "src/generators/legacy-html/assets",
-    "src/generators/web/ui",
+    "packages/core/src/generators/legacy-html/assets",
+    "packages/core/src/generators/web/ui",
     "**/*.d.ts"
   ]
 }

.changeset/monorepo-layout.md

@@ -0,0 +1,5 @@
+---
+'@node-core/doc-kit': patch
+---
+
+Moved the package into a `packages/core` workspace.

.github/workflows/codespell.yml

@@ -23,4 +23,4 @@ jobs:
         with:
           ignore_words_list: crate,raison
           exclude_file: .gitignore
-          skip: package-lock.json, ./src/generators/mandoc/template.1
+          skip: package-lock.json, ./packages/core/src/generators/mandoc/template.1

.github/workflows/generate.yml

@@ -149,7 +149,7 @@ jobs:
           /usr/bin/time \
             --output out/benchmark.json \
             --format '{"elapsedSeconds": %e, "userCpuSeconds": %U, "systemCpuSeconds": %S, "maxRssKiB": %M}' \
-            node bin/cli.mjs generate \
+            node packages/core/bin/cli.mjs generate \
             -t ${{ matrix.target }} \
             -i "${{ matrix.input }}" \
             -o out \

.prettierignore

@@ -1,11 +1,11 @@
 npm-shrinkwrap.json
 
 # Tests files
-src/generators/api-links/__tests__/fixtures/
+packages/core/src/generators/api-links/__tests__/fixtures/
 *.snapshot
 
 # Templates
-src/generators/web/template.html
+packages/core/src/generators/web/template.html
 
 # Output
 out/
@@ -14,7 +14,7 @@ out/
 www/content/
 
 # Generated Files
-src/generators/metadata/maps/mdn.json
+packages/core/src/generators/metadata/maps/mdn.json
 
 # The specification uses things that prettier would not
 # approve of, such as bullets with `*`

CONTRIBUTING.md

@@ -71,6 +71,18 @@ The steps below will give you a general idea of how to prepare your local enviro
    npm install
    ```
 
+### Repository Layout
+
+This repository is an npm workspaces monorepo. The root package is private and
+holds the shared tooling (linting, formatting, tests, changesets); every
+published package lives under `packages/`:
+
+- `packages/core`: [`@node-core/doc-kit`](packages/core)
+
+Everything else at the root supports the repo rather than shipping to npm:
+`docs/` (the reference docs), `www/` (the documentation site), `scripts/` (build
+and comparison helpers), and `e2e/` (Playwright tests).
+
 ### Running the Tool Locally
 
 `doc-kit` generates documentation from the Markdown API docs in the [Node.js repository](https://github.com/nodejs/node). To run the tool locally, you need a copy of those source files.
@@ -91,7 +103,7 @@ The steps below will give you a general idea of how to prepare your local enviro
    For fast iteration during development, target a single Markdown file instead of all API docs:
 
    ```bash
-   node bin/cli.mjs generate \
+   node packages/core/bin/cli.mjs generate \
      -t legacy-html \
      -i ../node/doc/api/fs.md \
      -o out \
@@ -112,7 +124,7 @@ The steps below will give you a general idea of how to prepare your local enviro
    Add `--log-level debug` before the `generate` subcommand to see the full pipeline trace:
 
    ```bash
-   node bin/cli.mjs --log-level debug generate -t legacy-html -i ../node/doc/api/fs.md -o out
+   node packages/core/bin/cli.mjs --log-level debug generate -t legacy-html -i ../node/doc/api/fs.md -o out
    ```
 
 > [!TIP]
@@ -216,7 +228,8 @@ Testing is a crucial part of maintaining code quality and ensuring reliability.
 
 ### Test File Organization
 
-Tests should be organized to mirror the source code structure:
+Tests should be organized to mirror the source code structure. The paths below
+are relative to the package the source file lives in (e.g. `packages/core`):
 
 - For a source file at `/src/index.mjs`, create a test file at `/src/__tests__/index.test.mjs`
 - For a source file at `/src/utils/parser.mjs`, create a test file at `/src/utils/__tests__/parser.test.mjs`
@@ -306,7 +319,7 @@ node --run test
 node --run test:coverage
 
 # Run specific test file
-node --test src/test/index.test.mjs
+node --test packages/core/src/utils/__tests__/parser.test.mjs
 ```
 
 ## Code Quality

README.md

@@ -36,7 +36,7 @@ $ npx doc-kit --help
 ```
 
 ```sh
-$ node bin/cli.mjs --help
+$ node packages/core/bin/cli.mjs --help
 ```
 
 ```

docs/commands.md

@@ -24,10 +24,10 @@ Each command consists of:
 
 ### Step 1: Create the Command File
 
-Create a new file in `bin/commands/` with your command name:
+Create a new file in `packages/core/bin/commands/` with your command name:
 
 ```javascript
-// bin/commands/my-command.mjs
+// packages/core/bin/commands/my-command.mjs
 import logger from '../../src/logger/index.mjs';
 
 /**
@@ -53,7 +53,7 @@ export default {
 
 ### Step 2: Register the Command
 
-Add your command to the exports in `bin/commands/index.mjs`:
+Add your command to the exports in `packages/core/bin/commands/index.mjs`:
 
 ```javascript
 import generate from './generate.mjs';
@@ -67,7 +67,7 @@ export default [
 
 ### Step 3: Update CLI Entry Point
 
-The CLI in `bin/cli.mjs` automatically loads commands from `bin/commands/index.mjs`, so no changes are needed there if you followed step 2.
+The CLI in `packages/core/bin/cli.mjs` automatically loads commands from `packages/core/bin/commands/index.mjs`, so no changes are needed there if you followed step 2.
 
 ## Command Options
 

docs/generators.md

@@ -34,10 +34,10 @@ A generator is defined as a module exporting an object conforming to the `Genera
 
 ### Step 1: Create the Generator Files
 
-Create a new directory in `src/generators/`:
+Create a new directory in `packages/core/src/generators/`:
 
 ```
-src/generators/my-format/
+packages/core/src/generators/my-format/
 ├── index.mjs         # Generator metadata (required)
 ├── generate.mjs      # Generator implementation (required)
 ├── constants.mjs     # Constants (optional)
@@ -72,7 +72,7 @@ export type Generator = GeneratorMetadata<
 Create the generator metadata in `index.mjs` using `createLazyGenerator`:
 
 ```javascript
-// src/generators/my-format/index.mjs
+// packages/core/src/generators/my-format/index.mjs
 import { createLazyGenerator } from '../../utils/generators.mjs';
 
 /**
@@ -104,7 +104,7 @@ export default createLazyGenerator({
 Create the generator implementation in `generate.mjs`:
 
 ```javascript
-// src/generators/my-format/generate.mjs
+// packages/core/src/generators/my-format/generate.mjs
 import { writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 
@@ -149,7 +149,7 @@ function transformToMyFormat(entries, version) {
 
 ### Step 5: Register the Generator
 
-Add your generator to the exports in `src/generators/index.mjs`:
+Add your generator to the exports in `packages/core/src/generators/index.mjs`:
 
 ```javascript
 // For public generators (available via CLI)
@@ -178,7 +178,7 @@ For generators processing large datasets, implement parallel processing using wo
 First, define the generator metadata in `index.mjs`:
 
 ```javascript
-// src/generators/parallel-generator/index.mjs
+// packages/core/src/generators/parallel-generator/index.mjs
 import { createLazyGenerator } from '../../utils/generators.mjs';
 
 /**
@@ -199,7 +199,7 @@ export default createLazyGenerator({
 Then, implement both `processChunk` and `generate` in `generate.mjs`:
 
 ```javascript
-// src/generators/parallel-generator/generate.mjs
+// packages/core/src/generators/parallel-generator/generate.mjs
 import getConfig from '../../utils/configuration/index.mjs';
 
 /**
@@ -272,7 +272,7 @@ Generators can yield results as they're produced using async generators.
 Define the generator metadata in `index.mjs`:
 
 ```javascript
-// src/generators/streaming-generator/index.mjs
+// packages/core/src/generators/streaming-generator/index.mjs
 import { createLazyGenerator } from '../../utils/generators.mjs';
 
 /**
@@ -292,7 +292,7 @@ export default createLazyGenerator({
 Implement the generator in `generate.mjs`:
 
 ```javascript
-// src/generators/streaming-generator/generate.mjs
+// packages/core/src/generators/streaming-generator/generate.mjs
 /**
  * Process a chunk of data
  *
@@ -330,7 +330,7 @@ Some generators must collect all input before processing.
 Generator metadata in `index.mjs`:
 
 ```javascript
-// src/generators/batch-generator/index.mjs
+// packages/core/src/generators/batch-generator/index.mjs
 import { createLazyGenerator } from '../../utils/generators.mjs';
 
 /**
@@ -348,7 +348,7 @@ export default createLazyGenerator({
 Implementation in `generate.mjs`:
 
 ```javascript
-// src/generators/batch-generator/generate.mjs
+// packages/core/src/generators/batch-generator/generate.mjs
 /**
  * Non-streaming - returns Promise instead of AsyncGenerator
  *
@@ -401,23 +401,23 @@ export async function generate(input, worker) {
 
 ```javascript
 // Step 1: Parse markdown to AST
-// src/generators/ast/index.mjs
+// packages/core/src/generators/ast/index.mjs
 export default createLazyGenerator({
   name: 'ast',
   dependsOn: undefined,  // No dependency
   // Processes raw markdown files
 });
 
 // Step 2: Extract metadata from AST
-// src/generators/metadata/index.mjs
+// packages/core/src/generators/metadata/index.mjs
 export default createLazyGenerator({
   name: 'metadata',
   dependsOn: 'ast',  // Depends on AST
   // Processes AST output
 });
 
 // Step 3: Generate HTML from metadata
-// src/generators/html-generator/index.mjs
+// packages/core/src/generators/html-generator/index.mjs
 export default createLazyGenerator({
   name: 'html-generator',
   dependsOn: 'metadata',  // Depends on metadata

eslint.config.mjs

@@ -10,7 +10,10 @@ export default defineConfig([
   importX.flatConfigs.recommended,
   react.configs.recommended,
   {
-    ignores: ['out/', 'src/generators/api-links/__tests__/fixtures/'],
+    ignores: [
+      'out/',
+      'packages/core/src/generators/api-links/__tests__/fixtures/',
+    ],
   },
   {
     files: ['**/*.{mjs,jsx,js}'],
@@ -54,7 +57,7 @@ export default defineConfig([
     },
   },
   {
-    files: ['src/**/*.mjs', 'bin/**/*.mjs'],
+    files: ['packages/*/src/**/*.mjs', 'packages/*/bin/**/*.mjs'],
     plugins: {
       jsdoc,
     },
@@ -91,8 +94,8 @@ export default defineConfig([
   },
   {
     files: [
-      'src/generators/legacy-html/assets/*.js',
-      'src/generators/web/ui/**/*',
+      'packages/core/src/generators/legacy-html/assets/*.js',
+      'packages/core/src/generators/web/ui/**/*',
     ],
     languageOptions: {
       globals: {