Files
Daniel La RocqueandGitHub e0aabcc41e chore(format): optimize code formatting speed repo-wide (#10111)
Enable prettier caching (--cache) across all package prettier scripts and the main format script, and optimize the custom license header checker to read only the first 1000 bytes of each file.

Performance Data:
- Repo-wide formatting (yarn format --all):
  - Before caching: ~35-40s (uncached formatting + full license check)
  - After caching: ~5.8s (cached formatting + header-only license check)
  - Speedup: ~6x speedup
2026-06-24 16:34:57 -04:00

97 lines
2.6 KiB
TypeScript

/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { resolve } from 'path';
import { exec, spawn } from 'child-process-promise';
import chalk from 'chalk';
const root = resolve(__dirname, '../..');
const packageJson = require(root + '/package.json');
async function checkVersion() {
const { stdout } = await exec('yarn prettier --version', {
cwd: root
});
const lines = stdout.split('\n');
let runtimeVersion;
for (const line of lines) {
if (line.match(/^\d+\.\d+\.\d+$/)) {
runtimeVersion = line;
break;
}
}
if (!runtimeVersion) {
console.warn('Was not able to find runtime version of prettier.');
return;
}
const packageVersion = packageJson.devDependencies.prettier;
if (packageVersion !== runtimeVersion) {
const mismatchText =
`Installed version of prettier (${runtimeVersion}) does not match ` +
`required version (${packageVersion}).`;
const versionMismatchMessage = chalk`
{red ${mismatchText}}
{yellow Please re-run {reset 'yarn'} from the root of the repo and try again.}
`;
throw new Error(versionMismatchMessage);
}
}
export async function doPrettier(changedFiles?: string[]) {
try {
await checkVersion();
} catch (e) {
console.error(e);
return process.exit(1);
}
let prettierArgs = [
'prettier',
'--config',
`${resolve(root, '.prettierrc')}`,
'--cache',
'--write'
];
if (changedFiles) {
prettierArgs = [...prettierArgs, ...changedFiles];
console.log(
chalk`{green Validating ${changedFiles.length} files with Prettier}`
);
} else {
prettierArgs.push('{,!(node_modules)}/**/*.{js,ts}');
console.log(chalk`{green Validating all .js and .ts files with Prettier}`);
}
try {
await spawn('yarn', prettierArgs, {
stdio: 'inherit',
cwd: root
});
} catch (e) {
if ((e as NodeJS.ErrnoException).code === 'E2BIG') {
console.error(
chalk`{red Too many files, use a smaller pattern or use the --all flag.}`
);
process.exit();
} else {
throw e;
}
}
}