Testing major version changes

.depcheckrc.yml

@@ -8,7 +8,11 @@ ignores:
   - verdaccio-memory
   # ok with using implicit dev dep for now (part of verdaccio)
   - '@verdaccio/config'
-
-ignore-patterns:
-  # managed separately
-  - docs
+  # needed for type references from verdaccio (not listed in deps)
+  - '@verdaccio/types'
+  # not detected under .vuepress? or implicit peers?
+  - '@vuepress/*'
+  - mermaid
+  - sass-embedded
+  # not detected in script
+  - cross-env

.github/workflows/docsite.yml

@@ -6,6 +6,8 @@ on:
     paths:
       - 'docs/**'
       - .github/workflows/docsite.yml
+      # in case of dependency changes
+      - yarn.lock
   workflow_dispatch:
 
 concurrency:
@@ -23,17 +25,14 @@ jobs:
       - name: Check out code
         uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
 
-      # The docs have a separate installation using Node 22 due to needing newer dependencies
       - name: Install Node.js
         uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
-          node-version-file: docs/.nvmrc
+          node-version-file: .nvmrc
 
       - run: yarn --immutable
-        working-directory: ./docs
 
       - run: yarn docs:build
-        working-directory: ./docs
 
       - name: Upload site as artifact
         id: deployment

.github/workflows/pr.yml

@@ -5,9 +5,12 @@ name: PR
 
 on:
   pull_request:
-    branches: [main]
+    branches: [master, next, next2]
   push:
-    branches: [main]
+    branches: [master, next, next2]
+
+env:
+  npmVersion: 10
 
 concurrency:
   # For PRs, use the ref (branch) in the concurrency group so that new pushes cancel any old runs.
@@ -23,15 +26,8 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        npm: [8]
-        include:
-          - os: ubuntu-latest
-            # npm 6 and 8 have slightly different behavior with verdaccio in publishing tests.
-            # It's unclear if this translates to meaningful differences in behavior in actual scenarios,
-            # but test against both versions to be safe. (Only do this on the ubuntu build for speed.)
-            npm: 6
 
-    name: build (${{ matrix.os }}, npm ${{ matrix.npm }})
+    name: build (${{ matrix.os }})
 
     runs-on: ${{ matrix.os }}
 
@@ -45,42 +41,23 @@ jobs:
           cache: yarn
           node-version-file: .nvmrc
 
-      # Guarantee a predictable version of npm for the first round of tests
-      - name: Install npm@${{ matrix.npm }}
-        run: npm install --global npm@${{ matrix.npm }}
+      # Guarantee a predictable version of npm
+      - name: Install npm@${{ env.npmVersion }}
+        run: npm install --global npm@${{ env.npmVersion }}
 
-      - run: yarn --frozen-lockfile
+      - run: yarn --immutable
 
       - run: yarn build
 
       - run: yarn checkchange --verbose
 
+      - run: yarn docs:build
+
       - run: yarn lint
 
       - run: yarn test:unit
 
       - run: yarn test:func
 
-      - run: yarn test:e2e
-
-  # The docs have a separate installation using Node 22 due to needing newer dependencies
-  docs:
-    name: build docs
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Check out code
-        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
-
-      - name: Install Node.js 22
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
-        with:
-          cache: yarn
-          node-version: 22
-
-      - run: yarn --immutable
-        working-directory: ./docs
-
-      - run: yarn docs:build
-        working-directory: ./docs
+      - name: yarn test:e2e (npm ${{ env.npmVersion }})
+        run: yarn test:e2e

.github/workflows/release.yml

@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
 
 env:
-  npmVersion: 8
+  npmVersion: 10
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -31,11 +31,11 @@ jobs:
         with:
           node-version-file: .nvmrc
 
-      # Guarantee a predictable version of npm (the PR build tests against both 6 and 8)
-      - name: Install package managers
-        run: npm install --global npm@${{ env.npmVersion }} yarn@1
+      # Guarantee a predictable version of npm
+      - name: Install npm@${{ env.npmVersion }}
+        run: npm install --global npm@${{ env.npmVersion }}
 
-      - run: yarn --frozen-lockfile
+      - run: yarn --immutable
 
       - run: yarn build
 

.gitignore

@@ -6,11 +6,14 @@ node_modules/
 .DS_Store
 lib/
 package-lock.json
-# ignore when switching between yarn 1/4 branches
-.yarn
 
 docs/.vuepress/.cache
 docs/.vuepress/.temp
 docs/.yarn/*
-!docs/.yarn/patches/
-!docs/.yarn/releases/
+docs/.yarn
+
+.yarn/*
+!.yarn/patches/
+!.yarn/releases/
+# Ignore this in case a local .npmrc is added with a token for publishing
+.npmrc

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 yarn lint-staged

.nvmrc

@@ -1 +1 @@
-14
+20

.prettierignore

@@ -1,17 +1,15 @@
-*.log
+# As of version 3, Prettier respects .gitignore in addition to this file.
+
+.yarn/
 *.snap
 *.styl
 *.svg
 .*ignore
 .husky/
-.DS_Store
 .nojekyll
 .nvmrc
-docs/.vuepress/dist/
 /change/
 /CHANGELOG.*
-/lib/
 LICENSE
-node_modules/
 SECURITY.md
 yarn.lock

.vscode/launch.json

@@ -10,14 +10,20 @@
       "name": "Debug current open test",
       "runtimeExecutable": "npm",
       "cwd": "${workspaceFolder}",
-      "runtimeArgs": ["run-script", "test"],
+      // In a CJS project ("type": "module" absent from package.json), Jest must be run with
+      // --experimental-vm-modules to allow dynamic imports of ESM packages.
+      // When running from the CLI we provide this with cross-env in the "test" script, but that
+      // approach causes problems with debugging (VS Code sets node options for debugging, which
+      // must be preserved). So here we use a script that runs jest directly and passes extra
+      // options via environment variable.
+      "runtimeArgs": ["run-script", "test:vscode"],
       "args": ["--", "--runInBand", "--watch", "--testTimeout=1000000", "${fileBasenameNoExtension}"],
       "sourceMaps": true,
       "outputCapture": "std",
       "console": "integratedTerminal",
-      // Debug with Node 14 via nvm.
-      // On Windows, you might have to change this to a specific version.
-      "runtimeVersion": "14"
+      "env": {
+        "NODE_OPTIONS": "--experimental-vm-modules"
+      }
     },
     {
       "type": "node",
@@ -57,7 +63,9 @@
         "${jest.testFile}"
       ],
       "console": "integratedTerminal",
-      "runtimeVersion": "14"
+      "env": {
+        "NODE_OPTIONS": "--experimental-vm-modules"
+      }
     }
   ]
 }