pref(prettier): enable prettier cache (#511)

**Problem:** Prettier can be slow when there are many files (particularly with large repos and running with `--all`). **Solution:** Enable Prettier' cache by default.
paularmstrong · Dec 30, 2023 · 0125556 · 0125556
1 parent 154a2d1
commit 0125556
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 9 deletions.
diff --git a/.changeset/weak-pumpkins-kick.md b/.changeset/weak-pumpkins-kick.md
@@ -0,0 +1,5 @@
+---
+'@onerepo/plugin-prettier': minor
+---
+
+Enable using cache to speed up formatting files. This feature can be disabled at the plugin configuration level by setting `useCache: false` or by passing `--no-cache` to the command.
diff --git a/plugins/prettier/src/commands/__tests__/prettier.test.ts b/plugins/prettier/src/commands/__tests__/prettier.test.ts
@@ -48,7 +48,7 @@ describe('handler', () => {
 		expect(graph.packageManager.run).toHaveBeenCalledWith(
 			expect.objectContaining({
 				cmd: 'prettier',
-				args: ['--ignore-unknown', '--write', '.'],
+				args: ['--ignore-unknown', '--write', '--cache', '--cache-strategy', 'content', '.'],
 			}),
 		);
 	});
@@ -66,7 +66,15 @@ describe('handler', () => {
 		expect(graph.packageManager.run).toHaveBeenCalledWith(
 			expect.objectContaining({
 				cmd: 'prettier',
-				args: ['--ignore-unknown', '--write', 'modules/burritos', 'modules/tacos'],
+				args: [
+					'--ignore-unknown',
+					'--write',
+					'--cache',
+					'--cache-strategy',
+					'content',
+					'modules/burritos',
+					'modules/tacos',
+				],
 			}),
 		);
 	});
@@ -79,7 +87,7 @@ describe('handler', () => {
 		expect(graph.packageManager.run).toHaveBeenCalledWith(
 			expect.objectContaining({
 				cmd: 'prettier',
-				args: ['--ignore-unknown', '--list-different', '.'],
+				args: ['--ignore-unknown', '--list-different', '--cache', '--cache-strategy', 'content', '.'],
 			}),
 		);
 	});
@@ -102,7 +110,7 @@ bar/**/*
 		expect(graph.packageManager.run).toHaveBeenCalledWith(
 			expect.objectContaining({
 				cmd: 'prettier',
-				args: ['--ignore-unknown', '--write', 'foo.js'],
+				args: ['--ignore-unknown', '--write', '--cache', '--cache-strategy', 'content', 'foo.js'],
 			}),
 		);
 	});
@@ -126,7 +134,7 @@ bar/**/*
 		expect(graph.packageManager.run).toHaveBeenCalledWith(
 			expect.objectContaining({
 				cmd: 'prettier',
-				args: ['--ignore-unknown', '--write', 'bar.js'],
+				args: ['--ignore-unknown', '--write', '--cache', '--cache-strategy', 'content', 'bar.js'],
 			}),
 		);
 		expect(git.updateIndex).toHaveBeenCalledWith(['bar.js']);
@@ -147,4 +155,17 @@ bar/**/*
 		expect(core.error).toHaveBeenCalledWith(expect.stringContaining('This file needs formatting'), { file: 'bop.js' });
 		expect(core.error).not.toHaveBeenCalledWith(expect.any(String), { file: 'bar.js' });
 	});
+
+	test('can disable cache', async () => {
+		vi.spyOn(graph.packageManager, 'run').mockResolvedValue(['', '']);
+
+		await run('--all --no-cache');
+
+		expect(graph.packageManager.run).toHaveBeenCalledWith(
+			expect.objectContaining({
+				cmd: 'prettier',
+				args: ['--ignore-unknown', '--write', '.'],
+			}),
+		);
+	});
 });
diff --git a/plugins/prettier/src/commands/prettier.ts b/plugins/prettier/src/commands/prettier.ts
@@ -12,6 +12,7 @@ export const description = 'Format files with prettier';
 
 type Args = {
 	add?: boolean;
+	cache: boolean;
 	check?: boolean;
 	'github-annotate': boolean;
 } & builders.WithAllInputs;
@@ -29,7 +30,13 @@ export const builder: Builder<Args> = (yargs) =>
 			type: 'boolean',
 		})
 		.option('github-annotate', {
-			description: 'Annotate files in GitHub with errors when failing format checks in GitHub Actions',
+			description: 'Annotate files in GitHub with errors when failing format checks in GitHub Actions.',
+			type: 'boolean',
+			default: true,
+			hidden: true,
+		})
+		.option('cache', {
+			description: 'Use Prettier’s built-in cache to determin whether files need formatting or not.',
 			type: 'boolean',
 			default: true,
 			hidden: true,
@@ -41,7 +48,7 @@ export const builder: Builder<Args> = (yargs) =>
 		});
 
 export const handler: Handler<Args> = async function handler(argv, { getFilepaths, graph, logger }) {
-	const { add, all, check, 'dry-run': isDry, 'github-annotate': github, $0: cmd, _: positionals } = argv;
+	const { add, all, cache, check, 'dry-run': isDry, 'github-annotate': github, $0: cmd, _: positionals } = argv;
 
 	const filteredPaths = [];
 	if (!all) {
@@ -81,7 +88,12 @@ export const handler: Handler<Args> = async function handler(argv, { getFilepath
 		await graph.packageManager.run({
 			name: `Format files ${all ? '' : filteredPaths.join(', ').substring(0, 60)}…`,
 			cmd: 'prettier',
-			args: ['--ignore-unknown', isDry || check ? '--list-different' : '--write', ...(all ? ['.'] : filteredPaths)],
+			args: [
+				'--ignore-unknown',
+				isDry || check ? '--list-different' : '--write',
+				...(cache ? ['--cache', '--cache-strategy', 'content'] : []),
+				...(all ? ['.'] : filteredPaths),
+			],
 			step: runStep,
 		});
 	} catch (e) {

diff --git a/plugins/prettier/src/index.ts b/plugins/prettier/src/index.ts
@@ -21,8 +21,14 @@ export type Options = {
 	name?: string | Array<string>;
 	/**
 	 * When `true` or unset and run in GitHub Actions, any files failing format checks will be annotated with an error in the GitHub user interface.
+	 * @default true
 	 */
 	githubAnnotate?: boolean;
+	/**
+	 * Whether to use Prettier's built-in cache determinism.
+	 * @default true
+	 */
+	useCache?: boolean;
 };
 
 /**
@@ -51,7 +57,8 @@ export function prettier(opts: Options = {}): Plugin {
 				(yargs) =>
 					builder(yargs)
 						.usage(`$0 ${Array.isArray(name) ? name[0] : name} [options]`)
-						.default('github-annotate', opts.githubAnnotate ?? true),
+						.default('github-annotate', opts.githubAnnotate ?? true)
+						.default('cache', opts.useCache ?? true),
 				handler,
 			);
 		},