@aws/nx-plugin 1.0.0-rc.89 → 1.0.0-rc.90

package/src/migrations/latest/terraform-fmt-check/migration.js

@@ -0,0 +1,165 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ import { getProjects, joinPathFragments, updateProjectConfiguration } from "@nx/devkit";
+import { addLicenseCheckToLintTarget } from "../../../license/config.js";
+import { TERRAFORM_FORMAT_TARGET, TERRAFORM_PROJECT_GENERATOR_INFO } from "../../../terraform/project/generator.js";
+import { applyGritQL } from "../../../utils/ast.js";
+import { formatFilesInSubtree } from "../../../utils/format.js";
+import { sortObjectKeys } from "../../../utils/object.js";
+/**
+ * Converges a Terraform project's format target on the shape ts and py projects
+ * carry: a `format` target that checks, a `fix` configuration that writes, and a
+ * `lint` target orchestrating it so `run-many --target lint` reaches Terraform
+ * projects with its `fix` and `skip-lint` configurations propagating.
+ *
+ * The target was named `fmt` and ran `terraform fmt`, which rewrites the files it
+ * reads. Those files are its own declared `inputs`, so every run changed the hash
+ * it had just been computed from and it could never cache-hit — Nx reported it
+ * flaky on every build. That per-run write is also what kept the vended
+ * `providers.tf` backend block aligned, so this realigns it.
+ */ /** The command the base target ran before it checked rather than wrote. */ const WRITING_COMMAND = 'terraform fmt';
+/**
+ * The `backend "s3"` arguments the generator vends. Realignment only applies to a
+ * block holding exactly these.
+ */ const BACKEND_ARGUMENTS = [
+    'encrypt',
+    'use_lockfile'
+];
+/** Matches the arguments of a `backend "s3"` block, and their alignment. */ const BACKEND_BLOCK = /backend\s+"s3"\s*\{([^}]*)\}/;
+const BACKEND_ARGUMENT = /^[ \t]*([A-Za-z_][A-Za-z0-9_]*)([ \t]*)=/gm;
+/**
+ * The arguments a `providers.tf` declares in its `backend "s3"` block, in order,
+ * each with the column its `=` currently sits at.
+ */ const readBackendArguments = (contents)=>{
+    const block = BACKEND_BLOCK.exec(contents)?.[1];
+    if (block === undefined) return undefined;
+    return [
+        ...block.matchAll(BACKEND_ARGUMENT)
+    ].map(([, name, gap])=>({
+            name,
+            column: name.length + gap.length
+        }));
+};
+/**
+ * Realigns the `backend "s3"` arguments in an application's `providers.tf`, which
+ * the checking target requires and the per-run write had been supplying.
+ *
+ * `terraform fmt` aligns `=` to the widest key in the whole block, so a block
+ * carrying arguments beyond the two vended ones has a width this cannot know.
+ * Such a block is left alone and reported: rewriting it to the vended width
+ * would push those two out of alignment with the user's own arguments and fail
+ * the very check this migration installs.
+ */ const realignProviders = async (tree, projectName, projectRoot, nextSteps)=>{
+    const filePath = joinPathFragments(projectRoot, 'src', 'providers.tf');
+    if (!tree.exists(filePath)) return;
+    const declared = readBackendArguments(tree.read(filePath, 'utf-8') ?? '');
+    if (!declared?.length) return;
+    const isVendedBlock = declared.length === BACKEND_ARGUMENTS.length && declared.every(({ name })=>BACKEND_ARGUMENTS.includes(name));
+    if (!isVendedBlock) {
+        nextSteps.push(`${filePath}: its \`backend "s3"\` block declares arguments beyond the generated ones, so its alignment was left as it is. Run \`nx run ${projectName}:format --configuration=fix\` if the new format check reports it.`);
+        return;
+    }
+    const width = Math.max(...BACKEND_ARGUMENTS.map((name)=>name.length));
+    // Already at the width `terraform fmt` aligns this block to, so a re-run — and
+    // a workspace whose file is formatted — is a no-op.
+    if (declared.every(({ column })=>column === width)) return;
+    // Each argument is realigned around whatever value it holds, so a value the
+    // user changed is preserved. An argument whose name already fills the width
+    // rewrites to a textually identical pattern, which GritQL notes; the rewrite
+    // still normalises the whitespace around its `=`, which is the point.
+    for (const { name } of declared){
+        await applyGritQL(tree, filePath, `language hcl\n\`${name} = $value\` => \`${name.padEnd(width)} = $value\`` + ` where { $value <: within \`backend "s3" { $_ }\` }`);
+    }
+};
+/** The target name this migration converges on, matching ts and py projects. */ const FORMAT_TARGET = 'format';
+/** The name the generator vended this target under before the rename. */ const LEGACY_TARGET = 'fmt';
+/**
+ * Repoints `dependsOn` entries naming the old target at the new one. A stale
+ * entry is not an error in Nx — it silently drops the edge — so `build` would
+ * stop checking formatting altogether.
+ */ const repointDependsOn = (project)=>{
+    let changed = false;
+    for (const target of Object.values(project.targets ?? {})){
+        const dependsOn = target.dependsOn;
+        if (!Array.isArray(dependsOn) || !dependsOn.includes(LEGACY_TARGET)) {
+            continue;
+        }
+        target.dependsOn = dependsOn.map((entry)=>entry === LEGACY_TARGET ? FORMAT_TARGET : entry);
+        changed = true;
+    }
+    return changed;
+};
+/**
+ * Renames the `fmt` target to `format`, moves it onto the checking form, and
+ * adds the `lint` target that orchestrates it.
+ *
+ * A target whose command is not the one the generator produced is the user's, so
+ * it is reported instead. Both the vended name and the new one are accepted as
+ * the starting point, so a workspace part-way through converges either way.
+ */ const migrateProject = (projectName, project, nextSteps)=>{
+    const targets = project.targets ?? {};
+    const existingName = targets[FORMAT_TARGET] ? FORMAT_TARGET : targets[LEGACY_TARGET] ? LEGACY_TARGET : undefined;
+    if (!existingName) return false;
+    const format = targets[existingName];
+    let changed = false;
+    if (format.options?.command === WRITING_COMMAND) {
+        targets[existingName] = {
+            ...format,
+            inputs: TERRAFORM_FORMAT_TARGET.inputs,
+            options: {
+                ...format.options,
+                command: TERRAFORM_FORMAT_TARGET.options.command
+            },
+            // The user's own configurations win, as their `options` do above: someone
+            // who set `fix` to `terraform fmt -recursive` to cover nested modules
+            // keeps it.
+            configurations: {
+                ...TERRAFORM_FORMAT_TARGET.configurations,
+                ...format.configurations
+            }
+        };
+        changed = true;
+    } else if (!format.configurations?.fix) {
+        nextSteps.push(`${projectName}: its '${existingName}' target has been customised, so it was left as it is. Have it run \`${TERRAFORM_FORMAT_TARGET.options.command}\` and move the writing form to a 'fix' configuration — writing from the base target rewrites the inputs its cache key is computed from, so it can never cache-hit.`);
+        return false;
+    }
+    if (existingName === LEGACY_TARGET) {
+        targets[FORMAT_TARGET] = targets[LEGACY_TARGET];
+        delete targets[LEGACY_TARGET];
+        changed = true;
+    }
+    changed = repointDependsOn(project) || changed;
+    if (!targets.lint) {
+        targets.lint = {
+            dependsOn: [
+                FORMAT_TARGET
+            ]
+        };
+        changed = true;
+    }
+    return changed;
+};
+export default async function migration(tree) {
+    const nextSteps = [];
+    for (const [projectName, project] of getProjects(tree)){
+        const generator = project.metadata?.generator;
+        if (generator !== TERRAFORM_PROJECT_GENERATOR_INFO.id) continue;
+        if (migrateProject(projectName, project, nextSteps)) {
+            updateProjectConfiguration(tree, projectName, {
+                ...project,
+                targets: sortObjectKeys(project.targets)
+            });
+            // The new `lint` target checks licenses alongside formatting, as every
+            // other linting project's does in a workspace that has run `license`.
+            addLicenseCheckToLintTarget(tree, projectName);
+        }
+        await realignProviders(tree, projectName, project.root, nextSteps);
+    }
+    await formatFilesInSubtree(tree);
+    return {
+        nextSteps
+    };
+}
+
+//# sourceMappingURL=migration.js.map

package/src/migrations/latest/terraform-fmt-check/migration.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../packages/nx-plugin/src/migrations/latest/terraform-fmt-check/migration.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport {\n  getProjects,\n  joinPathFragments,\n  type MigrationReturnObject,\n  type ProjectConfiguration,\n  type Tree,\n  updateProjectConfiguration,\n} from '@nx/devkit';\nimport { addLicenseCheckToLintTarget } from '../../../license/config.js';\nimport {\n  TERRAFORM_FORMAT_TARGET,\n  TERRAFORM_PROJECT_GENERATOR_INFO,\n} from '../../../terraform/project/generator.js';\nimport { applyGritQL } from '../../../utils/ast.js';\nimport { formatFilesInSubtree } from '../../../utils/format.js';\nimport { sortObjectKeys } from '../../../utils/object.js';\n\n/**\n * Converges a Terraform project's format target on the shape ts and py projects\n * carry: a `format` target that checks, a `fix` configuration that writes, and a\n * `lint` target orchestrating it so `run-many --target lint` reaches Terraform\n * projects with its `fix` and `skip-lint` configurations propagating.\n *\n * The target was named `fmt` and ran `terraform fmt`, which rewrites the files it\n * reads. Those files are its own declared `inputs`, so every run changed the hash\n * it had just been computed from and it could never cache-hit — Nx reported it\n * flaky on every build. That per-run write is also what kept the vended\n * `providers.tf` backend block aligned, so this realigns it.\n */\n\n/** The command the base target ran before it checked rather than wrote. */\nconst WRITING_COMMAND = 'terraform fmt';\n\n/**\n * The `backend \"s3\"` arguments the generator vends. Realignment only applies to a\n * block holding exactly these.\n */\nconst BACKEND_ARGUMENTS = ['encrypt', 'use_lockfile'];\n\n/** Matches the arguments of a `backend \"s3\"` block, and their alignment. */\nconst BACKEND_BLOCK = /backend\\s+\"s3\"\\s*\\{([^}]*)\\}/;\nconst BACKEND_ARGUMENT = /^[ \\t]*([A-Za-z_][A-Za-z0-9_]*)([ \\t]*)=/gm;\n\n/**\n * The arguments a `providers.tf` declares in its `backend \"s3\"` block, in order,\n * each with the column its `=` currently sits at.\n */\nconst readBackendArguments = (\n  contents: string,\n): { name: string; column: number }[] | undefined => {\n  const block = BACKEND_BLOCK.exec(contents)?.[1];\n  if (block === undefined) return undefined;\n  return [...block.matchAll(BACKEND_ARGUMENT)].map(([, name, gap]) => ({\n    name,\n    column: name.length + gap.length,\n  }));\n};\n\n/**\n * Realigns the `backend \"s3\"` arguments in an application's `providers.tf`, which\n * the checking target requires and the per-run write had been supplying.\n *\n * `terraform fmt` aligns `=` to the widest key in the whole block, so a block\n * carrying arguments beyond the two vended ones has a width this cannot know.\n * Such a block is left alone and reported: rewriting it to the vended width\n * would push those two out of alignment with the user's own arguments and fail\n * the very check this migration installs.\n */\nconst realignProviders = async (\n  tree: Tree,\n  projectName: string,\n  projectRoot: string,\n  nextSteps: string[],\n): Promise<void> => {\n  const filePath = joinPathFragments(projectRoot, 'src', 'providers.tf');\n  if (!tree.exists(filePath)) return;\n\n  const declared = readBackendArguments(tree.read(filePath, 'utf-8') ?? '');\n  if (!declared?.length) return;\n\n  const isVendedBlock =\n    declared.length === BACKEND_ARGUMENTS.length &&\n    declared.every(({ name }) => BACKEND_ARGUMENTS.includes(name));\n  if (!isVendedBlock) {\n    nextSteps.push(\n      `${filePath}: its \\`backend \"s3\"\\` block declares arguments beyond the generated ones, so its alignment was left as it is. Run \\`nx run ${projectName}:format --configuration=fix\\` if the new format check reports it.`,\n    );\n    return;\n  }\n\n  const width = Math.max(...BACKEND_ARGUMENTS.map((name) => name.length));\n\n  // Already at the width `terraform fmt` aligns this block to, so a re-run — and\n  // a workspace whose file is formatted — is a no-op.\n  if (declared.every(({ column }) => column === width)) return;\n\n  // Each argument is realigned around whatever value it holds, so a value the\n  // user changed is preserved. An argument whose name already fills the width\n  // rewrites to a textually identical pattern, which GritQL notes; the rewrite\n  // still normalises the whitespace around its `=`, which is the point.\n  for (const { name } of declared) {\n    await applyGritQL(\n      tree,\n      filePath,\n      `language hcl\\n\\`${name} = $value\\` => \\`${name.padEnd(width)} = $value\\`` +\n        ` where { $value <: within \\`backend \"s3\" { $_ }\\` }`,\n    );\n  }\n};\n\n/** The target name this migration converges on, matching ts and py projects. */\nconst FORMAT_TARGET = 'format';\n/** The name the generator vended this target under before the rename. */\nconst LEGACY_TARGET = 'fmt';\n\n/**\n * Repoints `dependsOn` entries naming the old target at the new one. A stale\n * entry is not an error in Nx — it silently drops the edge — so `build` would\n * stop checking formatting altogether.\n */\nconst repointDependsOn = (project: ProjectConfiguration): boolean => {\n  let changed = false;\n  for (const target of Object.values(project.targets ?? {})) {\n    const dependsOn = target.dependsOn;\n    if (!Array.isArray(dependsOn) || !dependsOn.includes(LEGACY_TARGET)) {\n      continue;\n    }\n    target.dependsOn = dependsOn.map((entry) =>\n      entry === LEGACY_TARGET ? FORMAT_TARGET : entry,\n    );\n    changed = true;\n  }\n  return changed;\n};\n\n/**\n * Renames the `fmt` target to `format`, moves it onto the checking form, and\n * adds the `lint` target that orchestrates it.\n *\n * A target whose command is not the one the generator produced is the user's, so\n * it is reported instead. Both the vended name and the new one are accepted as\n * the starting point, so a workspace part-way through converges either way.\n */\nconst migrateProject = (\n  projectName: string,\n  project: ProjectConfiguration,\n  nextSteps: string[],\n): boolean => {\n  const targets = project.targets ?? {};\n  const existingName = targets[FORMAT_TARGET]\n    ? FORMAT_TARGET\n    : targets[LEGACY_TARGET]\n      ? LEGACY_TARGET\n      : undefined;\n  if (!existingName) return false;\n\n  const format = targets[existingName];\n  let changed = false;\n\n  if (format.options?.command === WRITING_COMMAND) {\n    targets[existingName] = {\n      ...format,\n      inputs: TERRAFORM_FORMAT_TARGET.inputs,\n      options: {\n        ...format.options,\n        command: TERRAFORM_FORMAT_TARGET.options.command,\n      },\n      // The user's own configurations win, as their `options` do above: someone\n      // who set `fix` to `terraform fmt -recursive` to cover nested modules\n      // keeps it.\n      configurations: {\n        ...TERRAFORM_FORMAT_TARGET.configurations,\n        ...format.configurations,\n      },\n    };\n    changed = true;\n  } else if (!format.configurations?.fix) {\n    nextSteps.push(\n      `${projectName}: its '${existingName}' target has been customised, so it was left as it is. Have it run \\`${TERRAFORM_FORMAT_TARGET.options.command}\\` and move the writing form to a 'fix' configuration — writing from the base target rewrites the inputs its cache key is computed from, so it can never cache-hit.`,\n    );\n    return false;\n  }\n\n  if (existingName === LEGACY_TARGET) {\n    targets[FORMAT_TARGET] = targets[LEGACY_TARGET];\n    delete targets[LEGACY_TARGET];\n    changed = true;\n  }\n\n  changed = repointDependsOn(project) || changed;\n\n  if (!targets.lint) {\n    targets.lint = { dependsOn: [FORMAT_TARGET] };\n    changed = true;\n  }\n\n  return changed;\n};\n\nexport default async function migration(\n  tree: Tree,\n): Promise<MigrationReturnObject> {\n  const nextSteps: string[] = [];\n\n  for (const [projectName, project] of getProjects(tree)) {\n    const generator = (project.metadata as { generator?: string } | undefined)\n      ?.generator;\n    if (generator !== TERRAFORM_PROJECT_GENERATOR_INFO.id) continue;\n\n    if (migrateProject(projectName, project, nextSteps)) {\n      updateProjectConfiguration(tree, projectName, {\n        ...project,\n        targets: sortObjectKeys(project.targets),\n      });\n      // The new `lint` target checks licenses alongside formatting, as every\n      // other linting project's does in a workspace that has run `license`.\n      addLicenseCheckToLintTarget(tree, projectName);\n    }\n\n    await realignProviders(tree, projectName, project.root, nextSteps);\n  }\n\n  await formatFilesInSubtree(tree);\n\n  return { nextSteps };\n}\n"],"names":["getProjects","joinPathFragments","updateProjectConfiguration","addLicenseCheckToLintTarget","TERRAFORM_FORMAT_TARGET","TERRAFORM_PROJECT_GENERATOR_INFO","applyGritQL","formatFilesInSubtree","sortObjectKeys","WRITING_COMMAND","BACKEND_ARGUMENTS","BACKEND_BLOCK","BACKEND_ARGUMENT","readBackendArguments","contents","block","exec","undefined","matchAll","map","name","gap","column","length","realignProviders","tree","projectName","projectRoot","nextSteps","filePath","exists","declared","read","isVendedBlock","every","includes","push","width","Math","max","padEnd","FORMAT_TARGET","LEGACY_TARGET","repointDependsOn","project","changed","target","Object","values","targets","dependsOn","Array","isArray","entry","migrateProject","existingName","format","options","command","inputs","configurations","fix","lint","migration","generator","metadata","id","root"],"mappings":"AAAA;;;CAGC,GACD,SACEA,WAAW,EACXC,iBAAiB,EAIjBC,0BAA0B,QACrB,aAAa;AACpB,SAASC,2BAA2B,QAAQ,6BAA6B;AACzE,SACEC,uBAAuB,EACvBC,gCAAgC,QAC3B,0CAA0C;AACjD,SAASC,WAAW,QAAQ,wBAAwB;AACpD,SAASC,oBAAoB,QAAQ,2BAA2B;AAChE,SAASC,cAAc,QAAQ,2BAA2B;AAE1D;;;;;;;;;;;CAWC,GAED,yEAAyE,GACzE,MAAMC,kBAAkB;AAExB;;;CAGC,GACD,MAAMC,oBAAoB;IAAC;IAAW;CAAe;AAErD,0EAA0E,GAC1E,MAAMC,gBAAgB;AACtB,MAAMC,mBAAmB;AAEzB;;;CAGC,GACD,MAAMC,uBAAuB,CAC3BC;IAEA,MAAMC,QAAQJ,cAAcK,IAAI,CAACF,WAAW,CAAC,EAAE;IAC/C,IAAIC,UAAUE,WAAW,OAAOA;IAChC,OAAO;WAAIF,MAAMG,QAAQ,CAACN;KAAkB,CAACO,GAAG,CAAC,CAAC,GAAGC,MAAMC,IAAI,GAAM,CAAA;YACnED;YACAE,QAAQF,KAAKG,MAAM,GAAGF,IAAIE,MAAM;QAClC,CAAA;AACF;AAEA;;;;;;;;;CASC,GACD,MAAMC,mBAAmB,OACvBC,MACAC,aACAC,aACAC;IAEA,MAAMC,WAAW5B,kBAAkB0B,aAAa,OAAO;IACvD,IAAI,CAACF,KAAKK,MAAM,CAACD,WAAW;IAE5B,MAAME,WAAWlB,qBAAqBY,KAAKO,IAAI,CAACH,UAAU,YAAY;IACtE,IAAI,CAACE,UAAUR,QAAQ;IAEvB,MAAMU,gBACJF,SAASR,MAAM,KAAKb,kBAAkBa,MAAM,IAC5CQ,SAASG,KAAK,CAAC,CAAC,EAAEd,IAAI,EAAE,GAAKV,kBAAkByB,QAAQ,CAACf;IAC1D,IAAI,CAACa,eAAe;QAClBL,UAAUQ,IAAI,CACZ,GAAGP,SAAS,4HAA4H,EAAEH,YAAY,iEAAiE,CAAC;QAE1N;IACF;IAEA,MAAMW,QAAQC,KAAKC,GAAG,IAAI7B,kBAAkBS,GAAG,CAAC,CAACC,OAASA,KAAKG,MAAM;IAErE,+EAA+E;IAC/E,oDAAoD;IACpD,IAAIQ,SAASG,KAAK,CAAC,CAAC,EAAEZ,MAAM,EAAE,GAAKA,WAAWe,QAAQ;IAEtD,4EAA4E;IAC5E,4EAA4E;IAC5E,6EAA6E;IAC7E,sEAAsE;IACtE,KAAK,MAAM,EAAEjB,IAAI,EAAE,IAAIW,SAAU;QAC/B,MAAMzB,YACJmB,MACAI,UACA,CAAC,gBAAgB,EAAET,KAAK,iBAAiB,EAAEA,KAAKoB,MAAM,CAACH,OAAO,WAAW,CAAC,GACxE,CAAC,mDAAmD,CAAC;IAE3D;AACF;AAEA,8EAA8E,GAC9E,MAAMI,gBAAgB;AACtB,uEAAuE,GACvE,MAAMC,gBAAgB;AAEtB;;;;CAIC,GACD,MAAMC,mBAAmB,CAACC;IACxB,IAAIC,UAAU;IACd,KAAK,MAAMC,UAAUC,OAAOC,MAAM,CAACJ,QAAQK,OAAO,IAAI,CAAC,GAAI;QACzD,MAAMC,YAAYJ,OAAOI,SAAS;QAClC,IAAI,CAACC,MAAMC,OAAO,CAACF,cAAc,CAACA,UAAUf,QAAQ,CAACO,gBAAgB;YACnE;QACF;QACAI,OAAOI,SAAS,GAAGA,UAAU/B,GAAG,CAAC,CAACkC,QAChCA,UAAUX,gBAAgBD,gBAAgBY;QAE5CR,UAAU;IACZ;IACA,OAAOA;AACT;AAEA;;;;;;;CAOC,GACD,MAAMS,iBAAiB,CACrB5B,aACAkB,SACAhB;IAEA,MAAMqB,UAAUL,QAAQK,OAAO,IAAI,CAAC;IACpC,MAAMM,eAAeN,OAAO,CAACR,cAAc,GACvCA,gBACAQ,OAAO,CAACP,cAAc,GACpBA,gBACAzB;IACN,IAAI,CAACsC,cAAc,OAAO;IAE1B,MAAMC,SAASP,OAAO,CAACM,aAAa;IACpC,IAAIV,UAAU;IAEd,IAAIW,OAAOC,OAAO,EAAEC,YAAYjD,iBAAiB;QAC/CwC,OAAO,CAACM,aAAa,GAAG;YACtB,GAAGC,MAAM;YACTG,QAAQvD,wBAAwBuD,MAAM;YACtCF,SAAS;gBACP,GAAGD,OAAOC,OAAO;gBACjBC,SAAStD,wBAAwBqD,OAAO,CAACC,OAAO;YAClD;YACA,0EAA0E;YAC1E,sEAAsE;YACtE,YAAY;YACZE,gBAAgB;gBACd,GAAGxD,wBAAwBwD,cAAc;gBACzC,GAAGJ,OAAOI,cAAc;YAC1B;QACF;QACAf,UAAU;IACZ,OAAO,IAAI,CAACW,OAAOI,cAAc,EAAEC,KAAK;QACtCjC,UAAUQ,IAAI,CACZ,GAAGV,YAAY,OAAO,EAAE6B,aAAa,qEAAqE,EAAEnD,wBAAwBqD,OAAO,CAACC,OAAO,CAAC,mKAAmK,CAAC;QAE1T,OAAO;IACT;IAEA,IAAIH,iBAAiBb,eAAe;QAClCO,OAAO,CAACR,cAAc,GAAGQ,OAAO,CAACP,cAAc;QAC/C,OAAOO,OAAO,CAACP,cAAc;QAC7BG,UAAU;IACZ;IAEAA,UAAUF,iBAAiBC,YAAYC;IAEvC,IAAI,CAACI,QAAQa,IAAI,EAAE;QACjBb,QAAQa,IAAI,GAAG;YAAEZ,WAAW;gBAACT;aAAc;QAAC;QAC5CI,UAAU;IACZ;IAEA,OAAOA;AACT;AAEA,eAAe,eAAekB,UAC5BtC,IAAU;IAEV,MAAMG,YAAsB,EAAE;IAE9B,KAAK,MAAM,CAACF,aAAakB,QAAQ,IAAI5C,YAAYyB,MAAO;QACtD,MAAMuC,YAAapB,QAAQqB,QAAQ,EAC/BD;QACJ,IAAIA,cAAc3D,iCAAiC6D,EAAE,EAAE;QAEvD,IAAIZ,eAAe5B,aAAakB,SAAShB,YAAY;YACnD1B,2BAA2BuB,MAAMC,aAAa;gBAC5C,GAAGkB,OAAO;gBACVK,SAASzC,eAAeoC,QAAQK,OAAO;YACzC;YACA,uEAAuE;YACvE,sEAAsE;YACtE9C,4BAA4BsB,MAAMC;QACpC;QAEA,MAAMF,iBAAiBC,MAAMC,aAAakB,QAAQuB,IAAI,EAAEvC;IAC1D;IAEA,MAAMrB,qBAAqBkB;IAE3B,OAAO;QAAEG;IAAU;AACrB"}

package/src/migrations/latest/terraform-provider-plugin-cache/metadata.json

@@ -0,0 +1,3 @@
+{
+  "description": "Share Terraform provider downloads across terraform init targets via TF_PLUGIN_CACHE_DIR"
+}

package/src/migrations/latest/terraform-provider-plugin-cache/migration.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { type MigrationReturnObject, type Tree } from '@nx/devkit';
+export default function migration(tree: Tree): Promise<MigrationReturnObject>;

package/src/migrations/latest/terraform-provider-plugin-cache/migration.js

@@ -0,0 +1,164 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ import { generateFiles, getProjects, joinPathFragments, OverwriteStrategy, updateProjectConfiguration } from "@nx/devkit";
+import { relative } from "path";
+import { TERRAFORM_PROJECT_GENERATOR_INFO } from "../../../terraform/project/generator.js";
+import { addDestructuredImport, applyGritQL, matchGritQL } from "../../../utils/ast.js";
+import { formatFilesInSubtree } from "../../../utils/format.js";
+import { kebabCase } from "../../../utils/names.js";
+/**
+ * Terraform projects share their provider downloads through
+ * `TF_PLUGIN_CACHE_DIR`, so a `terraform init` whose `.terraform` was cleaned
+ * links the providers already on disk instead of re-downloading them. The AWS
+ * provider alone is several hundred megabytes, which dominated the `test`
+ * target's runtime on every cache miss.
+ *
+ * The cache lives under the already-gitignored `.terraform` at the workspace
+ * root, one directory per project. Terraform reports an error and silently falls
+ * back to downloading when the directory does not exist, so each target creates
+ * it first, and the vended `init` script gets an `env` helper that does the same.
+ *
+ * A directory per project rather than one shared: two `terraform init` runs
+ * filling one cache concurrently each compute a different hash for the same
+ * provider, and terraform then rejects the mismatch against the lock file.
+ *
+ * Nx does not interpolate `{workspaceRoot}` inside `env`, so the value is
+ * relative to the target's own `cwd` of `{projectRoot}/src`.
+ */ const TF_PLUGIN_CACHE_DIR = 'TF_PLUGIN_CACHE_DIR';
+const divergedStep = (projectName, targetName)=>`${projectName}: its '${targetName}' target no longer matches the shape the generator produced - left untouched. To reuse provider downloads, set the \`TF_PLUGIN_CACHE_DIR\` env var to \`.terraform/plugin-cache/<projectRoot>\` under the workspace root (relative to the target's \`cwd\`), creating that directory before \`terraform init\` runs.`;
+/** Path to this project's cache from a target running in `{projectRoot}/src`. */ const pluginCacheDirFor = (projectRoot)=>joinPathFragments(relative(joinPathFragments(projectRoot, 'src'), '.') || '.', '.terraform', 'plugin-cache', '{projectRoot}').replace(/\\/g, '/');
+/** Whether a target already runs the command, however it is expressed. */ const hasCommand = (commands, predicate)=>Array.isArray(commands) && commands.some((c)=>{
+        const command = typeof c === 'string' ? c : c?.command;
+        return typeof command === 'string' && predicate(command);
+    });
+/**
+ * Prepend the `make-dir` that creates the cache directory. `forwardAllArgs` is
+ * off for it alone, so args meant for `terraform` are not passed to `make-dir`.
+ */ const withMakeDir = (commands, pluginCacheDir)=>[
+        {
+            command: `make-dir ${pluginCacheDir}`,
+            forwardAllArgs: false
+        },
+        ...commands
+    ];
+/**
+ * The `terraform init` call in the vended `init` script, matched structurally so
+ * formatting and argument layout don't affect whether it is recognised.
+ */ const INIT_CALL = "`execFileSync('terraform', [$args], { cwd: srcDir, stdio: 'inherit' })`";
+const INIT_CALL_WITH_ENV = "`execFileSync('terraform', [$args], { cwd: srcDir, stdio: 'inherit', env: pluginCacheEnv(projectRootRel) })`";
+const divergedScriptStep = (filePath)=>`${filePath}: its \`terraform init\` call no longer matches the shape the generator produced - left untouched. Pass \`env: pluginCacheEnv(projectRootRel)\` to that \`execFileSync\` so it shares the provider cache in \`scripts/env.ts\`.`;
+/**
+ * Route the vended `init` script's `terraform init` through the shared cache.
+ *
+ * Guarded on the helper not already being imported, so a re-run — and a project
+ * generated with the cache — is a no-op.
+ */ const migrateInitScript = async (tree, filePath, nextSteps)=>{
+    if (!tree.exists(filePath)) return;
+    if (await matchGritQL(tree, filePath, '`pluginCacheEnv($_)`')) return;
+    if (!await matchGritQL(tree, filePath, INIT_CALL)) {
+        nextSteps.push(divergedScriptStep(filePath));
+        return;
+    }
+    await applyGritQL(tree, filePath, `${INIT_CALL} => ${INIT_CALL_WITH_ENV}`);
+    // Placed in the generator's import position rather than prepended, so a
+    // migrated workspace matches a freshly generated one.
+    const awsConfigImport = "`import { resolveAwsConfig } from './aws-config'`";
+    if (await matchGritQL(tree, filePath, awsConfigImport)) {
+        await applyGritQL(tree, filePath, `${awsConfigImport} => \`import { resolveAwsConfig } from './aws-config';\nimport { pluginCacheEnv } from './env'\``);
+    } else {
+        await addDestructuredImport(tree, filePath, [
+            'pluginCacheEnv'
+        ], './env');
+    }
+};
+export default async function migration(tree) {
+    const nextSteps = [];
+    for (const [projectName, project] of getProjects(tree)){
+        const generator = project.metadata?.generator;
+        if (generator !== TERRAFORM_PROJECT_GENERATOR_INFO.id) continue;
+        const targets = project.targets ?? {};
+        const pluginCacheDir = pluginCacheDirFor(project.root);
+        let changed = false;
+        /**
+     * Wire the cache into a target that runs `terraform init`. Only the exact
+     * shape the generator produced is rewritten; anything else is the user's and
+     * is reported instead. Guarded on the env var being absent, so a re-run —
+     * and a project already generated with the cache — is a no-op.
+     */ const migrateTarget = (targetName, target, /** Where the commands live: on the target, or under a configuration. */ commandsHolder, env)=>{
+            if (!target) return;
+            if (env?.[TF_PLUGIN_CACHE_DIR]) return;
+            if (!hasCommand(commandsHolder.commands, (c)=>c.includes('terraform init'))) {
+                nextSteps.push(divergedStep(projectName, targetName));
+                return;
+            }
+            commandsHolder.commands = withMakeDir(commandsHolder.commands, pluginCacheDir);
+            target.options = {
+                ...target.options,
+                parallel: false,
+                env: {
+                    ...target.options?.env,
+                    [TF_PLUGIN_CACHE_DIR]: pluginCacheDir
+                }
+            };
+            changed = true;
+        };
+        // `test` carries its `terraform init -backend=false` on the target itself.
+        const test = targets.test;
+        if (test?.options) {
+            const wasMigrated = test.options.env?.[TF_PLUGIN_CACHE_DIR] !== undefined;
+            migrateTarget('test', test, test.options, test.options.env);
+            // The data dir becomes symlinks into the shared cache, so it is no longer
+            // a self-contained artifact worth restoring on another machine. Only the
+            // exact output the generator declared is dropped.
+            if (!wasMigrated && test.outputs?.length === 1 && test.outputs[0] === '{workspaceRoot}/dist/{projectRoot}/terraform-test') {
+                test.outputs = [];
+                changed = true;
+            }
+        }
+        // `init` carries its command under the `dev` configuration. A library's
+        // runs `terraform init` directly; an application's delegates to the vended
+        // script, which reads the cache from its own helper rather than the target.
+        const init = targets.init;
+        const initDev = init?.configurations?.dev;
+        if (init?.options && initDev) {
+            const isScriptDriven = hasCommand(initDev.commands ?? init.options.commands, (c)=>c.includes('scripts/init.ts'));
+            if (!isScriptDriven) {
+                // The pre-fix generator vended a single `command`; normalise it to the
+                // `commands` array `make-dir` has to be prepended to.
+                if (typeof initDev.command === 'string' && !initDev.commands) {
+                    initDev.commands = [
+                        initDev.command
+                    ];
+                    delete initDev.command;
+                }
+                migrateTarget('init', init, initDev, init.options.env);
+            }
+        }
+        if (changed) {
+            updateProjectConfiguration(tree, projectName, {
+                ...project,
+                targets
+            });
+        }
+        // An application's `init` target runs `terraform init` from the vended
+        // script rather than the target, so the cache reaches it via the `env`
+        // helper. The helper is new, so KeepExisting adds it while leaving a user's
+        // own copy alone; the script that calls it already exists, so it is
+        // rewritten below.
+        if (tree.exists(joinPathFragments(project.root, 'bootstrap'))) {
+            generateFiles(tree, joinPathFragments(import.meta.dirname, '../../../terraform/project/files/application/scripts'), joinPathFragments(project.root, 'scripts'), {
+                stateKeyPrefix: kebabCase(projectName)
+            }, {
+                overwriteStrategy: OverwriteStrategy.KeepExisting
+            });
+            await migrateInitScript(tree, joinPathFragments(project.root, 'scripts', 'init.ts'), nextSteps);
+        }
+    }
+    await formatFilesInSubtree(tree);
+    return {
+        nextSteps
+    };
+}
+
+//# sourceMappingURL=migration.js.map

package/src/migrations/latest/terraform-provider-plugin-cache/migration.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../packages/nx-plugin/src/migrations/latest/terraform-provider-plugin-cache/migration.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport {\n  generateFiles,\n  getProjects,\n  joinPathFragments,\n  type MigrationReturnObject,\n  OverwriteStrategy,\n  type TargetConfiguration,\n  type Tree,\n  updateProjectConfiguration,\n} from '@nx/devkit';\nimport { relative } from 'path';\nimport { TERRAFORM_PROJECT_GENERATOR_INFO } from '../../../terraform/project/generator.js';\nimport {\n  addDestructuredImport,\n  applyGritQL,\n  matchGritQL,\n} from '../../../utils/ast.js';\nimport { formatFilesInSubtree } from '../../../utils/format.js';\nimport { kebabCase } from '../../../utils/names.js';\n\n/**\n * Terraform projects share their provider downloads through\n * `TF_PLUGIN_CACHE_DIR`, so a `terraform init` whose `.terraform` was cleaned\n * links the providers already on disk instead of re-downloading them. The AWS\n * provider alone is several hundred megabytes, which dominated the `test`\n * target's runtime on every cache miss.\n *\n * The cache lives under the already-gitignored `.terraform` at the workspace\n * root, one directory per project. Terraform reports an error and silently falls\n * back to downloading when the directory does not exist, so each target creates\n * it first, and the vended `init` script gets an `env` helper that does the same.\n *\n * A directory per project rather than one shared: two `terraform init` runs\n * filling one cache concurrently each compute a different hash for the same\n * provider, and terraform then rejects the mismatch against the lock file.\n *\n * Nx does not interpolate `{workspaceRoot}` inside `env`, so the value is\n * relative to the target's own `cwd` of `{projectRoot}/src`.\n */\n\nconst TF_PLUGIN_CACHE_DIR = 'TF_PLUGIN_CACHE_DIR';\n\nconst divergedStep = (projectName: string, targetName: string) =>\n  `${projectName}: its '${targetName}' target no longer matches the shape the generator produced - left untouched. To reuse provider downloads, set the \\`TF_PLUGIN_CACHE_DIR\\` env var to \\`.terraform/plugin-cache/<projectRoot>\\` under the workspace root (relative to the target's \\`cwd\\`), creating that directory before \\`terraform init\\` runs.`;\n\n/** Path to this project's cache from a target running in `{projectRoot}/src`. */\nconst pluginCacheDirFor = (projectRoot: string) =>\n  joinPathFragments(\n    relative(joinPathFragments(projectRoot, 'src'), '.') || '.',\n    '.terraform',\n    'plugin-cache',\n    '{projectRoot}',\n  ).replace(/\\\\/g, '/');\n\n/** Whether a target already runs the command, however it is expressed. */\nconst hasCommand = (\n  commands: unknown,\n  predicate: (command: string) => boolean,\n): boolean =>\n  Array.isArray(commands) &&\n  commands.some((c) => {\n    const command = typeof c === 'string' ? c : (c?.command as string);\n    return typeof command === 'string' && predicate(command);\n  });\n\n/**\n * Prepend the `make-dir` that creates the cache directory. `forwardAllArgs` is\n * off for it alone, so args meant for `terraform` are not passed to `make-dir`.\n */\nconst withMakeDir = (commands: unknown[], pluginCacheDir: string) => [\n  { command: `make-dir ${pluginCacheDir}`, forwardAllArgs: false },\n  ...commands,\n];\n\n/**\n * The `terraform init` call in the vended `init` script, matched structurally so\n * formatting and argument layout don't affect whether it is recognised.\n */\nconst INIT_CALL =\n  \"`execFileSync('terraform', [$args], { cwd: srcDir, stdio: 'inherit' })`\";\nconst INIT_CALL_WITH_ENV =\n  \"`execFileSync('terraform', [$args], { cwd: srcDir, stdio: 'inherit', env: pluginCacheEnv(projectRootRel) })`\";\n\nconst divergedScriptStep = (filePath: string) =>\n  `${filePath}: its \\`terraform init\\` call no longer matches the shape the generator produced - left untouched. Pass \\`env: pluginCacheEnv(projectRootRel)\\` to that \\`execFileSync\\` so it shares the provider cache in \\`scripts/env.ts\\`.`;\n\n/**\n * Route the vended `init` script's `terraform init` through the shared cache.\n *\n * Guarded on the helper not already being imported, so a re-run — and a project\n * generated with the cache — is a no-op.\n */\nconst migrateInitScript = async (\n  tree: Tree,\n  filePath: string,\n  nextSteps: string[],\n): Promise<void> => {\n  if (!tree.exists(filePath)) return;\n  if (await matchGritQL(tree, filePath, '`pluginCacheEnv($_)`')) return;\n\n  if (!(await matchGritQL(tree, filePath, INIT_CALL))) {\n    nextSteps.push(divergedScriptStep(filePath));\n    return;\n  }\n\n  await applyGritQL(tree, filePath, `${INIT_CALL} => ${INIT_CALL_WITH_ENV}`);\n\n  // Placed in the generator's import position rather than prepended, so a\n  // migrated workspace matches a freshly generated one.\n  const awsConfigImport = \"`import { resolveAwsConfig } from './aws-config'`\";\n  if (await matchGritQL(tree, filePath, awsConfigImport)) {\n    await applyGritQL(\n      tree,\n      filePath,\n      `${awsConfigImport} => \\`import { resolveAwsConfig } from './aws-config';\\nimport { pluginCacheEnv } from './env'\\``,\n    );\n  } else {\n    await addDestructuredImport(tree, filePath, ['pluginCacheEnv'], './env');\n  }\n};\n\nexport default async function migration(\n  tree: Tree,\n): Promise<MigrationReturnObject> {\n  const nextSteps: string[] = [];\n\n  for (const [projectName, project] of getProjects(tree)) {\n    const generator = (project.metadata as { generator?: string } | undefined)\n      ?.generator;\n    if (generator !== TERRAFORM_PROJECT_GENERATOR_INFO.id) continue;\n\n    const targets = project.targets ?? {};\n    const pluginCacheDir = pluginCacheDirFor(project.root);\n    let changed = false;\n\n    /**\n     * Wire the cache into a target that runs `terraform init`. Only the exact\n     * shape the generator produced is rewritten; anything else is the user's and\n     * is reported instead. Guarded on the env var being absent, so a re-run —\n     * and a project already generated with the cache — is a no-op.\n     */\n    const migrateTarget = (\n      targetName: string,\n      target: TargetConfiguration | undefined,\n      /** Where the commands live: on the target, or under a configuration. */\n      commandsHolder: { commands?: unknown; env?: Record<string, string> },\n      env: Record<string, string> | undefined,\n    ) => {\n      if (!target) return;\n      if (env?.[TF_PLUGIN_CACHE_DIR]) return;\n\n      if (\n        !hasCommand(commandsHolder.commands, (c) =>\n          c.includes('terraform init'),\n        )\n      ) {\n        nextSteps.push(divergedStep(projectName, targetName));\n        return;\n      }\n\n      commandsHolder.commands = withMakeDir(\n        commandsHolder.commands as unknown[],\n        pluginCacheDir,\n      );\n      target.options = {\n        ...target.options,\n        parallel: false,\n        env: { ...target.options?.env, [TF_PLUGIN_CACHE_DIR]: pluginCacheDir },\n      };\n      changed = true;\n    };\n\n    // `test` carries its `terraform init -backend=false` on the target itself.\n    const test = targets.test;\n    if (test?.options) {\n      const wasMigrated = test.options.env?.[TF_PLUGIN_CACHE_DIR] !== undefined;\n      migrateTarget('test', test, test.options, test.options.env);\n\n      // The data dir becomes symlinks into the shared cache, so it is no longer\n      // a self-contained artifact worth restoring on another machine. Only the\n      // exact output the generator declared is dropped.\n      if (\n        !wasMigrated &&\n        test.outputs?.length === 1 &&\n        test.outputs[0] === '{workspaceRoot}/dist/{projectRoot}/terraform-test'\n      ) {\n        test.outputs = [];\n        changed = true;\n      }\n    }\n\n    // `init` carries its command under the `dev` configuration. A library's\n    // runs `terraform init` directly; an application's delegates to the vended\n    // script, which reads the cache from its own helper rather than the target.\n    const init = targets.init;\n    const initDev = init?.configurations?.dev;\n    if (init?.options && initDev) {\n      const isScriptDriven = hasCommand(\n        initDev.commands ?? init.options.commands,\n        (c) => c.includes('scripts/init.ts'),\n      );\n      if (!isScriptDriven) {\n        // The pre-fix generator vended a single `command`; normalise it to the\n        // `commands` array `make-dir` has to be prepended to.\n        if (typeof initDev.command === 'string' && !initDev.commands) {\n          initDev.commands = [initDev.command];\n          delete initDev.command;\n        }\n        migrateTarget('init', init, initDev, init.options.env);\n      }\n    }\n\n    if (changed) {\n      updateProjectConfiguration(tree, projectName, { ...project, targets });\n    }\n\n    // An application's `init` target runs `terraform init` from the vended\n    // script rather than the target, so the cache reaches it via the `env`\n    // helper. The helper is new, so KeepExisting adds it while leaving a user's\n    // own copy alone; the script that calls it already exists, so it is\n    // rewritten below.\n    if (tree.exists(joinPathFragments(project.root, 'bootstrap'))) {\n      generateFiles(\n        tree,\n        joinPathFragments(\n          import.meta.dirname,\n          '../../../terraform/project/files/application/scripts',\n        ),\n        joinPathFragments(project.root, 'scripts'),\n        { stateKeyPrefix: kebabCase(projectName) },\n        { overwriteStrategy: OverwriteStrategy.KeepExisting },\n      );\n\n      await migrateInitScript(\n        tree,\n        joinPathFragments(project.root, 'scripts', 'init.ts'),\n        nextSteps,\n      );\n    }\n  }\n\n  await formatFilesInSubtree(tree);\n\n  return { nextSteps };\n}\n"],"names":["generateFiles","getProjects","joinPathFragments","OverwriteStrategy","updateProjectConfiguration","relative","TERRAFORM_PROJECT_GENERATOR_INFO","addDestructuredImport","applyGritQL","matchGritQL","formatFilesInSubtree","kebabCase","TF_PLUGIN_CACHE_DIR","divergedStep","projectName","targetName","pluginCacheDirFor","projectRoot","replace","hasCommand","commands","predicate","Array","isArray","some","c","command","withMakeDir","pluginCacheDir","forwardAllArgs","INIT_CALL","INIT_CALL_WITH_ENV","divergedScriptStep","filePath","migrateInitScript","tree","nextSteps","exists","push","awsConfigImport","migration","project","generator","metadata","id","targets","root","changed","migrateTarget","target","commandsHolder","env","includes","options","parallel","test","wasMigrated","undefined","outputs","length","init","initDev","configurations","dev","isScriptDriven","dirname","stateKeyPrefix","overwriteStrategy","KeepExisting"],"mappings":"AAAA;;;CAGC,GACD,SACEA,aAAa,EACbC,WAAW,EACXC,iBAAiB,EAEjBC,iBAAiB,EAGjBC,0BAA0B,QACrB,aAAa;AACpB,SAASC,QAAQ,QAAQ,OAAO;AAChC,SAASC,gCAAgC,QAAQ,0CAA0C;AAC3F,SACEC,qBAAqB,EACrBC,WAAW,EACXC,WAAW,QACN,wBAAwB;AAC/B,SAASC,oBAAoB,QAAQ,2BAA2B;AAChE,SAASC,SAAS,QAAQ,0BAA0B;AAEpD;;;;;;;;;;;;;;;;;;CAkBC,GAED,MAAMC,sBAAsB;AAE5B,MAAMC,eAAe,CAACC,aAAqBC,aACzC,GAAGD,YAAY,OAAO,EAAEC,WAAW,oTAAoT,CAAC;AAE1V,+EAA+E,GAC/E,MAAMC,oBAAoB,CAACC,cACzBf,kBACEG,SAASH,kBAAkBe,aAAa,QAAQ,QAAQ,KACxD,cACA,gBACA,iBACAC,OAAO,CAAC,OAAO;AAEnB,wEAAwE,GACxE,MAAMC,aAAa,CACjBC,UACAC,YAEAC,MAAMC,OAAO,CAACH,aACdA,SAASI,IAAI,CAAC,CAACC;QACb,MAAMC,UAAU,OAAOD,MAAM,WAAWA,IAAKA,GAAGC;QAChD,OAAO,OAAOA,YAAY,YAAYL,UAAUK;IAClD;AAEF;;;CAGC,GACD,MAAMC,cAAc,CAACP,UAAqBQ,iBAA2B;QACnE;YAAEF,SAAS,CAAC,SAAS,EAAEE,gBAAgB;YAAEC,gBAAgB;QAAM;WAC5DT;KACJ;AAED;;;CAGC,GACD,MAAMU,YACJ;AACF,MAAMC,qBACJ;AAEF,MAAMC,qBAAqB,CAACC,WAC1B,GAAGA,SAAS,+NAA+N,CAAC;AAE9O;;;;;CAKC,GACD,MAAMC,oBAAoB,OACxBC,MACAF,UACAG;IAEA,IAAI,CAACD,KAAKE,MAAM,CAACJ,WAAW;IAC5B,IAAI,MAAMxB,YAAY0B,MAAMF,UAAU,yBAAyB;IAE/D,IAAI,CAAE,MAAMxB,YAAY0B,MAAMF,UAAUH,YAAa;QACnDM,UAAUE,IAAI,CAACN,mBAAmBC;QAClC;IACF;IAEA,MAAMzB,YAAY2B,MAAMF,UAAU,GAAGH,UAAU,IAAI,EAAEC,oBAAoB;IAEzE,wEAAwE;IACxE,sDAAsD;IACtD,MAAMQ,kBAAkB;IACxB,IAAI,MAAM9B,YAAY0B,MAAMF,UAAUM,kBAAkB;QACtD,MAAM/B,YACJ2B,MACAF,UACA,GAAGM,gBAAgB,gGAAgG,CAAC;IAExH,OAAO;QACL,MAAMhC,sBAAsB4B,MAAMF,UAAU;YAAC;SAAiB,EAAE;IAClE;AACF;AAEA,eAAe,eAAeO,UAC5BL,IAAU;IAEV,MAAMC,YAAsB,EAAE;IAE9B,KAAK,MAAM,CAACtB,aAAa2B,QAAQ,IAAIxC,YAAYkC,MAAO;QACtD,MAAMO,YAAaD,QAAQE,QAAQ,EAC/BD;QACJ,IAAIA,cAAcpC,iCAAiCsC,EAAE,EAAE;QAEvD,MAAMC,UAAUJ,QAAQI,OAAO,IAAI,CAAC;QACpC,MAAMjB,iBAAiBZ,kBAAkByB,QAAQK,IAAI;QACrD,IAAIC,UAAU;QAEd;;;;;KAKC,GACD,MAAMC,gBAAgB,CACpBjC,YACAkC,QACA,sEAAsE,GACtEC,gBACAC;YAEA,IAAI,CAACF,QAAQ;YACb,IAAIE,KAAK,CAACvC,oBAAoB,EAAE;YAEhC,IACE,CAACO,WAAW+B,eAAe9B,QAAQ,EAAE,CAACK,IACpCA,EAAE2B,QAAQ,CAAC,oBAEb;gBACAhB,UAAUE,IAAI,CAACzB,aAAaC,aAAaC;gBACzC;YACF;YAEAmC,eAAe9B,QAAQ,GAAGO,YACxBuB,eAAe9B,QAAQ,EACvBQ;YAEFqB,OAAOI,OAAO,GAAG;gBACf,GAAGJ,OAAOI,OAAO;gBACjBC,UAAU;gBACVH,KAAK;oBAAE,GAAGF,OAAOI,OAAO,EAAEF,GAAG;oBAAE,CAACvC,oBAAoB,EAAEgB;gBAAe;YACvE;YACAmB,UAAU;QACZ;QAEA,2EAA2E;QAC3E,MAAMQ,OAAOV,QAAQU,IAAI;QACzB,IAAIA,MAAMF,SAAS;YACjB,MAAMG,cAAcD,KAAKF,OAAO,CAACF,GAAG,EAAE,CAACvC,oBAAoB,KAAK6C;YAChET,cAAc,QAAQO,MAAMA,KAAKF,OAAO,EAAEE,KAAKF,OAAO,CAACF,GAAG;YAE1D,0EAA0E;YAC1E,yEAAyE;YACzE,kDAAkD;YAClD,IACE,CAACK,eACDD,KAAKG,OAAO,EAAEC,WAAW,KACzBJ,KAAKG,OAAO,CAAC,EAAE,KAAK,qDACpB;gBACAH,KAAKG,OAAO,GAAG,EAAE;gBACjBX,UAAU;YACZ;QACF;QAEA,wEAAwE;QACxE,2EAA2E;QAC3E,4EAA4E;QAC5E,MAAMa,OAAOf,QAAQe,IAAI;QACzB,MAAMC,UAAUD,MAAME,gBAAgBC;QACtC,IAAIH,MAAMP,WAAWQ,SAAS;YAC5B,MAAMG,iBAAiB7C,WACrB0C,QAAQzC,QAAQ,IAAIwC,KAAKP,OAAO,CAACjC,QAAQ,EACzC,CAACK,IAAMA,EAAE2B,QAAQ,CAAC;YAEpB,IAAI,CAACY,gBAAgB;gBACnB,uEAAuE;gBACvE,sDAAsD;gBACtD,IAAI,OAAOH,QAAQnC,OAAO,KAAK,YAAY,CAACmC,QAAQzC,QAAQ,EAAE;oBAC5DyC,QAAQzC,QAAQ,GAAG;wBAACyC,QAAQnC,OAAO;qBAAC;oBACpC,OAAOmC,QAAQnC,OAAO;gBACxB;gBACAsB,cAAc,QAAQY,MAAMC,SAASD,KAAKP,OAAO,CAACF,GAAG;YACvD;QACF;QAEA,IAAIJ,SAAS;YACX3C,2BAA2B+B,MAAMrB,aAAa;gBAAE,GAAG2B,OAAO;gBAAEI;YAAQ;QACtE;QAEA,uEAAuE;QACvE,uEAAuE;QACvE,4EAA4E;QAC5E,oEAAoE;QACpE,mBAAmB;QACnB,IAAIV,KAAKE,MAAM,CAACnC,kBAAkBuC,QAAQK,IAAI,EAAE,eAAe;YAC7D9C,cACEmC,MACAjC,kBACE,YAAY+D,OAAO,EACnB,yDAEF/D,kBAAkBuC,QAAQK,IAAI,EAAE,YAChC;gBAAEoB,gBAAgBvD,UAAUG;YAAa,GACzC;gBAAEqD,mBAAmBhE,kBAAkBiE,YAAY;YAAC;YAGtD,MAAMlC,kBACJC,MACAjC,kBAAkBuC,QAAQK,IAAI,EAAE,WAAW,YAC3CV;QAEJ;IACF;IAEA,MAAM1B,qBAAqByB;IAE3B,OAAO;QAAEC;IAAU;AACrB"}

package/src/migrations/latest/vitest-coverage-output-dir/metadata.json

@@ -0,0 +1,3 @@
+{
+  "description": "Write vitest coverage reports to the project's dist directory rather than inside the project"
+}

package/src/migrations/latest/vitest-coverage-output-dir/migration.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { type MigrationReturnObject, type Tree } from '@nx/devkit';
+export default function migration(tree: Tree): Promise<MigrationReturnObject>;

package/src/migrations/latest/vitest-coverage-output-dir/migration.js

@@ -0,0 +1,177 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ import { getProjects, joinPathFragments, updateJson } from "@nx/devkit";
+import { isAbsolute } from "path";
+import { GENERATED_REPORTS_DIRECTORY, getCoverageReportsDirectory } from "../../../ts/lib/vitest.js";
+import { applyGritQL, matchGritQL } from "../../../utils/ast.js";
+import { BIOME_TEST_OUTPUT_EXCLUDE, formatFilesInSubtree } from "../../../utils/format.js";
+import { updateGitIgnore } from "../../../utils/git.js";
+/**
+ * Point each project's vitest coverage directory at the workspace's `dist`.
+ *
+ * `@nx/vitest` writes `reportsDirectory: './test-output/vitest/coverage'`, which
+ * resolves inside the project. Coverage is off by default, so the directory stays
+ * dormant until someone runs `vitest --coverage` — at which point the HTML
+ * reporter's bundled third-party scripts land in the project, where the `format`
+ * target reformats them (failing every later build) and the `default` named input
+ * counts them, so no task in the project can be cached again.
+ *
+ * Alongside the rewrite, the coverage directory an older release already wrote
+ * into the project is deleted and `test-output` is added to the workspace
+ * `.gitignore`, so the reporter's vendored third-party scripts can neither be
+ * committed nor picked up by `license#sync`.
+ *
+ * Guardrails:
+ * - The pattern is anchored to the exact literal `@nx/vitest` generated, and
+ *   scoped to the `coverage` block of the config's own `test` object, so a
+ *   `reportsDirectory` elsewhere in the file is left alone.
+ * - A project whose directory has been repointed keeps its value, and is reported
+ *   via `nextSteps` instead — as is one whose directory is set on a target, or a
+ *   `biome.json` whose `files.includes` has diverged from the vended list.
+ * - Idempotent: the pattern no longer matches once rewritten.
+ */ /**
+ * The config filenames to check. Generated projects carry the `.mts` forms; the
+ * other extensions vitest supports are included so a project whose config was
+ * renamed is still migrated. Safe to widen, because the pattern matched inside is
+ * anchored to the exact literal `@nx/vitest` generated.
+ */ const CONFIG_FILES = [
+    'vitest.config.mts',
+    'vitest.config.ts',
+    'vitest.config.mjs',
+    'vitest.config.js',
+    'vite.config.mts',
+    'vite.config.ts',
+    'vite.config.mjs',
+    'vite.config.js'
+];
+/**
+ * The `coverage` block of the object the config factory returns, scoped so a
+ * `coverage` option elsewhere in the file is not matched.
+ */ const coveragePattern = (body)=>`\`test: { $props }\` where {
+  $props <: within \`defineConfig($_)\`,
+  $props <: some \`coverage: { $cov }\`,
+  ${body}
+}`;
+/** Matches a coverage block still carrying the directory `@nx/vitest` generated. */ const GENERATED_DIRECTORY_PATTERN = coveragePattern(`$cov <: some \`reportsDirectory: '${GENERATED_REPORTS_DIRECTORY}'\``);
+/** Matches a coverage block that declares a `reportsDirectory` at all. */ const ANY_DIRECTORY_PATTERN = coveragePattern('$cov <: some `reportsDirectory: $_`');
+/** Rewrites the generated directory to the one under `dist` for a project root. */ const rewriteDirectoryPattern = (projectRoot)=>coveragePattern(`$cov <: some \`reportsDirectory: '${GENERATED_REPORTS_DIRECTORY}'\` as $reportsDirectory,
+  $reportsDirectory => \`reportsDirectory: '${getCoverageReportsDirectory(projectRoot)}'\``);
+/** Matches a coverage block already pointing at the directory under `dist`. */ const migratedDirectoryPattern = (projectRoot)=>coveragePattern(`$cov <: some \`reportsDirectory: '${getCoverageReportsDirectory(projectRoot)}'\``);
+/** The directory an older release wrote coverage into, relative to a project. */ const OLD_COVERAGE_DIRECTORY = 'test-output';
+/**
+ * Exclude test reports from Biome, so a coverage directory pointed anywhere
+ * inside the workspace is still never formatted or linted. Anchored to the
+ * excludes we vend, so a workspace that has rewritten `files.includes` keeps its
+ * own list — and is told to add the exclude itself.
+ */ const excludeTestOutputFromBiome = (tree)=>{
+    if (!tree.exists('biome.json')) {
+        return [];
+    }
+    let unrecognised = false;
+    updateJson(tree, 'biome.json', (biome)=>{
+        const includes = biome?.files?.includes;
+        if (!Array.isArray(includes) || includes.includes(BIOME_TEST_OUTPUT_EXCLUDE)) {
+            return biome;
+        }
+        // Placed next to the other build-output excludes. Without that anchor the
+        // list has diverged from the one we vend, so leave it to the user.
+        if (!includes.includes('!**/out-tsc')) {
+            unrecognised = true;
+            return biome;
+        }
+        return {
+            ...biome,
+            files: {
+                ...biome.files,
+                includes: includes.flatMap((include)=>include === '!**/out-tsc' ? [
+                        include,
+                        BIOME_TEST_OUTPUT_EXCLUDE
+                    ] : [
+                        include
+                    ])
+            }
+        };
+    });
+    return unrecognised ? [
+        `\`biome.json\`: add \`"${BIOME_TEST_OUTPUT_EXCLUDE}"\` to \`files.includes\` so test reports are never formatted or linted. Its \`files.includes\` has diverged from the vended list, so it was left as it is.`
+    ] : [];
+};
+/**
+ * Delete the coverage directory an older release wrote inside the project.
+ *
+ * Left in place it stays git-visible: the vended `.gitignore` covers `dist` but
+ * not `test-output`, so the HTML reporter's vendored third-party scripts can be
+ * committed, and `license#sync` — which builds its candidate set from
+ * git-visible files rather than from `biome.json` — would stamp an Apache-2.0
+ * header onto them. Only the reporter's own output is removed; anything else the
+ * user keeps there is left alone.
+ */ const deleteOldCoverageDirectory = (tree, projectRoot)=>{
+    const oldDirectory = joinPathFragments(projectRoot, OLD_COVERAGE_DIRECTORY, 'vitest/coverage');
+    if (tree.exists(oldDirectory)) {
+        tree.delete(oldDirectory);
+    }
+};
+/**
+ * A `reportsDirectory` set on a target rather than in the vitest config, which
+ * takes precedence over the config value. `@nx/vitest` supports this shape, so
+ * report any that still resolves inside the project — rewriting a target option
+ * is the user's call, not this migration's.
+ */ const targetReportsDirectories = (project)=>{
+    const found = [];
+    for (const [target, config] of Object.entries(project.targets ?? {})){
+        for (const options of [
+            config.options,
+            ...Object.values(config.configurations ?? {})
+        ]){
+            const reportsDirectory = options?.reportsDirectory;
+            // A path escaping the project root is already outside it.
+            if (typeof reportsDirectory === 'string' && !reportsDirectory.startsWith('..') && !isAbsolute(reportsDirectory)) {
+                found.push({
+                    target,
+                    reportsDirectory
+                });
+            }
+        }
+    }
+    return found;
+};
+export default async function migration(tree) {
+    const nextSteps = [
+        ...excludeTestOutputFromBiome(tree)
+    ];
+    // Test reports are build output, so ignore them wherever a project writes them.
+    updateGitIgnore(tree, '.', (patterns)=>patterns.includes(OLD_COVERAGE_DIRECTORY) ? patterns : [
+            ...patterns,
+            OLD_COVERAGE_DIRECTORY
+        ]);
+    for (const [name, project] of getProjects(tree)){
+        for (const { target, reportsDirectory } of targetReportsDirectories(project)){
+            nextSteps.push(`${name}: the \`${target}\` target sets \`reportsDirectory: '${reportsDirectory}'\`, which resolves inside the project and takes precedence over the vitest config. Point it outside the project (eg \`${getCoverageReportsDirectory(project.root)}\`).`);
+        }
+        for (const configFile of CONFIG_FILES){
+            const configPath = joinPathFragments(project.root, configFile);
+            if (!tree.exists(configPath)) {
+                continue;
+            }
+            if (await matchGritQL(tree, configPath, GENERATED_DIRECTORY_PATTERN)) {
+                await applyGritQL(tree, configPath, rewriteDirectoryPattern(project.root));
+                deleteOldCoverageDirectory(tree, project.root);
+                continue;
+            }
+            // A directory the user repointed is theirs to keep, but it may still sit
+            // inside the project, so report it rather than rewriting it. A config
+            // declaring no directory at all relies on vitest's default, which this
+            // migration has no generated shape to match.
+            if (await matchGritQL(tree, configPath, ANY_DIRECTORY_PATTERN) && !await matchGritQL(tree, configPath, migratedDirectoryPattern(project.root))) {
+                nextSteps.push(`${name}: \`${configPath}\` sets its own \`test.coverage.reportsDirectory\`. Point it outside the project (eg \`${getCoverageReportsDirectory(project.root)}\`) so coverage output is not formatted, linted or treated as a task input.`);
+            }
+        }
+    }
+    await formatFilesInSubtree(tree);
+    return {
+        nextSteps
+    };
+}
+
+//# sourceMappingURL=migration.js.map

package/src/migrations/latest/vitest-coverage-output-dir/migration.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../packages/nx-plugin/src/migrations/latest/vitest-coverage-output-dir/migration.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport {\n  getProjects,\n  joinPathFragments,\n  type MigrationReturnObject,\n  type ProjectConfiguration,\n  type Tree,\n  updateJson,\n} from '@nx/devkit';\nimport { isAbsolute } from 'path';\nimport {\n  GENERATED_REPORTS_DIRECTORY,\n  getCoverageReportsDirectory,\n} from '../../../ts/lib/vitest.js';\nimport { applyGritQL, matchGritQL } from '../../../utils/ast.js';\nimport {\n  BIOME_TEST_OUTPUT_EXCLUDE,\n  formatFilesInSubtree,\n} from '../../../utils/format.js';\nimport { updateGitIgnore } from '../../../utils/git.js';\n\n/**\n * Point each project's vitest coverage directory at the workspace's `dist`.\n *\n * `@nx/vitest` writes `reportsDirectory: './test-output/vitest/coverage'`, which\n * resolves inside the project. Coverage is off by default, so the directory stays\n * dormant until someone runs `vitest --coverage` — at which point the HTML\n * reporter's bundled third-party scripts land in the project, where the `format`\n * target reformats them (failing every later build) and the `default` named input\n * counts them, so no task in the project can be cached again.\n *\n * Alongside the rewrite, the coverage directory an older release already wrote\n * into the project is deleted and `test-output` is added to the workspace\n * `.gitignore`, so the reporter's vendored third-party scripts can neither be\n * committed nor picked up by `license#sync`.\n *\n * Guardrails:\n * - The pattern is anchored to the exact literal `@nx/vitest` generated, and\n *   scoped to the `coverage` block of the config's own `test` object, so a\n *   `reportsDirectory` elsewhere in the file is left alone.\n * - A project whose directory has been repointed keeps its value, and is reported\n *   via `nextSteps` instead — as is one whose directory is set on a target, or a\n *   `biome.json` whose `files.includes` has diverged from the vended list.\n * - Idempotent: the pattern no longer matches once rewritten.\n */\n\n/**\n * The config filenames to check. Generated projects carry the `.mts` forms; the\n * other extensions vitest supports are included so a project whose config was\n * renamed is still migrated. Safe to widen, because the pattern matched inside is\n * anchored to the exact literal `@nx/vitest` generated.\n */\nconst CONFIG_FILES = [\n  'vitest.config.mts',\n  'vitest.config.ts',\n  'vitest.config.mjs',\n  'vitest.config.js',\n  'vite.config.mts',\n  'vite.config.ts',\n  'vite.config.mjs',\n  'vite.config.js',\n];\n\n/**\n * The `coverage` block of the object the config factory returns, scoped so a\n * `coverage` option elsewhere in the file is not matched.\n */\nconst coveragePattern = (body: string): string =>\n  `\\`test: { $props }\\` where {\n  $props <: within \\`defineConfig($_)\\`,\n  $props <: some \\`coverage: { $cov }\\`,\n  ${body}\n}`;\n\n/** Matches a coverage block still carrying the directory `@nx/vitest` generated. */\nconst GENERATED_DIRECTORY_PATTERN = coveragePattern(\n  `$cov <: some \\`reportsDirectory: '${GENERATED_REPORTS_DIRECTORY}'\\``,\n);\n\n/** Matches a coverage block that declares a `reportsDirectory` at all. */\nconst ANY_DIRECTORY_PATTERN = coveragePattern(\n  '$cov <: some `reportsDirectory: $_`',\n);\n\n/** Rewrites the generated directory to the one under `dist` for a project root. */\nconst rewriteDirectoryPattern = (projectRoot: string): string =>\n  coveragePattern(\n    `$cov <: some \\`reportsDirectory: '${GENERATED_REPORTS_DIRECTORY}'\\` as $reportsDirectory,\n  $reportsDirectory => \\`reportsDirectory: '${getCoverageReportsDirectory(projectRoot)}'\\``,\n  );\n\n/** Matches a coverage block already pointing at the directory under `dist`. */\nconst migratedDirectoryPattern = (projectRoot: string): string =>\n  coveragePattern(\n    `$cov <: some \\`reportsDirectory: '${getCoverageReportsDirectory(projectRoot)}'\\``,\n  );\n\n/** The directory an older release wrote coverage into, relative to a project. */\nconst OLD_COVERAGE_DIRECTORY = 'test-output';\n\n/**\n * Exclude test reports from Biome, so a coverage directory pointed anywhere\n * inside the workspace is still never formatted or linted. Anchored to the\n * excludes we vend, so a workspace that has rewritten `files.includes` keeps its\n * own list — and is told to add the exclude itself.\n */\nconst excludeTestOutputFromBiome = (tree: Tree): string[] => {\n  if (!tree.exists('biome.json')) {\n    return [];\n  }\n  let unrecognised = false;\n  updateJson(tree, 'biome.json', (biome) => {\n    const includes: unknown = biome?.files?.includes;\n    if (\n      !Array.isArray(includes) ||\n      includes.includes(BIOME_TEST_OUTPUT_EXCLUDE)\n    ) {\n      return biome;\n    }\n    // Placed next to the other build-output excludes. Without that anchor the\n    // list has diverged from the one we vend, so leave it to the user.\n    if (!includes.includes('!**/out-tsc')) {\n      unrecognised = true;\n      return biome;\n    }\n    return {\n      ...biome,\n      files: {\n        ...biome.files,\n        includes: includes.flatMap((include) =>\n          include === '!**/out-tsc'\n            ? [include, BIOME_TEST_OUTPUT_EXCLUDE]\n            : [include],\n        ),\n      },\n    };\n  });\n  return unrecognised\n    ? [\n        `\\`biome.json\\`: add \\`\"${BIOME_TEST_OUTPUT_EXCLUDE}\"\\` to \\`files.includes\\` so test reports are never formatted or linted. Its \\`files.includes\\` has diverged from the vended list, so it was left as it is.`,\n      ]\n    : [];\n};\n\n/**\n * Delete the coverage directory an older release wrote inside the project.\n *\n * Left in place it stays git-visible: the vended `.gitignore` covers `dist` but\n * not `test-output`, so the HTML reporter's vendored third-party scripts can be\n * committed, and `license#sync` — which builds its candidate set from\n * git-visible files rather than from `biome.json` — would stamp an Apache-2.0\n * header onto them. Only the reporter's own output is removed; anything else the\n * user keeps there is left alone.\n */\nconst deleteOldCoverageDirectory = (tree: Tree, projectRoot: string): void => {\n  const oldDirectory = joinPathFragments(\n    projectRoot,\n    OLD_COVERAGE_DIRECTORY,\n    'vitest/coverage',\n  );\n  if (tree.exists(oldDirectory)) {\n    tree.delete(oldDirectory);\n  }\n};\n\n/**\n * A `reportsDirectory` set on a target rather than in the vitest config, which\n * takes precedence over the config value. `@nx/vitest` supports this shape, so\n * report any that still resolves inside the project — rewriting a target option\n * is the user's call, not this migration's.\n */\nconst targetReportsDirectories = (\n  project: ProjectConfiguration,\n): { target: string; reportsDirectory: string }[] => {\n  const found: { target: string; reportsDirectory: string }[] = [];\n  for (const [target, config] of Object.entries(project.targets ?? {})) {\n    for (const options of [\n      config.options,\n      ...Object.values(config.configurations ?? {}),\n    ]) {\n      const reportsDirectory: unknown = options?.reportsDirectory;\n      // A path escaping the project root is already outside it.\n      if (\n        typeof reportsDirectory === 'string' &&\n        !reportsDirectory.startsWith('..') &&\n        !isAbsolute(reportsDirectory)\n      ) {\n        found.push({ target, reportsDirectory });\n      }\n    }\n  }\n  return found;\n};\n\nexport default async function migration(\n  tree: Tree,\n): Promise<MigrationReturnObject> {\n  const nextSteps: string[] = [...excludeTestOutputFromBiome(tree)];\n\n  // Test reports are build output, so ignore them wherever a project writes them.\n  updateGitIgnore(tree, '.', (patterns) =>\n    patterns.includes(OLD_COVERAGE_DIRECTORY)\n      ? patterns\n      : [...patterns, OLD_COVERAGE_DIRECTORY],\n  );\n\n  for (const [name, project] of getProjects(tree)) {\n    for (const { target, reportsDirectory } of targetReportsDirectories(\n      project,\n    )) {\n      nextSteps.push(\n        `${name}: the \\`${target}\\` target sets \\`reportsDirectory: '${reportsDirectory}'\\`, which resolves inside the project and takes precedence over the vitest config. Point it outside the project (eg \\`${getCoverageReportsDirectory(project.root)}\\`).`,\n      );\n    }\n\n    for (const configFile of CONFIG_FILES) {\n      const configPath = joinPathFragments(project.root, configFile);\n      if (!tree.exists(configPath)) {\n        continue;\n      }\n\n      if (await matchGritQL(tree, configPath, GENERATED_DIRECTORY_PATTERN)) {\n        await applyGritQL(\n          tree,\n          configPath,\n          rewriteDirectoryPattern(project.root),\n        );\n        deleteOldCoverageDirectory(tree, project.root);\n        continue;\n      }\n\n      // A directory the user repointed is theirs to keep, but it may still sit\n      // inside the project, so report it rather than rewriting it. A config\n      // declaring no directory at all relies on vitest's default, which this\n      // migration has no generated shape to match.\n      if (\n        (await matchGritQL(tree, configPath, ANY_DIRECTORY_PATTERN)) &&\n        !(await matchGritQL(\n          tree,\n          configPath,\n          migratedDirectoryPattern(project.root),\n        ))\n      ) {\n        nextSteps.push(\n          `${name}: \\`${configPath}\\` sets its own \\`test.coverage.reportsDirectory\\`. Point it outside the project (eg \\`${getCoverageReportsDirectory(project.root)}\\`) so coverage output is not formatted, linted or treated as a task input.`,\n        );\n      }\n    }\n  }\n\n  await formatFilesInSubtree(tree);\n\n  return { nextSteps };\n}\n"],"names":["getProjects","joinPathFragments","updateJson","isAbsolute","GENERATED_REPORTS_DIRECTORY","getCoverageReportsDirectory","applyGritQL","matchGritQL","BIOME_TEST_OUTPUT_EXCLUDE","formatFilesInSubtree","updateGitIgnore","CONFIG_FILES","coveragePattern","body","GENERATED_DIRECTORY_PATTERN","ANY_DIRECTORY_PATTERN","rewriteDirectoryPattern","projectRoot","migratedDirectoryPattern","OLD_COVERAGE_DIRECTORY","excludeTestOutputFromBiome","tree","exists","unrecognised","biome","includes","files","Array","isArray","flatMap","include","deleteOldCoverageDirectory","oldDirectory","delete","targetReportsDirectories","project","found","target","config","Object","entries","targets","options","values","configurations","reportsDirectory","startsWith","push","migration","nextSteps","patterns","name","root","configFile","configPath"],"mappings":"AAAA;;;CAGC,GACD,SACEA,WAAW,EACXC,iBAAiB,EAIjBC,UAAU,QACL,aAAa;AACpB,SAASC,UAAU,QAAQ,OAAO;AAClC,SACEC,2BAA2B,EAC3BC,2BAA2B,QACtB,4BAA4B;AACnC,SAASC,WAAW,EAAEC,WAAW,QAAQ,wBAAwB;AACjE,SACEC,yBAAyB,EACzBC,oBAAoB,QACf,2BAA2B;AAClC,SAASC,eAAe,QAAQ,wBAAwB;AAExD;;;;;;;;;;;;;;;;;;;;;;;CAuBC,GAED;;;;;CAKC,GACD,MAAMC,eAAe;IACnB;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACD;AAED;;;CAGC,GACD,MAAMC,kBAAkB,CAACC,OACvB,CAAC;;;EAGD,EAAEA,KAAK;CACR,CAAC;AAEF,kFAAkF,GAClF,MAAMC,8BAA8BF,gBAClC,CAAC,kCAAkC,EAAER,4BAA4B,GAAG,CAAC;AAGvE,wEAAwE,GACxE,MAAMW,wBAAwBH,gBAC5B;AAGF,iFAAiF,GACjF,MAAMI,0BAA0B,CAACC,cAC/BL,gBACE,CAAC,kCAAkC,EAAER,4BAA4B;4CACzB,EAAEC,4BAA4BY,aAAa,GAAG,CAAC;AAG3F,6EAA6E,GAC7E,MAAMC,2BAA2B,CAACD,cAChCL,gBACE,CAAC,kCAAkC,EAAEP,4BAA4BY,aAAa,GAAG,CAAC;AAGtF,+EAA+E,GAC/E,MAAME,yBAAyB;AAE/B;;;;;CAKC,GACD,MAAMC,6BAA6B,CAACC;IAClC,IAAI,CAACA,KAAKC,MAAM,CAAC,eAAe;QAC9B,OAAO,EAAE;IACX;IACA,IAAIC,eAAe;IACnBrB,WAAWmB,MAAM,cAAc,CAACG;QAC9B,MAAMC,WAAoBD,OAAOE,OAAOD;QACxC,IACE,CAACE,MAAMC,OAAO,CAACH,aACfA,SAASA,QAAQ,CAACjB,4BAClB;YACA,OAAOgB;QACT;QACA,0EAA0E;QAC1E,mEAAmE;QACnE,IAAI,CAACC,SAASA,QAAQ,CAAC,gBAAgB;YACrCF,eAAe;YACf,OAAOC;QACT;QACA,OAAO;YACL,GAAGA,KAAK;YACRE,OAAO;gBACL,GAAGF,MAAME,KAAK;gBACdD,UAAUA,SAASI,OAAO,CAAC,CAACC,UAC1BA,YAAY,gBACR;wBAACA;wBAAStB;qBAA0B,GACpC;wBAACsB;qBAAQ;YAEjB;QACF;IACF;IACA,OAAOP,eACH;QACE,CAAC,uBAAuB,EAAEf,0BAA0B,2JAA2J,CAAC;KACjN,GACD,EAAE;AACR;AAEA;;;;;;;;;CASC,GACD,MAAMuB,6BAA6B,CAACV,MAAYJ;IAC9C,MAAMe,eAAe/B,kBACnBgB,aACAE,wBACA;IAEF,IAAIE,KAAKC,MAAM,CAACU,eAAe;QAC7BX,KAAKY,MAAM,CAACD;IACd;AACF;AAEA;;;;;CAKC,GACD,MAAME,2BAA2B,CAC/BC;IAEA,MAAMC,QAAwD,EAAE;IAChE,KAAK,MAAM,CAACC,QAAQC,OAAO,IAAIC,OAAOC,OAAO,CAACL,QAAQM,OAAO,IAAI,CAAC,GAAI;QACpE,KAAK,MAAMC,WAAW;YACpBJ,OAAOI,OAAO;eACXH,OAAOI,MAAM,CAACL,OAAOM,cAAc,IAAI,CAAC;SAC5C,CAAE;YACD,MAAMC,mBAA4BH,SAASG;YAC3C,0DAA0D;YAC1D,IACE,OAAOA,qBAAqB,YAC5B,CAACA,iBAAiBC,UAAU,CAAC,SAC7B,CAAC3C,WAAW0C,mBACZ;gBACAT,MAAMW,IAAI,CAAC;oBAAEV;oBAAQQ;gBAAiB;YACxC;QACF;IACF;IACA,OAAOT;AACT;AAEA,eAAe,eAAeY,UAC5B3B,IAAU;IAEV,MAAM4B,YAAsB;WAAI7B,2BAA2BC;KAAM;IAEjE,gFAAgF;IAChFX,gBAAgBW,MAAM,KAAK,CAAC6B,WAC1BA,SAASzB,QAAQ,CAACN,0BACd+B,WACA;eAAIA;YAAU/B;SAAuB;IAG3C,KAAK,MAAM,CAACgC,MAAMhB,QAAQ,IAAInC,YAAYqB,MAAO;QAC/C,KAAK,MAAM,EAAEgB,MAAM,EAAEQ,gBAAgB,EAAE,IAAIX,yBACzCC,SACC;YACDc,UAAUF,IAAI,CACZ,GAAGI,KAAK,QAAQ,EAAEd,OAAO,oCAAoC,EAAEQ,iBAAiB,uHAAuH,EAAExC,4BAA4B8B,QAAQiB,IAAI,EAAE,IAAI,CAAC;QAE5P;QAEA,KAAK,MAAMC,cAAc1C,aAAc;YACrC,MAAM2C,aAAarD,kBAAkBkC,QAAQiB,IAAI,EAAEC;YACnD,IAAI,CAAChC,KAAKC,MAAM,CAACgC,aAAa;gBAC5B;YACF;YAEA,IAAI,MAAM/C,YAAYc,MAAMiC,YAAYxC,8BAA8B;gBACpE,MAAMR,YACJe,MACAiC,YACAtC,wBAAwBmB,QAAQiB,IAAI;gBAEtCrB,2BAA2BV,MAAMc,QAAQiB,IAAI;gBAC7C;YACF;YAEA,yEAAyE;YACzE,sEAAsE;YACtE,uEAAuE;YACvE,6CAA6C;YAC7C,IACE,AAAC,MAAM7C,YAAYc,MAAMiC,YAAYvC,0BACrC,CAAE,MAAMR,YACNc,MACAiC,YACApC,yBAAyBiB,QAAQiB,IAAI,IAEvC;gBACAH,UAAUF,IAAI,CACZ,GAAGI,KAAK,IAAI,EAAEG,WAAW,uFAAuF,EAAEjD,4BAA4B8B,QAAQiB,IAAI,EAAE,2EAA2E,CAAC;YAE5O;QACF;IACF;IAEA,MAAM3C,qBAAqBY;IAE3B,OAAO;QAAE4B;IAAU;AACrB"}