Fix E2BIG error in pre-commit (#1712)

When pre-commit runs a command, it tries to avoid putting too many
arguments on the command-line by splitting up the arg list. To do so, it
needs to take into account the number of arguments that are on the
command itself, in addition to the args it will add for the files it
needs to process. If the command in `.pre-commit-config.yaml` calls a
subcommand that has more arguments, then pre-commit's calculation of how
many args it needs to leave for the call itself will be wrong, and we
get E2BIG.

The hack is to just inline whatever subcommand gets called into
`.pre-commit-config.yaml`. Quite annoying and duplicative, but it
appears there's no way around it. See
pre-commit/pre-commit#2841

## Checklist

- [ ] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [ ] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [ ] I have not broken the cheatsheet

Author: pokey

.pre-commit-config.yaml

@@ -62,14 +62,14 @@ repos:
         name: format-recorded-tests
         files: ^packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/.*/[^/]*\.yml$
         language: system
-        entry: pnpm transform-recorded-tests
+        entry: pnpm exec tsx --conditions=cursorless:bundler packages/cursorless-engine/src/scripts/transformRecordedTests/index.ts
   - repo: local
     hooks:
       - id: check-recorded-test-marks
         name: check-recorded-test-marks
         files: ^packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/.*/[^/]*\.yml$
         language: system
-        entry: pnpm transform-recorded-tests --check-marks
+        entry: pnpm exec tsx --conditions=cursorless:bundler packages/cursorless-engine/src/scripts/transformRecordedTests/index.ts --check-marks
   - repo: https://github.com/ikamensh/flynt/
     rev: "0.78"
     hooks:

packages/meta-updater/package.json

@@ -15,6 +15,7 @@
     "@pnpm/logger": "^5.0.0",
     "@pnpm/types": "8.9.0",
     "@types/normalize-path": "^3.0.0",
+    "js-yaml": "^4.1.0",
     "normalize-path": "^3.0.0",
     "path-exists": "^4.0.0",
     "type-fest": "3.6.1"
@@ -29,6 +30,7 @@
     }
   },
   "devDependencies": {
+    "@types/js-yaml": "^4.0.2",
     "esbuild": "^0.17.11"
   }
 }

packages/meta-updater/src/updatePackageJson.ts

@@ -1,7 +1,10 @@
+import * as yaml from "js-yaml";
 import type { FormatPluginFnOptions } from "@pnpm/meta-updater";
 import { PackageJson } from "type-fest";
 import { Context } from "./Context";
 import { getCursorlessVscodeFields } from "./getCursorlessVscodeFields";
+import { readFile } from "fs/promises";
+import { join } from "path";
 
 /**
  * Given a package.json, update it to match our conventions.  This function is
@@ -66,14 +69,30 @@ export async function updatePackageJson(
     ...input,
     name,
     license: "MIT",
-    scripts: getScripts(input.scripts, isRoot, isCursorlessVscode),
+    scripts: await getScripts(
+      input.scripts,
+      packageDir,
+      isRoot,
+      isCursorlessVscode,
+    ),
     ...exportFields,
     ...extraFields,
   } as PackageJson;
 }
 
-function getScripts(
+interface PreCommitConfig {
+  repos: {
+    hooks: {
+      id: string;
+      name: string;
+      entry: string;
+    }[];
+  }[];
+}
+
+async function getScripts(
   inputScripts: PackageJson.Scripts | undefined,
+  packageDir: string,
   isRoot: boolean,
   isCursorlessVscode: boolean,
 ) {
@@ -84,6 +103,12 @@ function getScripts(
   };
 
   if (isRoot) {
+    // Ensure that `pnpm transform-recorded-tests` mirrors what is in pre-commit
+    // config
+    scripts["transform-recorded-tests"] = await getTransformRecordedTestsScript(
+      packageDir,
+    );
+
     return scripts;
   }
 
@@ -97,3 +122,35 @@ function getScripts(
 
   return scripts;
 }
+
+async function getTransformRecordedTestsScript(packageDir: string) {
+  const preCommitConfig = yaml.load(
+    await readFile(join(packageDir, ".pre-commit-config.yaml"), "utf8"),
+  ) as PreCommitConfig;
+
+  const formatRecordedTestsEntry = preCommitConfig.repos
+    .flatMap(({ hooks }) => hooks)
+    .find(({ id }) => id === "format-recorded-tests")?.entry;
+
+  if (!formatRecordedTestsEntry?.startsWith("pnpm exec ")) {
+    throw new Error(
+      'Expected pre-commit transform-recorded-tests entry to start with "pnpm exec "',
+    );
+  }
+
+  const checkRecordedTestMarksEntry = preCommitConfig.repos
+    .flatMap(({ hooks }) => hooks)
+    .find(({ id }) => id === "check-recorded-test-marks")?.entry;
+
+  if (!checkRecordedTestMarksEntry?.startsWith(formatRecordedTestsEntry)) {
+    throw new Error(
+      "Expected pre-commit check-recorded-test-marks entry to mirror format-recorded-test-marks",
+    );
+  }
+
+  const transformRecordedTestsScript = formatRecordedTestsEntry.slice(
+    "pnpm exec ".length,
+  );
+
+  return transformRecordedTestsScript;
+}