feat(monorepo): basic monorepo

Author: avivkeller

.c8rc.json

@@ -1,10 +1,9 @@
 {
   "all": true,
   "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"
   ]
 }

.claude/settings.local.json

@@ -0,0 +1,5 @@
+{
+  "permissions": {
+    "allow": ["Bash(git add:*)", "Bash(git rm:*)", "Bash(git checkout:*)"]
+  }
+}

.github/workflows/ci.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main]
 
 permissions:
   contents: read

.github/workflows/codespell.yml

@@ -18,4 +18,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

@@ -4,7 +4,6 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main]
   workflow_dispatch:
 
 concurrency:
@@ -146,7 +145,7 @@ jobs:
 
       - name: Generate ${{ matrix.target }}
         run: |
-          node bin/cli.mjs generate \
+          node packages/core/bin/cli.mjs generate \
             -t ${{ matrix.target }} \
             -i "${{ matrix.input }}" \
             -o out \

.github/workflows/publish.yml

@@ -5,25 +5,33 @@ name: Publish Packages
 on:
   push:
     paths:
-      - package.json
+      - 'packages/*/package.json'
     # For security reasons, this should never be set to anything but `main`
     branches: [main]
   workflow_dispatch:
+    inputs:
+      package:
+        description: 'Specific package to publish (leave empty for all packages)'
+        required: false
+        type: string
 
 permissions:
   contents: read
-  # For npm OIDC (https://docs.npmjs.com/trusted-publishers)
-  id-token: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
 
 env:
   COMMIT_SHA: ${{ github.sha }}
 
 jobs:
-  prepare:
+  prepare-packages:
+    name: Prepare Packages
     runs-on: ubuntu-latest
     outputs:
       # Output the matrix of packages to publish for use in the publish job
-      should_publish: ${{ steps.check.outputs.should_publish }}
+      matrix: ${{ steps.generate-matrix.outputs.matrix }}
     steps:
       - name: Harden Runner
         uses: step-security/harden-runner@fa2e9d605c4eeb9fcad4c99c224cee0c6c7f3594 # v2.16.0
@@ -33,7 +41,6 @@ jobs:
       - name: Verify commit authenticity
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        if: ${{ github.event_name != 'workflow_dispatch' }}
         run: |
           # Get commit data from GitHub API to verify its authenticity
           COMMIT_DATA=$(gh api repos/${{ github.repository }}/commits/$COMMIT_SHA)
@@ -59,39 +66,78 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 2 # Need at least 2 commits to detect changes between commits
+          persist-credentials: false
 
-      - name: Check if we should publish
-        id: check
+      - name: Generate package matrix
+        id: generate-matrix
         env:
+          PACKAGE: ${{ github.event.inputs.package }}
           EVENT_NAME: ${{ github.event_name }}
         run: |
-          OLD_VERSION=$(git show $COMMIT_SHA~1:package.json | jq -r '.version')
-          NEW_VERSION=$(jq -r '.version' "package.json")
-          if [ "$OLD_VERSION" != "$NEW_VERSION" ] || [ "$EVENT_NAME" == "workflow_dispatch" ]; then
-            echo "should_publish=true" >> $GITHUB_OUTPUT
+          if [ -n "$PACKAGE" ]; then
+            # If a specific package is requested via workflow_dispatch, just publish that one
+            echo "matrix={\"package\":[\"$PACKAGE\"]}" >> $GITHUB_OUTPUT
+          else
+            CHANGED_PACKAGES=()
+            for pkg in $(ls -d packages/*); do
+              PKG_NAME=$(basename "$pkg")
+              PKG_JSON="$pkg/package.json"
+
+              # Determine if the package has changed (or include all on manual trigger)
+              if [ "$EVENT_NAME" == "workflow_dispatch" ] || ! git diff --quiet $COMMIT_SHA~1 $COMMIT_SHA -- "$pkg/"; then
+                OLD_VERSION=$(git show $COMMIT_SHA~1:$PKG_JSON | jq -r '.version')
+                NEW_VERSION=$(jq -r '.version' "$PKG_JSON")
+                if [ "$OLD_VERSION" != "$NEW_VERSION" ]; then
+                  CHANGED_PACKAGES+=("$PKG_NAME")
+                fi
+              fi
+            done
+
+            # Format the output for GitHub Actions matrix using jq
+            PACKAGES_JSON=$(jq -n '$ARGS.positional' --args "${CHANGED_PACKAGES[@]}" -c)
+            echo "matrix={\"package\":$PACKAGES_JSON}" >> $GITHUB_OUTPUT
           fi
 
   publish:
-    needs: prepare
+    name: Publish
+    needs: prepare-packages
     runs-on: ubuntu-latest
-    if: needs.prepare.outputs.should_publish == 'true'
+    permissions:
+      # Required for npm OIDC publishing (https://docs.npmjs.com/trusted-publishers)
+      id-token: write
+    # Skip if no packages need to be published
+    if: fromJson(needs.prepare-packages.outputs.matrix).package[0] != null
+    # Use the dynamic matrix from prepare-packages job to create parallel jobs for each package
+    strategy:
+      matrix: ${{ fromJson(needs.prepare-packages.outputs.matrix) }}
+      fail-fast: false # Continue publishing other packages even if one fails
     steps:
       - uses: nodejs/web-team/actions/setup-environment@9f3c83af227d721768d9dbb63009a47ed4f4282f
         with:
+          pnpm: false
           use-version-file: true
           registry-url: 'https://registry.npmjs.org'
 
       - name: Publish
-        run: npm publish --access public --no-git-checks
+        working-directory: packages/${{ matrix.package }}
+        run: |
+          # Check if a custom publish script exists in package.json
+          if jq -e '.scripts.release' package.json > /dev/null; then
+            npm run release
+          fi
+
+          # Then publish the package to npm
+          npm publish --access public --no-git-checks
 
-      - name: Notify
+      - name: Notify on Manual Release
+        if: ${{ github.event_name == 'workflow_dispatch' }}
         uses: rtCamp/action-slack-notify@e31e87e03dd19038e411e38ae27cbad084a90661 # 2.3.3
         env:
           SLACK_COLOR: '#43853D'
           SLACK_ICON: https://github.com/nodejs.png?size=48
-          SLACK_TITLE: ':rocket: Package Published: @node-core/doc-kit'
+          SLACK_TITLE: ':rocket: Package Published: ${{ matrix.package }}'
           SLACK_MESSAGE: |
-            :package: *Package*: `@node-core/doc-kit` (<https://www.npmjs.com/package/@node-core/doc-kit|View on npm>)
+            :package: *Package*: `${{ matrix.package }}` (<https://www.npmjs.com/package/@node-core/${{ matrix.package }}|View on npm>)
             :bust_in_silhouette: *Published by*: ${{ github.triggering_actor }}
             :octocat: *Commit*: <https://github.com/${{ github.repository }}/commit/${{ env.COMMIT_SHA }}|${{ env.COMMIT_SHA }}>
           SLACK_USERNAME: nodejs-bot

.prettierignore

@@ -1,14 +1,14 @@
 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/
 
 # Generated Files
-src/generators/metadata/maps/mdn.json
+packages/core/src/generators/metadata/maps/mdn.json

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}'],
@@ -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: {