fix(ci): scope format checks to changed files

Author: ScriptedAlchemy

.github/workflows/build-and-test.yml

@@ -53,7 +53,7 @@ jobs:
         run: npx cypress install
 
       - name: Check code format
-        run: git ls-files -z | xargs -0 pnpm exec prettier --check --ignore-unknown
+        run: node tools/scripts/check-format-changed.mjs
 
       - name: Verify Rslib Template Publint Wiring
         run: node packages/create-module-federation/scripts/verify-rslib-templates.mjs

tools/scripts/check-format-changed.mjs

@@ -0,0 +1,193 @@
+#!/usr/bin/env node
+import { readFileSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { spawnSync } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+
+const SCRIPT_DIR = dirname(fileURLToPath(import.meta.url));
+const ROOT = resolve(SCRIPT_DIR, '../..');
+const CHECK_BATCH_SIZE = 100;
+
+main();
+
+function main() {
+  const requestedBase = parseBaseArg(process.argv.slice(2));
+  const baseRef = resolveBaseRef(requestedBase);
+
+  if (!baseRef) {
+    console.warn(
+      '[format-check] Unable to resolve a base ref. Skipping format check.',
+    );
+    process.exit(0);
+  }
+
+  const changedFiles = getChangedFiles(baseRef, 'HEAD');
+  if (changedFiles.length === 0) {
+    console.log(
+      `[format-check] No changed files detected between ${baseRef}...HEAD. Skipping format check.`,
+    );
+    process.exit(0);
+  }
+
+  console.log(
+    `[format-check] Checking formatting for ${changedFiles.length} changed file(s) from ${baseRef}...HEAD.`,
+  );
+
+  for (let index = 0; index < changedFiles.length; index += CHECK_BATCH_SIZE) {
+    const batch = changedFiles.slice(index, index + CHECK_BATCH_SIZE);
+    const result = spawnSync(
+      'pnpm',
+      ['exec', 'prettier', '--check', '--ignore-unknown', ...batch],
+      {
+        cwd: ROOT,
+        stdio: 'inherit',
+        env: process.env,
+      },
+    );
+
+    if (result.status !== 0) {
+      process.exit(result.status ?? 1);
+    }
+  }
+}
+
+function parseBaseArg(argv) {
+  for (let i = 0; i < argv.length; i += 1) {
+    const token = argv[i];
+    if (token === '--base' && argv[i + 1]) {
+      return argv[i + 1];
+    }
+    if (token.startsWith('--base=')) {
+      return token.slice('--base='.length);
+    }
+  }
+  return null;
+}
+
+function resolveBaseRef(preferredRef) {
+  const headCommit = resolveGitCommit('HEAD');
+  if (hasGitRef(preferredRef)) {
+    const preferredCommit = resolveGitCommit(preferredRef);
+    if (!headCommit || preferredCommit !== headCommit) {
+      return preferredRef;
+    }
+  }
+
+  const refs = [];
+  if (process.env.CI_BASE_REF) {
+    refs.push(process.env.CI_BASE_REF);
+  }
+  if (process.env.CI_LOCAL_BASE_REF) {
+    refs.push(process.env.CI_LOCAL_BASE_REF);
+  }
+  if (process.env.GITHUB_BASE_REF) {
+    refs.push(`origin/${process.env.GITHUB_BASE_REF}`);
+    refs.push(process.env.GITHUB_BASE_REF);
+  }
+  if (process.env.GITHUB_EVENT_BEFORE) {
+    refs.push(process.env.GITHUB_EVENT_BEFORE);
+  }
+  refs.push(...getEventBaseCandidates());
+  refs.push('origin/main', 'main', 'HEAD~1');
+
+  for (const ref of refs) {
+    if (!hasGitRef(ref)) {
+      continue;
+    }
+
+    const candidateCommit = resolveGitCommit(ref);
+    if (!headCommit || candidateCommit !== headCommit) {
+      return ref;
+    }
+  }
+
+  return null;
+}
+
+function getEventBaseCandidates() {
+  const refs = new Set();
+  const eventPath = process.env.GITHUB_EVENT_PATH;
+  if (!eventPath) {
+    return [];
+  }
+
+  try {
+    const payload = JSON.parse(readFileSync(eventPath, 'utf-8'));
+    if (payload?.pull_request?.base?.sha) {
+      refs.add(payload.pull_request.base.sha);
+    }
+    if (payload?.pull_request?.base?.ref) {
+      refs.add(`origin/${payload.pull_request.base.ref}`);
+      refs.add(payload.pull_request.base.ref);
+    }
+    if (payload?.before) {
+      refs.add(payload.before);
+    }
+  } catch {
+    return [];
+  }
+
+  return Array.from(refs);
+}
+
+function getChangedFiles(baseRef, headRef) {
+  const result = spawnSync(
+    'git',
+    ['diff', '--name-only', '--diff-filter=ACMR', `${baseRef}...${headRef}`],
+    {
+      cwd: ROOT,
+      stdio: 'pipe',
+      encoding: 'utf-8',
+    },
+  );
+
+  if (result.status !== 0) {
+    throw new Error(
+      `[format-check] Failed to compute changed files for ${baseRef}...${headRef}: ${result.stderr || result.stdout}`,
+    );
+  }
+
+  return result.stdout
+    .split('\n')
+    .map((entry) => entry.trim())
+    .filter(Boolean);
+}
+
+function hasGitRef(ref) {
+  if (!ref) {
+    return false;
+  }
+
+  const result = spawnSync(
+    'git',
+    ['rev-parse', '--verify', '--quiet', `${ref}^{commit}`],
+    {
+      cwd: ROOT,
+      stdio: 'ignore',
+    },
+  );
+
+  return result.status === 0;
+}
+
+function resolveGitCommit(ref) {
+  if (!ref) {
+    return null;
+  }
+
+  const result = spawnSync(
+    'git',
+    ['rev-parse', '--verify', '--quiet', `${ref}^{commit}`],
+    {
+      cwd: ROOT,
+      stdio: 'pipe',
+      encoding: 'utf-8',
+    },
+  );
+
+  if (result.status !== 0) {
+    return null;
+  }
+
+  return result.stdout.trim() || null;
+}

tools/scripts/ci-local.mjs

@@ -46,10 +46,7 @@ const jobs = [
         runCommand('npx', ['cypress', 'install'], ctx),
       ),
       step('Check code format', (ctx) =>
-        runShell(
-          'git ls-files -z | xargs -0 pnpm exec prettier --check --ignore-unknown',
-          ctx,
-        ),
+        runCommand('node', ['tools/scripts/check-format-changed.mjs'], ctx),
       ),
       step('Verify Rslib Template Publint Wiring', (ctx) =>
         runCommand(