feat(tools): ignore pnpm install unstable ouutput

and ignore cwd too

Author: fengmk2

.github/workflows/ci.yml

@@ -143,7 +143,7 @@ jobs:
 
       - name: Run CLI E2E tests
         run: |
-          pnpm run --filter=@voidzero-dev/vite-plus --filter=@voidzero-dev/global test
+          pnpm run --filter=@voidzero-dev/vite-plus --filter=@voidzero-dev/global snap-test
           git diff --exit-code
 
   install-e2e-test:

package.json

@@ -9,7 +9,7 @@
     "install-global-cli": "npm install -g ./packages/global",
     "typecheck": "tsc -b tsconfig.json",
     "lint": "vite lint",
-    "test": "pnpm -r test",
+    "test": "vitest run && pnpm -r snap-test",
     "prepare": "husky"
   },
   "devDependencies": {
@@ -20,7 +20,8 @@
     "husky": "^9.1.7",
     "lint-staged": "^16.1.6",
     "oxlint": "catalog:",
-    "typescript": "catalog:"
+    "typescript": "catalog:",
+    "vitest": "catalog:"
   },
   "lint-staged": {
     "*.@(js|ts|tsx|yml|yaml|md|json|html|toml)": [

packages/cli/package.json

@@ -22,7 +22,7 @@
     "build": "pnpm run build:binding && pnpm run build:ts",
     "build:binding": "napi build --package-json-path ../package.json --cwd binding --platform --release --esm",
     "build:ts": "tsdown",
-    "test": "snap-test"
+    "snap-test": "snap-test"
   },
   "files": [
     "bin",

packages/global/package.json

@@ -19,7 +19,7 @@
   "scripts": {
     "dev": "tsdown --watch",
     "build": "tsdown",
-    "test": "snap-test"
+    "snap-test": "snap-test"
   },
   "dependencies": {
     "oxlint": "catalog:",

packages/tools/src/__tests__/__snapshots__/utils.spec.ts.snap

@@ -0,0 +1,34 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`replaceUnstableOutput > replace unstable cwd 1`] = `"<cwd>/foo.txt"`;
+
+exports[`replaceUnstableOutput > replace unstable pnpm install output 1`] = `
+"Scope: all <variable> workspace projects
+Packages: +<variable>
++<repeat>
+Progress: resolved <variable>, reused <variable>, downloaded <variable>, added <variable>, done"
+`;
+
+exports[`replaceUnstableOutput > replace unstable pnpm install output 2`] = `
+"Scope: all <variable> workspace projects
+Lockfile is up to date, resolution step is skipped
+Already up to date
+
+╭ Warning ───────────────────────────────────────────────────────────────────────────────────╮
+│                                                                                            │
+│   Ignored build scripts: esbuild.                                                          │
+│   Run "pnpm approve-builds" to pick which dependencies should be allowed to run scripts.   │
+│                                                                                            │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+
+Done in <variable>ms using pnpm v<semver>"
+`;
+
+exports[`replaceUnstableOutput > replace unstable semver version 1`] = `
+"v1.0.0
+v1.0.0-beta.1
+v1.0.0-beta.1+build.1
+1.0.0
+1.0.0-beta.1
+1.0.0-beta.1+build.1"
+`;

packages/tools/src/__tests__/utils.spec.ts

@@ -0,0 +1,53 @@
+import { tmpdir } from 'node:os';
+
+import { describe, expect, test } from 'vitest';
+
+import { replaceUnstableOutput } from '../utils.ts';
+
+describe('replaceUnstableOutput', () => {
+  test('replace unstable semver version', () => {
+    const output = `
+v1.0.0
+v1.0.0-beta.1
+v1.0.0-beta.1+build.1
+1.0.0
+1.0.0-beta.1
+1.0.0-beta.1+build.1
+    `;
+    expect(replaceUnstableOutput(output.trim())).toMatchSnapshot();
+  });
+
+  test('replace unstable pnpm install output', () => {
+    const outputs = [
+      `
+Scope: all 6 workspace projects
+Packages: +312
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Progress: resolved 462, reused 324, downloaded 0, added 312, done
+      `,
+      `
+Scope: all 2 workspace projects
+Lockfile is up to date, resolution step is skipped
+Already up to date
+
+╭ Warning ───────────────────────────────────────────────────────────────────────────────────╮
+│                                                                                            │
+│   Ignored build scripts: esbuild.                                                          │
+│   Run "pnpm approve-builds" to pick which dependencies should be allowed to run scripts.   │
+│                                                                                            │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+
+Done in 171ms using pnpm v10.16.1
+      `,
+    ];
+    for (const output of outputs) {
+      expect(replaceUnstableOutput(output.trim())).toMatchSnapshot();
+    }
+  });
+
+  test('replace unstable cwd', () => {
+    const cwd = tmpdir();
+    const output = `${cwd}/foo.txt`;
+    expect(replaceUnstableOutput(output.trim(), cwd)).toMatchSnapshot();
+  });
+});

packages/tools/src/snap-test.ts

@@ -6,6 +6,8 @@ import fs from 'node:fs';
 import { tmpdir } from 'node:os';
 import path from 'node:path';
 
+import { replaceUnstableOutput } from './utils.ts';
+
 // Create a unique temporary directory for testing
 const tempTmpDir = `${tmpdir()}/vite-plus-test-${randomUUID()}`;
 fs.mkdirSync(tempTmpDir, { recursive: true });
@@ -43,24 +45,19 @@ function runTestCase(name: string) {
     VITE_PLUS_CLI_TEST: '1',
   };
   env['PATH'] = [
-    ...env['PATH']!.split(path.delimiter),
     // Extend PATH to include the package's bin directory
-    path.resolve('bin')
+    path.resolve('bin'),
+    ...env['PATH']!.split(path.delimiter),
   ].join(path.delimiter);
 
   const newSnap: string[] = [];
 
   for (const command of steps.commands) {
     newSnap.push(`> ${command}`);
     const output = cp.execSync(command, { env, cwd: caseTmpDir, encoding: 'utf-8' });
-    newSnap.push(replaceUnstableOutput(output));
+    newSnap.push(replaceUnstableOutput(output, caseTmpDir));
   }
   const newSnapContent = newSnap.join('\n');
 
   fs.writeFileSync(`${casesDir}/${name}/snap.txt`, newSnapContent);
 }
-
-function replaceUnstableOutput(output: string) {
-  return output.replace(/\d+(?:\.\d+)?s|\d+ms/, '<variable>ms')
-    .replace(/with \d+ rules using \d+ threads/, 'with <variable> rules using <variable> threads');
-}

packages/tools/src/utils.ts

@@ -0,0 +1,19 @@
+export function replaceUnstableOutput(output: string, cwd?: string) {
+  if (cwd) {
+    output = output.replaceAll(cwd, '<cwd>');
+  }
+  return output
+    // semver version
+    .replaceAll(/ (v)?\d+\.\d+\.\d+(?:-.*)?/g, ' $1<semver>')
+    // oxlint
+    .replaceAll(/\d+(?:\.\d+)?s|\d+ms/g, '<variable>ms')
+    .replaceAll(/with \d+ rules using \d+ threads/g, 'with <variable> rules using <variable> threads')
+    // pnpm
+    .replaceAll(/Packages: \+\d+/g, 'Packages: +<variable>')
+    .replaceAll(
+      /Progress: resolved \d+, reused \d+, downloaded \d+, added \d+, done/g,
+      'Progress: resolved <variable>, reused <variable>, downloaded <variable>, added <variable>, done',
+    )
+    .replaceAll(/Scope: all \d+ workspace projects/g, 'Scope: all <variable> workspace projects')
+    .replaceAll(/\++\n/g, '+<repeat>\n');
+}