3D engine that AI agents drive
JavaScript 3d3d-engineagentic-aiai-agentsblenderclaude-codegame-enginegaussian-splattinggltfjavascriptmcpmcp-servermodel-context-protocolpath-tracerpath-tracingpbrrenderingthreejs-alternativewebgl2webgpu
// The cheap, test-free gates of `npm run preflight` that must also run on CI, because `git push --no-verify` skips the
// pre-push hook: the protected files and the change note. Usage: npm run check:change-note
// In CI it compares with the first parent of the merge commit (scripts/ci-base-sha.mjs). Elsewhere pass --base <ref>.
import { spawnSync } from 'node:child_process';
import { pathToFileURL } from 'node:url';
import { resolve } from 'node:path';
import { isVersionBump, planChecks } from './preflight.mjs';
import { readReleaseProblem } from './check-release-changelog.mjs';
import { isFragmentName, parseEntries } from './changelog-fragments.mjs';
import { pullRequestBaseOf } from './size-base.mjs';
const gateNames = new Set(['protected files', 'change note', 'release changelog']);
// Returns the failing gates for a list of changed paths. Pure, so tests can call it without git.
export function failingGatesFor(changedPaths, { release = false, releaseProblem = null, addedPaths = null } = {}) {
return planChecks(changedPaths, { skipTests: true, release, releaseProblem, addedPaths })
.filter(check => gateNames.has(check.name) && check.failure)
.map(check => ({ name: check.name, failure: check.failure, fix: check.fix }));
}
// A note the fold writes nothing for: no "- " bullet, or only whitespace. The fold skips it, so the release would lose the change.
// `readNote` returns the text of an added path. Pure apart from that, so tests can call it without git.
export function emptyNoteGates(addedPaths, readNote) {
const notePaths = addedPaths.filter((path) => {
const [folder, name, ...deeper] = path.replaceAll('\\', '/').split('/');
return folder === 'changes' && name !== undefined && deeper.length === 0 && isFragmentName(name);
});
return notePaths
.filter(path => parseEntries(readNote(path), path).length === 0)
.map(path => ({ name: 'change note', failure: `${path} has no "- " bullet, so changes:fold would drop it.`, fix: 'Write one bullet in it, such as "- `bar` takes a `foo` option (#123)" (changes/README.md).' }));
}
function git(args) {
const result = spawnSync('git', args, { encoding: 'utf8' });
if (result.status !== 0) throw new Error(`git ${args.join(' ')} failed: ${result.stderr.trim()}`);
return result.stdout.trim();
}
function baseRefFromArguments() {
const flagIndex = process.argv.indexOf('--base');
if (flagIndex !== -1) return process.argv[flagIndex + 1];
return pullRequestBaseOf() ?? git(['rev-parse', 'HEAD^1']);
}
async function main() {
const baseRef = baseRefFromArguments();
const changedPaths = git(['diff', '--name-only', '--no-renames', baseRef, 'HEAD']).split('\n').filter(Boolean);
const addedPaths = git(['diff', '--name-only', '--no-renames', '--diff-filter=A', baseRef, 'HEAD']).split('\n').filter(Boolean);
const release = isVersionBump(git(['show', `${baseRef}:package.json`]), git(['show', 'HEAD:package.json']));
if (release) console.log('The package version changed, so this is a release: the protected file and change note gates do not apply, the release changelog gate does.');
const releaseProblem = release ? await readReleaseProblem(process.cwd()) : null;
const failing = failingGatesFor(changedPaths, { release, releaseProblem, addedPaths });
if (!release) failing.push(...emptyNoteGates(addedPaths, path => git(['show', `HEAD:${path}`])));
for (const gate of failing) {
console.error(`FAIL ${gate.name}: ${gate.failure}\n Fix: ${gate.fix}`);
}
if (failing.length === 0) console.log(`ok: ${changedPaths.length} changed files pass the protected file, change note and release changelog gates.`);
return failing.length === 0 ? 0 : 1;
}
if (import.meta.url === pathToFileURL(resolve(process.argv[1] ?? '')).href) {
process.exit(await main());
}