Add pnpm pre-ci:affected fast mode

Author: dmerand

bin/ci-gates.js

@@ -5,19 +5,25 @@
 //
 // `job` is the workflow job id (the key under `jobs:`), which is stable, unlike
 // the rendered display name (matrix jobs interpolate `${{ ... }}`).
+//
+// pre-ci gates may declare:
+//   command  — full-parity command (run by `pnpm pre-ci`)
+//   affected — faster command for `pnpm pre-ci:affected` (defaults to `command`)
+//   affectedWhen: 'codegen' — in affected mode, run only when the diff plausibly
+//     changes generated output; otherwise skip with a reminder.
 
 export const CI_GATES = [
   // --- gates a contributor can reproduce locally before pushing ---
   // Ordered as pre-ci should run them: build precedes the oclif codegen check,
   // and the graphql check precedes the oclif check (their whole-repo `git status`
   // asserts otherwise cross-contaminate in a single working tree).
-  {job: 'type-check', kind: 'pre-ci', command: 'pnpm type-check'},
-  {job: 'lint', kind: 'pre-ci', command: 'pnpm lint'},
-  {job: 'bundle', kind: 'pre-ci', command: 'pnpm build'},
+  {job: 'type-check', kind: 'pre-ci', command: 'pnpm type-check', affected: 'pnpm type-check:affected'},
+  {job: 'lint', kind: 'pre-ci', command: 'pnpm lint', affected: 'pnpm lint:affected'},
+  {job: 'bundle', kind: 'pre-ci', command: 'pnpm build', affected: 'pnpm build:affected'},
   {job: 'knip', kind: 'pre-ci', command: 'pnpm knip'},
-  {job: 'graphql-schema', kind: 'pre-ci', command: 'pnpm codegen:check:graphql'},
-  {job: 'oclif-checks', kind: 'pre-ci', command: 'pnpm codegen:check:oclif'},
-  {job: 'unit-tests', kind: 'pre-ci', command: 'pnpm test'},
+  {job: 'graphql-schema', kind: 'pre-ci', command: 'pnpm codegen:check:graphql', affectedWhen: 'codegen'},
+  {job: 'oclif-checks', kind: 'pre-ci', command: 'pnpm codegen:check:oclif', affectedWhen: 'codegen'},
+  {job: 'unit-tests', kind: 'pre-ci', command: 'pnpm test', affected: 'pnpm vitest run --changed origin/main'},
 
   // --- CI-only jobs, with the reason they are not part of pre-ci ---
   {

bin/pre-ci.js

@@ -1,21 +1,58 @@
-// Runs the local subset of PR CI gates ("run what CI runs") so contributors can
-// catch failures before pushing. The gate list and its parity with the workflow
-// are defined in bin/ci-gates.js and enforced by bin/check-ci-gates.js.
+// Runs the local PR CI gates ("run what CI runs") so contributors can catch
+// failures before pushing. The gate list and its parity with the workflow are
+// defined in bin/ci-gates.js and enforced by bin/check-ci-gates.js.
 //
-// pre-ci mirrors CI's full (`--all`) targets so that green locally implies green
-// in CI. It is intentionally slower than the affected-only `dev check`.
+//   pnpm pre-ci            full parity with CI's `--all` targets (slower)
+//   pnpm pre-ci:affected   only what your diff touches (faster inner loop)
+//
+// Affected mode runs the nx/vitest affected variants and skips the codegen
+// freshness checks unless the diff plausibly changes generated output.
 import {execSync} from 'node:child_process'
 
 import {PRE_CI_GATES, CI_ONLY_GATES} from './ci-gates.js'
 
-const steps = [
-  {label: 'CI gate manifest in sync', command: 'pnpm check-ci-gates'},
-  ...PRE_CI_GATES.map((gate) => ({label: gate.job, command: gate.command})),
-]
+const affected = process.argv.includes('--affected')
+
+// Changed files vs the merge-base with origin/main, plus the working tree.
+// Returns null if detection fails, so callers can fail safe (assume relevant).
+function changedFiles() {
+  try {
+    const base = execSync('git merge-base HEAD origin/main', {encoding: 'utf8'}).trim()
+    const committed = execSync(`git diff --name-only ${base}...HEAD`, {encoding: 'utf8'})
+    const working = execSync('git status --porcelain', {encoding: 'utf8'})
+    const files = new Set()
+    for (const line of committed.split('\n')) if (line.trim()) files.add(line.trim())
+    for (const line of working.split('\n')) if (line.slice(3).trim()) files.add(line.slice(3).trim())
+    return [...files]
+  } catch {
+    return null
+  }
+}
+
+function touchesGeneratedOutput(files) {
+  if (files === null) return true
+  return files.some(
+    (file) => file.includes('/commands/') || file.endsWith('.graphql') || /graphql/i.test(file) || file.startsWith('docs-shopify.dev/'),
+  )
+}
+
+const diff = affected ? changedFiles() : null
+const codegenRelevant = affected ? touchesGeneratedOutput(diff) : true
+
+const steps = [{label: 'CI gate manifest in sync', command: 'pnpm check-ci-gates'}]
+const skipped = []
+for (const gate of PRE_CI_GATES) {
+  if (affected && gate.affectedWhen === 'codegen' && !codegenRelevant) {
+    skipped.push({job: gate.job, reason: 'affected mode: diff does not touch commands, flags, or GraphQL'})
+    continue
+  }
+  const command = affected ? gate.affected ?? gate.command : gate.command
+  steps.push({label: affected ? `${gate.job} (affected)` : gate.job, command})
+}
 
 const results = []
 for (const step of steps) {
-  process.stdout.write(`\n▶ ${step.label}: ${step.command}\n`)
+  process.stdout.write(`\n\u25b6 ${step.label}: ${step.command}\n`)
   try {
     execSync(step.command, {stdio: 'inherit'})
     results.push({...step, ok: true})
@@ -24,19 +61,23 @@ for (const step of steps) {
   }
 }
 
-console.log('\n──────── pre-ci summary ────────')
-for (const result of results) {
-  console.log(`${result.ok ? '✓' : '✗'} ${result.label}`)
+console.log(`\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 pre-ci${affected ? ' (affected)' : ''} summary \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500`)
+for (const result of results) console.log(`${result.ok ? '\u2713' : '\u2717'} ${result.label}`)
+for (const gate of skipped) console.log(`\u00b7 ${gate.job} \u2014 skipped (${gate.reason})`)
+
+if (affected) {
+  console.log('\nAffected mode is a fast pre-push check, not full CI parity. Run `pnpm pre-ci` before a high-risk push.')
+  if (skipped.length > 0) {
+    console.log('If you changed commands, flags, or GraphQL queries, run `pnpm codegen` and commit the result.')
+  }
 }
 
 console.log('\nNot run locally (CI-only):')
-for (const gate of CI_ONLY_GATES) {
-  console.log(`· ${gate.job} — ${gate.reason}`)
-}
+for (const gate of CI_ONLY_GATES) console.log(`\u00b7 ${gate.job} \u2014 ${gate.reason}`)
 
 const failed = results.filter((result) => !result.ok)
 if (failed.length > 0) {
   console.error(`\npre-ci failed: ${failed.map((result) => result.label).join(', ')}`)
   process.exit(1)
 }
-console.log('\npre-ci passed. Note: codegen checks regenerate files — review `git status` for any uncommitted generated changes.')
+console.log('\npre-ci passed. Codegen checks regenerate files — review `git status` for uncommitted generated changes.')

dev.yml

@@ -69,6 +69,9 @@ commands:
   pre-ci:
     desc: 'Run the local subset of PR CI gates (run what CI runs) before pushing'
     run: pnpm run pre-ci
+  pre-ci:affected:
+    desc: 'Faster pre-ci limited to what your diff touches'
+    run: pnpm run pre-ci:affected
 
 check:
   type-check: pnpm nx affected --target=type-check

package.json

@@ -31,6 +31,7 @@
     "release": "./bin/release",
     "post-release": "./bin/post-release",
     "pre-ci": "node bin/pre-ci.js",
+    "pre-ci:affected": "node bin/pre-ci.js --affected",
     "update-observe": "node bin/update-observe.js",
     "shopify:run": "node packages/cli/bin/dev.js",
     "shopify": "nx build cli && node packages/cli/bin/dev.js",