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

package/src/ts/nx-generator/__snapshots__/generator.spec.ts.snap

@@ -109,14 +109,16 @@ describe('foo#bar generator', () => {
 `;
 
 exports[`nx-generator generator > within @aws/nx-plugin > should generate an example schema, generator and test > generator.ts 1`] = `
-"import { GeneratorCallback, Tree, installPackagesTask } from '@nx/devkit';
-import { FooBarGeneratorSchema } from './schema';
-import { NxGeneratorInfo, getGeneratorInfo } from '../utils/nx';
+"import { type GeneratorCallback, type Tree } from '@nx/devkit';
+import type { FooBarGeneratorSchema } from './schema.js';
+import { type NxGeneratorInfo, getGeneratorInfo } from '../utils/nx';
 import { addGeneratorMetricsIfApplicable } from '../utils/metrics';
 import { formatFilesInSubtree } from '../utils/format';
+import { installDependencies } from '../utils/install';
 
-export const FOO_BAR_GENERATOR_INFO: NxGeneratorInfo =
-  getGeneratorInfo(__filename);
+export const FOO_BAR_GENERATOR_INFO: NxGeneratorInfo = getGeneratorInfo(
+  import.meta.filename,
+);
 
 export const fooBarGenerator = async (
   tree: Tree,
@@ -127,9 +129,10 @@ export const fooBarGenerator = async (
   await addGeneratorMetricsIfApplicable(tree, [FOO_BAR_GENERATOR_INFO]);
 
   await formatFilesInSubtree(tree);
-  return () => {
-    installPackagesTask(tree);
-  };
+  return () =>
+    installDependencies(tree, options.preferInstallDependencies, {
+      languages: ['typescript'],
+    });
 };
 
 export default fooBarGenerator;
@@ -144,6 +147,7 @@ exports[`nx-generator generator > within @aws/nx-plugin > should generate an exa
 export interface FooBarGeneratorSchema {
   // Replace with your options
   exampleOption: string;
+  preferInstallDependencies?: boolean;
 }
 "
 `;
@@ -161,6 +165,11 @@ exports[`nx-generator generator > within @aws/nx-plugin > should generate an exa
       "description": "An example option. Refer to https://nx.dev/extending-nx/recipes/generator-options for more info",
       "x-priority": "important",
       "x-prompt": "This is an example option!"
+    },
+    "preferInstallDependencies": {
+      "type": "boolean",
+      "description": "Whether to prefer installing dependencies after the generator runs. Set to false to defer installing when batching multiple generators (an install still runs if needed so subsequent generators can compute the Nx project graph); install once at the end.",
+      "default": true
     }
   },
   "required": ["exampleOption"]
@@ -197,7 +206,7 @@ exports[`nx-generator generator > within @aws/nx-plugin > should update generato
 exports[`nx-generator generator > within another workspace > should generate an example schema, generator and test > local-generator.spec.ts 1`] = `
 "import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
 import { Tree } from '@nx/devkit';
-import { fooBarGenerator } from './generator';
+import { fooBarGenerator } from './generator.js';
 
 describe('foo#bar generator', () => {
   let tree: Tree;
@@ -217,12 +226,12 @@ describe('foo#bar generator', () => {
 
 exports[`nx-generator generator > within another workspace > should generate an example schema, generator and test > local-generator.ts 1`] = `
 "import {
-  GeneratorCallback,
-  Tree,
+  type GeneratorCallback,
+  type Tree,
   generateFiles,
   joinPathFragments,
 } from '@nx/devkit';
-import { FooBarGeneratorSchema } from './schema';
+import type { FooBarGeneratorSchema } from './schema.js';
 
 export const fooBarGenerator = async (
   tree: Tree,
@@ -231,7 +240,7 @@ export const fooBarGenerator = async (
   // TODO: implement your generator here, for example:
   generateFiles(
     tree,
-    joinPathFragments(__dirname, 'files'),
+    joinPathFragments(import.meta.dirname, 'files'),
     'target/dir',
     options,
   );
@@ -249,6 +258,7 @@ exports[`nx-generator generator > within another workspace > should generate an
 export interface FooBarGeneratorSchema {
   // Replace with your options
   exampleOption: string;
+  preferInstallDependencies?: boolean;
 }
 "
 `;
@@ -266,6 +276,11 @@ exports[`nx-generator generator > within another workspace > should generate an
       "description": "An example option. Refer to https://nx.dev/extending-nx/recipes/generator-options for more info",
       "x-priority": "important",
       "x-prompt": "This is an example option!"
+    },
+    "preferInstallDependencies": {
+      "type": "boolean",
+      "description": "Whether to prefer installing dependencies after the generator runs. Set to false to defer installing when batching multiple generators (an install still runs if needed so subsequent generators can compute the Nx project graph); install once at the end.",
+      "default": true
     }
   },
   "required": ["exampleOption"]

package/src/ts/nx-generator/files/common/schema.d.ts.template

@@ -5,4 +5,5 @@
 export interface <%- namePascalCase %>GeneratorSchema {
   // Replace with your options
   exampleOption: string;
+  preferInstallDependencies?: boolean;
 }

package/src/ts/nx-generator/files/common/schema.json.template

@@ -10,6 +10,11 @@
       "description": "An example option. Refer to https://nx.dev/extending-nx/recipes/generator-options for more info",
       "x-priority": "important",
       "x-prompt": "This is an example option!"
+    },
+    "preferInstallDependencies": {
+      "type": "boolean",
+      "description": "Whether to prefer installing dependencies after the generator runs. Set to false to defer installing when batching multiple generators (an install still runs if needed so subsequent generators can compute the Nx project graph); install once at the end.",
+      "default": true
     }
   },
   "required": ["exampleOption"]

package/src/ts/nx-generator/files/local/generator.spec.ts.template

@@ -1,6 +1,6 @@
 import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
 import { Tree } from '@nx/devkit';
-import { <%- nameCamelCase %>Generator } from './generator';
+import { <%- nameCamelCase %>Generator } from './generator<% if (esm) { %>.js<% } %>';
 
 describe('<%- name %> generator', () => {
   let tree: Tree;

package/src/ts/nx-generator/files/local/generator.ts.template

@@ -1,9 +1,9 @@
-import { GeneratorCallback, Tree, generateFiles, joinPathFragments } from "@nx/devkit";
-import { <%- namePascalCase %>GeneratorSchema } from './schema';
+import { type GeneratorCallback, type Tree, generateFiles, joinPathFragments } from "@nx/devkit";
+import type { <%- namePascalCase %>GeneratorSchema } from './schema<% if (esm) { %>.js<% } %>';
 
 export const <%- nameCamelCase %>Generator = async (tree: Tree, options: <%- namePascalCase %>GeneratorSchema): Promise<GeneratorCallback | void> => {
   // TODO: implement your generator here, for example:
-  generateFiles(tree, joinPathFragments(__dirname, 'files'), 'target/dir', options);
+  generateFiles(tree, joinPathFragments(<% if (esm) { %>import.meta.dirname<% } else { %>__dirname<% } %>, 'files'), 'target/dir', options);
 };
 
 export default <%- nameCamelCase %>Generator;

package/src/ts/nx-generator/files/nx-plugin-for-aws/generator/generator.ts.template

@@ -1,11 +1,12 @@
-import { GeneratorCallback, Tree, installPackagesTask } from "@nx/devkit";
-import { <%- namePascalCase %>GeneratorSchema } from './schema';
-import { NxGeneratorInfo, getGeneratorInfo } from '<%- pathToProjectSourceRoot %>utils/nx';
+import { type GeneratorCallback, type Tree } from "@nx/devkit";
+import type { <%- namePascalCase %>GeneratorSchema } from './schema<% if (esm) { %>.js<% } %>';
+import { type NxGeneratorInfo, getGeneratorInfo } from '<%- pathToProjectSourceRoot %>utils/nx';
 import { addGeneratorMetricsIfApplicable } from '<%- pathToProjectSourceRoot %>utils/metrics';
 import { formatFilesInSubtree } from '<%- pathToProjectSourceRoot %>utils/format';
+import { installDependencies } from '<%- pathToProjectSourceRoot %>utils/install';
 
 export const <%- nameUpperSnakeCase %>_GENERATOR_INFO: NxGeneratorInfo =
-  getGeneratorInfo(__filename);
+  getGeneratorInfo(<% if (esm) { %>import.meta.filename<% } else { %>__filename<% } %>);
 
 export const <%- nameCamelCase %>Generator = async (tree: Tree, options: <%- namePascalCase %>GeneratorSchema): Promise<GeneratorCallback> => {
 
@@ -14,9 +15,7 @@ export const <%- nameCamelCase %>Generator = async (tree: Tree, options: <%- nam
   await addGeneratorMetricsIfApplicable(tree, [<%- nameUpperSnakeCase %>_GENERATOR_INFO]);
 
   await formatFilesInSubtree(tree);
-  return () => {
-    installPackagesTask(tree);
-  };
+  return () => installDependencies(tree, options.preferInstallDependencies, { languages: ['typescript'] });
 };
 
 export default <%- nameCamelCase %>Generator;

package/src/ts/nx-generator/generator.d.ts

@@ -4,6 +4,9 @@
  */
 import { type GeneratorCallback, type Tree } from '@nx/devkit';
 import type { TsNxGeneratorGeneratorSchema } from './schema';
+export declare const DEPENDENCIES: import("../../utils/declared-dependencies.js").DependencyDeclaration<readonly [{
+    readonly name: "@nx/devkit";
+}], readonly import("../../utils/declared-dependencies.js").DeclaredPyDependency<"a2a-sdk" | "ag-ui-langgraph" | "ag-ui-protocol" | "ag-ui-strands" | "aiosqlite" | "aws-lambda-powertools" | "aws-lambda-powertools[tracer]" | "aws-lambda-powertools[parser]" | "aws-opentelemetry-distro" | "bedrock-agentcore" | "boto3" | "checkov" | "fastapi" | "fastapi[standard]" | "httpx" | "langchain" | "langchain-aws" | "langchain-mcp-adapters" | "langgraph" | "langgraph-checkpoint-aws" | "langgraph-checkpoint-sqlite" | "mcp" | "pip-check-updates" | "pip-licenses" | "ruff" | "strands-agents" | "strands-agents[a2a]" | "strands-agents-tools" | "ty" | "pynamodb" | "uvicorn" | "sqlmodel" | "alembic" | "aiomysql" | "asyncpg" | "greenlet", Record<string, never>>[]>;
 export declare const NX_GENERATOR_GENERATOR_INFO: import("../../utils/generators").GeneratorInfo;
 export declare const tsNxGeneratorGenerator: (tree: Tree, options: TsNxGeneratorGeneratorSchema) => Promise<GeneratorCallback | void>;
 export default tsNxGeneratorGenerator;

package/src/ts/nx-generator/generator.js

@@ -1,120 +1,167 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tsNxGeneratorGenerator = exports.NX_GENERATOR_GENERATOR_INFO = void 0;
-const tslib_1 = require("tslib");
 /**
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
- */
-const devkit_1 = require("@nx/devkit");
-const lodash_camelcase_1 = tslib_1.__importDefault(require("lodash.camelcase"));
-const package_json_1 = tslib_1.__importDefault(require("../../../package.json"));
-const ast_1 = require("../../utils/ast");
-const format_1 = require("../../utils/format");
-const metrics_1 = require("../../utils/metrics");
-const names_1 = require("../../utils/names");
-const nx_1 = require("../../utils/nx");
-const object_1 = require("../../utils/object");
-const paths_1 = require("../../utils/paths");
-const utils_1 = require("../nx-plugin/utils");
-exports.NX_GENERATOR_GENERATOR_INFO = (0, nx_1.getGeneratorInfo)(__filename);
-const tsNxGeneratorGenerator = async (tree, options) => {
+ */ import { generateFiles, joinPathFragments, OverwriteStrategy, readJson, writeJson } from "@nx/devkit";
+import camelCase from "lodash.camelcase";
+import PackageJson from "../../../package.json" with {
+    type: 'json'
+};
+import { addStarExport, applyGritQL } from "../../utils/ast.js";
+import { declareDependencies } from "../../utils/declared-dependencies.js";
+import { formatFilesInSubtree } from "../../utils/format.js";
+import { installDependencies } from "../../utils/install.js";
+import { addGeneratorMetricsIfApplicable } from "../../utils/metrics.js";
+import { esmVars } from "../../utils/module-format.js";
+import { kebabCase, pascalCase, snakeCase } from "../../utils/names.js";
+import { addComponentGeneratorMetadata, getGeneratorInfo, readProjectConfigurationUnqualified } from "../../utils/nx.js";
+import { sortObjectKeys } from "../../utils/object.js";
+import { getRelativePathToRootByDirectory } from "../../utils/paths.js";
+import { configureTsProjectAsNxPlugin, NX_PLUGIN_DEPENDENCIES } from "../nx-plugin/utils.js";
+export const DEPENDENCIES = declareDependencies()({
+    ts: [
+        ...NX_PLUGIN_DEPENDENCIES
+    ]
+});
+export const NX_GENERATOR_GENERATOR_INFO = getGeneratorInfo(import.meta.filename);
+export const tsNxGeneratorGenerator = async (tree, options)=>{
     const { name, directory, project: pluginProject, description } = options;
-    const plugin = (0, nx_1.readProjectConfigurationUnqualified)(tree, pluginProject);
-    const sourceRoot = plugin.sourceRoot ?? (0, devkit_1.joinPathFragments)(plugin.root, 'src');
+    const plugin = readProjectConfigurationUnqualified(tree, pluginProject);
+    const sourceRoot = plugin.sourceRoot ?? joinPathFragments(plugin.root, 'src');
     const sourceRootParts = sourceRoot.split('/');
     const srcDir = sourceRootParts[sourceRootParts.length - 1];
-    const generatorSubDir = directory ?? (0, names_1.kebabCase)(name);
-    const generatorDir = (0, devkit_1.joinPathFragments)(sourceRoot, generatorSubDir);
-    const rootPackageJson = tree.exists('package.json')
-        ? (0, devkit_1.readJson)(tree, 'package.json')
-        : undefined;
+    const generatorSubDir = directory ?? kebabCase(name);
+    const generatorDir = joinPathFragments(sourceRoot, generatorSubDir);
+    const rootPackageJson = tree.exists('package.json') ? readJson(tree, 'package.json') : undefined;
     const isNxPluginForAws = rootPackageJson?.name === '@aws/nx-plugin-source';
     // Configure the targeted project as an Nx Plugin
-    (0, utils_1.configureTsProjectAsNxPlugin)(tree, pluginProject);
+    configureTsProjectAsNxPlugin(tree, pluginProject, DEPENDENCIES);
     const enhancedOptions = {
         name,
         description,
-        namePascalCase: (0, names_1.pascalCase)(name),
-        nameCamelCase: (0, lodash_camelcase_1.default)(name),
-        nameKebabCase: (0, names_1.kebabCase)(name),
-        nameUpperSnakeCase: (0, names_1.snakeCase)(name).toUpperCase(),
+        namePascalCase: pascalCase(name),
+        nameCamelCase: camelCase(name),
+        nameKebabCase: kebabCase(name),
+        nameUpperSnakeCase: snakeCase(name).toUpperCase(),
         isNxPluginForAws,
-        pathToProjectSourceRoot: (0, paths_1.getRelativePathToRootByDirectory)(generatorSubDir),
+        pathToProjectSourceRoot: getRelativePathToRootByDirectory(generatorSubDir),
         generatorDir,
         generatorSubDir,
+        ...esmVars(tree)
     };
     // Add the common files, preserving any the user has already implemented
-    (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, 'files', 'common'), generatorDir, {
-        ...enhancedOptions,
-    }, { overwriteStrategy: devkit_1.OverwriteStrategy.KeepExisting });
+    generateFiles(tree, joinPathFragments(import.meta.dirname, 'files', 'common'), generatorDir, {
+        ...enhancedOptions
+    }, {
+        overwriteStrategy: OverwriteStrategy.KeepExisting
+    });
     // Add the files specific to this repo vs a local generator in another project
     if (isNxPluginForAws) {
         // Generators should be in the @aws/nx-plugin project
-        if (pluginProject !== package_json_1.default.name) {
-            throw new Error(`Generators should be added to the ${package_json_1.default.name} project.`);
+        if (pluginProject !== PackageJson.name) {
+            throw new Error(`Generators should be added to the ${PackageJson.name} project.`);
         }
         // Add the generator
-        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, 'files', 'nx-plugin-for-aws', 'generator'), generatorDir, {
-            ...enhancedOptions,
-        }, { overwriteStrategy: devkit_1.OverwriteStrategy.KeepExisting });
+        generateFiles(tree, joinPathFragments(import.meta.dirname, 'files', 'nx-plugin-for-aws', 'generator'), generatorDir, {
+            ...enhancedOptions
+        }, {
+            overwriteStrategy: OverwriteStrategy.KeepExisting
+        });
         // Generate guide page in docs
-        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, 'files', 'nx-plugin-for-aws', 'docs'), (0, devkit_1.joinPathFragments)('docs', 'src', 'content', 'docs', 'en', 'guides'), {
-            ...enhancedOptions,
-        }, { overwriteStrategy: devkit_1.OverwriteStrategy.KeepExisting });
+        generateFiles(tree, joinPathFragments(import.meta.dirname, 'files', 'nx-plugin-for-aws', 'docs'), joinPathFragments('docs', 'src', 'content', 'docs', 'en', 'guides'), {
+            ...enhancedOptions
+        }, {
+            overwriteStrategy: OverwriteStrategy.KeepExisting
+        });
         // Update the docs config to add the page entry to the Generator guides sidebar section
-        await (0, ast_1.applyGritQL)(tree, (0, devkit_1.joinPathFragments)('docs', 'astro.config.mjs'), `\`items: [$items]\` where { $items <: within \`sidebar: [$_]\`, $items <: contains \`'ts#project'\`, $items <: not contains \`'/guides/${enhancedOptions.nameKebabCase}'\`, $items += \`, { label: '${name}', link: '/guides/${enhancedOptions.nameKebabCase}' }\` }`);
-    }
-    else {
+        await applyGritQL(tree, joinPathFragments('docs', 'astro.config.mjs'), `\`items: [$items]\` where { $items <: within \`sidebar: [$_]\`, $items <: contains \`'ts#project'\`, $items <: not contains \`'/guides/${enhancedOptions.nameKebabCase}'\`, $items += \`, { label: '${name}', link: '/guides/${enhancedOptions.nameKebabCase}' }\` }`);
+        // Expose the generator from the SDK for known prefixes (ts# / py#)
+        addSdkExport(tree, plugin.root, name, generatorSubDir, enhancedOptions);
+    } else {
         // Local generator in a project other than nx-plugin-for-aws
-        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, 'files', 'local'), generatorDir, {
-            ...enhancedOptions,
-        }, { overwriteStrategy: devkit_1.OverwriteStrategy.KeepExisting });
-        const indexPath = (0, devkit_1.joinPathFragments)(sourceRoot, 'index.ts');
+        generateFiles(tree, joinPathFragments(import.meta.dirname, 'files', 'local'), generatorDir, {
+            ...enhancedOptions
+        }, {
+            overwriteStrategy: OverwriteStrategy.KeepExisting
+        });
+        const indexPath = joinPathFragments(sourceRoot, 'index.ts');
         if (tree.exists(indexPath)) {
-            await (0, ast_1.addStarExport)(tree, indexPath, `./${generatorSubDir}/generator`);
+            // ESM projects require the explicit `.js` extension; `addStarExport`
+            // strips it for CommonJS workspaces.
+            await addStarExport(tree, indexPath, `./${generatorSubDir}/generator.js`);
         }
-        (0, nx_1.addComponentGeneratorMetadata)(tree, plugin.name, exports.NX_GENERATOR_GENERATOR_INFO, (0, devkit_1.joinPathFragments)(srcDir, generatorSubDir), name);
+        addComponentGeneratorMetadata(tree, plugin.name, NX_GENERATOR_GENERATOR_INFO, joinPathFragments(srcDir, generatorSubDir), name);
     }
     const factoryBasePath = `./${srcDir}/${generatorSubDir}`;
     // Update generators.json
-    const generatorsJsonPath = (0, devkit_1.joinPathFragments)(plugin.root, 'generators.json');
-    const generatorsJson = tree.exists(generatorsJsonPath)
-        ? (0, devkit_1.readJson)(tree, generatorsJsonPath)
-        : { generators: {} };
+    const generatorsJsonPath = joinPathFragments(plugin.root, 'generators.json');
+    const generatorsJson = tree.exists(generatorsJsonPath) ? readJson(tree, generatorsJsonPath) : {
+        generators: {}
+    };
     // Metrics are only tracked within the @aws/nx-plugin repo. Reuse the existing
     // metric for a same-name re-run, otherwise allocate a new one.
     let metric;
     if (isNxPluginForAws) {
-        const existingMetrics = Object.values(generatorsJson?.generators ?? {})
-            .map((g) => g.metric)
-            .filter((m) => typeof m === 'string');
-        metric =
-            generatorsJson?.generators?.[name]?.metric ??
-                (existingMetrics.length > 0 ? incrementMetric(existingMetrics) : 'g1');
+        const existingMetrics = Object.values(generatorsJson?.generators ?? {}).map((g)=>g.metric).filter((m)=>typeof m === 'string');
+        metric = generatorsJson?.generators?.[name]?.metric ?? (existingMetrics.length > 0 ? incrementMetric(existingMetrics) : 'g1');
     }
-    (0, devkit_1.writeJson)(tree, generatorsJsonPath, {
+    writeJson(tree, generatorsJsonPath, {
         ...generatorsJson,
-        generators: (0, object_1.sortObjectKeys)({
+        generators: sortObjectKeys({
             ...generatorsJson?.generators,
             [name]: {
                 factory: `${factoryBasePath}/generator`,
                 schema: `${factoryBasePath}/schema.json`,
                 description: description ?? 'TODO: Add short description of the generator',
-                ...(isNxPluginForAws ? { metric } : {}),
-            },
-        }),
+                ...isNxPluginForAws ? {
+                    metric
+                } : {}
+            }
+        })
     });
-    await (0, metrics_1.addGeneratorMetricsIfApplicable)(tree, [exports.NX_GENERATOR_GENERATOR_INFO]);
-    await (0, format_1.formatFilesInSubtree)(tree);
-    return () => {
-        (0, devkit_1.installPackagesTask)(tree);
-    };
+    await addGeneratorMetricsIfApplicable(tree, [
+        NX_GENERATOR_GENERATOR_INFO
+    ]);
+    await formatFilesInSubtree(tree);
+    // The generated generator.ts imports @nx/devkit, which must resolve for
+    // Nx to run it (bun's isolated layout doesn't hoist it from @nx/js).
+    return ()=>installDependencies(tree, options.preferInstallDependencies, {
+            languages: [
+                'typescript'
+            ],
+            ensureResolvable: [
+                '@nx/devkit'
+            ]
+        });
 };
-exports.tsNxGeneratorGenerator = tsNxGeneratorGenerator;
-const incrementMetric = (metrics) => {
-    const maxMetric = Math.max(...metrics.map((m) => Number(m.slice(1))));
+const incrementMetric = (metrics)=>{
+    const maxMetric = Math.max(...metrics.map((m)=>Number(m.slice(1))));
     return `g${maxMetric + 1}`;
 };
-exports.default = exports.tsNxGeneratorGenerator;
+// Maps a generator name prefix to the SDK entry point that should re-export it
+const SDK_EXPORT_PREFIXES = {
+    'ts#': 'ts',
+    'py#': 'py'
+};
+// Re-exports a generated generator from the matching SDK entry point so it is
+// available programmatically as part of @aws/nx-plugin's SDK
+const addSdkExport = (tree, pluginRoot, name, generatorSubDir, options)=>{
+    const prefix = Object.keys(SDK_EXPORT_PREFIXES).find((p)=>name.startsWith(p));
+    if (!prefix) {
+        return;
+    }
+    const sdkPath = joinPathFragments(pluginRoot, 'src', 'sdk', `${SDK_EXPORT_PREFIXES[prefix]}.ts`);
+    const generatorExport = `${options.nameCamelCase}Generator`;
+    const schemaExport = `${options.namePascalCase}GeneratorSchema`;
+    const moduleBase = `../${generatorSubDir}`;
+    const contents = tree.exists(sdkPath) ? tree.read(sdkPath).toString() : '';
+    // Idempotent: skip if this generator is already exported
+    if (contents.includes(`${moduleBase}/generator`)) {
+        return;
+    }
+    const block = `// ${options.namePascalCase} Generator\nexport { ${generatorExport} } from '${moduleBase}/generator';\nexport type { ${schemaExport} } from '${moduleBase}/schema';\n`;
+    const prefixContents = contents.trim() ? `${contents.replace(/\s*$/, '')}\n\n` : '';
+    tree.write(sdkPath, `${prefixContents}${block}`);
+};
+export default tsNxGeneratorGenerator;
+
 //# sourceMappingURL=generator.js.map

package/src/ts/nx-generator/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/ts/nx-generator/generator.ts"],"names":[],"mappings":";;;;AAAA;;;GAGG;AACH,uCASoB;AACpB,gFAAyC;AACzC,iFAAgD;AAChD,yCAA6D;AAC7D,+CAA0D;AAC1D,iDAAsE;AACtE,6CAAqE;AACrE,uCAIwB;AACxB,+CAAoD;AACpD,6CAAqE;AACrE,8CAAkE;AAGrD,QAAA,2BAA2B,GAAG,IAAA,qBAAgB,EAAC,UAAU,CAAC,CAAC;AAEjE,MAAM,sBAAsB,GAAG,KAAK,EACzC,IAAU,EACV,OAAqC,EACF,EAAE;IACrC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEzE,MAAM,MAAM,GAAG,IAAA,wCAAmC,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IACxE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,IAAA,0BAAiB,EAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9E,MAAM,eAAe,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,MAAM,GAAG,eAAe,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3D,MAAM,eAAe,GAAG,SAAS,IAAI,IAAA,iBAAS,EAAC,IAAI,CAAC,CAAC;IACrD,MAAM,YAAY,GAAG,IAAA,0BAAiB,EAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IAEpE,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QACjD,CAAC,CAAC,IAAA,iBAAQ,EAAC,IAAI,EAAE,cAAc,CAAC;QAChC,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,gBAAgB,GAAG,eAAe,EAAE,IAAI,KAAK,uBAAuB,CAAC;IAE3E,iDAAiD;IACjD,IAAA,oCAA4B,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAElD,MAAM,eAAe,GAAG;QACtB,IAAI;QACJ,WAAW;QACX,cAAc,EAAE,IAAA,kBAAU,EAAC,IAAI,CAAC;QAChC,aAAa,EAAE,IAAA,0BAAS,EAAC,IAAI,CAAC;QAC9B,aAAa,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC;QAC9B,kBAAkB,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,CAAC,WAAW,EAAE;QACjD,gBAAgB;QAChB,uBAAuB,EAAE,IAAA,wCAAgC,EAAC,eAAe,CAAC;QAC1E,YAAY;QACZ,eAAe;KAChB,CAAC;IAEF,wEAAwE;IACxE,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAC/C,YAAY,EACZ;QACE,GAAG,eAAe;KACnB,EACD,EAAE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY,EAAE,CACtD,CAAC;IAEF,8EAA8E;IAC9E,IAAI,gBAAgB,EAAE,CAAC;QACrB,qDAAqD;QACrD,IAAI,aAAa,KAAK,sBAAW,CAAC,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CACb,qCAAqC,sBAAW,CAAC,IAAI,WAAW,CACjE,CAAC;QACJ,CAAC;QAED,oBAAoB;QACpB,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,EAAE,mBAAmB,EAAE,WAAW,CAAC,EACvE,YAAY,EACZ;YACE,GAAG,eAAe;SACnB,EACD,EAAE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY,EAAE,CACtD,CAAC;QAEF,8BAA8B;QAC9B,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAClE,IAAA,0BAAiB,EAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,EACnE;YACE,GAAG,eAAe;SACnB,EACD,EAAE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY,EAAE,CACtD,CAAC;QAEF,uFAAuF;QACvF,MAAM,IAAA,iBAAW,EACf,IAAI,EACJ,IAAA,0BAAiB,EAAC,MAAM,EAAE,kBAAkB,CAAC,EAC7C,0IAA0I,eAAe,CAAC,aAAa,gCAAgC,IAAI,qBAAqB,eAAe,CAAC,aAAa,SAAS,CACvQ,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,4DAA4D;QAC5D,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAC9C,YAAY,EACZ;YACE,GAAG,eAAe;SACnB,EACD,EAAE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY,EAAE,CACtD,CAAC;QAEF,MAAM,SAAS,GAAG,IAAA,0BAAiB,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAC5D,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAA,mBAAa,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,eAAe,YAAY,CAAC,CAAC;QACzE,CAAC;QAED,IAAA,kCAA6B,EAC3B,IAAI,EACJ,MAAM,CAAC,IAAI,EACX,mCAA2B,EAC3B,IAAA,0BAAiB,EAAC,MAAM,EAAE,eAAe,CAAC,EAC1C,IAAI,CACL,CAAC;IACJ,CAAC;IAED,MAAM,eAAe,GAAG,KAAK,MAAM,IAAI,eAAe,EAAE,CAAC;IAEzD,yBAAyB;IACzB,MAAM,kBAAkB,GAAG,IAAA,0BAAiB,EAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC7E,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;QACpD,CAAC,CAAC,IAAA,iBAAQ,EAAC,IAAI,EAAE,kBAAkB,CAAC;QACpC,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;IACvB,8EAA8E;IAC9E,+DAA+D;IAC/D,IAAI,MAA0B,CAAC;IAC/B,IAAI,gBAAgB,EAAE,CAAC;QACrB,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,UAAU,IAAI,EAAE,CAAC;aACpE,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;aACzB,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;QACrD,MAAM;YACJ,cAAc,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM;gBAC1C,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC3E,CAAC;IACD,IAAA,kBAAS,EAAC,IAAI,EAAE,kBAAkB,EAAE;QAClC,GAAG,cAAc;QACjB,UAAU,EAAE,IAAA,uBAAc,EAAC;YACzB,GAAG,cAAc,EAAE,UAAU;YAC7B,CAAC,IAAI,CAAC,EAAE;gBACN,OAAO,EAAE,GAAG,eAAe,YAAY;gBACvC,MAAM,EAAE,GAAG,eAAe,cAAc;gBACxC,WAAW,EACT,WAAW,IAAI,8CAA8C;gBAC/D,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACxC;SACF,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,IAAA,yCAA+B,EAAC,IAAI,EAAE,CAAC,mCAA2B,CAAC,CAAC,CAAC;IAE3E,MAAM,IAAA,6BAAoB,EAAC,IAAI,CAAC,CAAC;IAEjC,OAAO,GAAG,EAAE;QACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC;AACJ,CAAC,CAAC;AAnJW,QAAA,sBAAsB,0BAmJjC;AAEF,MAAM,eAAe,GAAG,CAAC,OAAiB,EAAU,EAAE;IACpD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,OAAO,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;AAC7B,CAAC,CAAC;AAEF,kBAAe,8BAAsB,CAAC"}
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/ts/nx-generator/generator.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport {\n  type GeneratorCallback,\n  generateFiles,\n  joinPathFragments,\n  OverwriteStrategy,\n  readJson,\n  type Tree,\n  writeJson,\n} from '@nx/devkit';\nimport camelCase from 'lodash.camelcase';\nimport PackageJson from '../../../package.json' with { type: 'json' };\nimport { addStarExport, applyGritQL } from '../../utils/ast.js';\nimport { declareDependencies } from '../../utils/declared-dependencies.js';\nimport { formatFilesInSubtree } from '../../utils/format.js';\nimport { installDependencies } from '../../utils/install.js';\nimport { addGeneratorMetricsIfApplicable } from '../../utils/metrics.js';\nimport { esmVars } from '../../utils/module-format.js';\nimport { kebabCase, pascalCase, snakeCase } from '../../utils/names.js';\nimport {\n  addComponentGeneratorMetadata,\n  getGeneratorInfo,\n  readProjectConfigurationUnqualified,\n} from '../../utils/nx.js';\nimport { sortObjectKeys } from '../../utils/object.js';\nimport { getRelativePathToRootByDirectory } from '../../utils/paths.js';\nimport {\n  configureTsProjectAsNxPlugin,\n  NX_PLUGIN_DEPENDENCIES,\n} from '../nx-plugin/utils.js';\nimport type { TsNxGeneratorGeneratorSchema } from './schema';\n\nexport const DEPENDENCIES = declareDependencies()({\n  ts: [...NX_PLUGIN_DEPENDENCIES],\n});\n\nexport const NX_GENERATOR_GENERATOR_INFO = getGeneratorInfo(\n  import.meta.filename,\n);\n\nexport const tsNxGeneratorGenerator = async (\n  tree: Tree,\n  options: TsNxGeneratorGeneratorSchema,\n): Promise<GeneratorCallback | void> => {\n  const { name, directory, project: pluginProject, description } = options;\n\n  const plugin = readProjectConfigurationUnqualified(tree, pluginProject);\n  const sourceRoot = plugin.sourceRoot ?? joinPathFragments(plugin.root, 'src');\n  const sourceRootParts = sourceRoot.split('/');\n  const srcDir = sourceRootParts[sourceRootParts.length - 1];\n  const generatorSubDir = directory ?? kebabCase(name);\n  const generatorDir = joinPathFragments(sourceRoot, generatorSubDir);\n\n  const rootPackageJson = tree.exists('package.json')\n    ? readJson(tree, 'package.json')\n    : undefined;\n  const isNxPluginForAws = rootPackageJson?.name === '@aws/nx-plugin-source';\n\n  // Configure the targeted project as an Nx Plugin\n  configureTsProjectAsNxPlugin(tree, pluginProject, DEPENDENCIES);\n\n  const enhancedOptions = {\n    name,\n    description,\n    namePascalCase: pascalCase(name),\n    nameCamelCase: camelCase(name),\n    nameKebabCase: kebabCase(name),\n    nameUpperSnakeCase: snakeCase(name).toUpperCase(),\n    isNxPluginForAws,\n    pathToProjectSourceRoot: getRelativePathToRootByDirectory(generatorSubDir),\n    generatorDir,\n    generatorSubDir,\n    ...esmVars(tree),\n  };\n\n  // Add the common files, preserving any the user has already implemented\n  generateFiles(\n    tree,\n    joinPathFragments(import.meta.dirname, 'files', 'common'),\n    generatorDir,\n    {\n      ...enhancedOptions,\n    },\n    { overwriteStrategy: OverwriteStrategy.KeepExisting },\n  );\n\n  // Add the files specific to this repo vs a local generator in another project\n  if (isNxPluginForAws) {\n    // Generators should be in the @aws/nx-plugin project\n    if (pluginProject !== PackageJson.name) {\n      throw new Error(\n        `Generators should be added to the ${PackageJson.name} project.`,\n      );\n    }\n\n    // Add the generator\n    generateFiles(\n      tree,\n      joinPathFragments(\n        import.meta.dirname,\n        'files',\n        'nx-plugin-for-aws',\n        'generator',\n      ),\n      generatorDir,\n      {\n        ...enhancedOptions,\n      },\n      { overwriteStrategy: OverwriteStrategy.KeepExisting },\n    );\n\n    // Generate guide page in docs\n    generateFiles(\n      tree,\n      joinPathFragments(\n        import.meta.dirname,\n        'files',\n        'nx-plugin-for-aws',\n        'docs',\n      ),\n      joinPathFragments('docs', 'src', 'content', 'docs', 'en', 'guides'),\n      {\n        ...enhancedOptions,\n      },\n      { overwriteStrategy: OverwriteStrategy.KeepExisting },\n    );\n\n    // Update the docs config to add the page entry to the Generator guides sidebar section\n    await applyGritQL(\n      tree,\n      joinPathFragments('docs', 'astro.config.mjs'),\n      `\\`items: [$items]\\` where { $items <: within \\`sidebar: [$_]\\`, $items <: contains \\`'ts#project'\\`, $items <: not contains \\`'/guides/${enhancedOptions.nameKebabCase}'\\`, $items += \\`, { label: '${name}', link: '/guides/${enhancedOptions.nameKebabCase}' }\\` }`,\n    );\n\n    // Expose the generator from the SDK for known prefixes (ts# / py#)\n    addSdkExport(tree, plugin.root, name, generatorSubDir, enhancedOptions);\n  } else {\n    // Local generator in a project other than nx-plugin-for-aws\n    generateFiles(\n      tree,\n      joinPathFragments(import.meta.dirname, 'files', 'local'),\n      generatorDir,\n      {\n        ...enhancedOptions,\n      },\n      { overwriteStrategy: OverwriteStrategy.KeepExisting },\n    );\n\n    const indexPath = joinPathFragments(sourceRoot, 'index.ts');\n    if (tree.exists(indexPath)) {\n      // ESM projects require the explicit `.js` extension; `addStarExport`\n      // strips it for CommonJS workspaces.\n      await addStarExport(tree, indexPath, `./${generatorSubDir}/generator.js`);\n    }\n\n    addComponentGeneratorMetadata(\n      tree,\n      plugin.name,\n      NX_GENERATOR_GENERATOR_INFO,\n      joinPathFragments(srcDir, generatorSubDir),\n      name,\n    );\n  }\n\n  const factoryBasePath = `./${srcDir}/${generatorSubDir}`;\n\n  // Update generators.json\n  const generatorsJsonPath = joinPathFragments(plugin.root, 'generators.json');\n  const generatorsJson = tree.exists(generatorsJsonPath)\n    ? readJson(tree, generatorsJsonPath)\n    : { generators: {} };\n  // Metrics are only tracked within the @aws/nx-plugin repo. Reuse the existing\n  // metric for a same-name re-run, otherwise allocate a new one.\n  let metric: string | undefined;\n  if (isNxPluginForAws) {\n    const existingMetrics = Object.values(generatorsJson?.generators ?? {})\n      .map((g: any) => g.metric)\n      .filter((m): m is string => typeof m === 'string');\n    metric =\n      generatorsJson?.generators?.[name]?.metric ??\n      (existingMetrics.length > 0 ? incrementMetric(existingMetrics) : 'g1');\n  }\n  writeJson(tree, generatorsJsonPath, {\n    ...generatorsJson,\n    generators: sortObjectKeys({\n      ...generatorsJson?.generators,\n      [name]: {\n        factory: `${factoryBasePath}/generator`,\n        schema: `${factoryBasePath}/schema.json`,\n        description:\n          description ?? 'TODO: Add short description of the generator',\n        ...(isNxPluginForAws ? { metric } : {}),\n      },\n    }),\n  });\n\n  await addGeneratorMetricsIfApplicable(tree, [NX_GENERATOR_GENERATOR_INFO]);\n\n  await formatFilesInSubtree(tree);\n\n  // The generated generator.ts imports @nx/devkit, which must resolve for\n  // Nx to run it (bun's isolated layout doesn't hoist it from @nx/js).\n  return () =>\n    installDependencies(tree, options.preferInstallDependencies, {\n      languages: ['typescript'],\n      ensureResolvable: ['@nx/devkit'],\n    });\n};\n\nconst incrementMetric = (metrics: string[]): string => {\n  const maxMetric = Math.max(...metrics.map((m) => Number(m.slice(1))));\n  return `g${maxMetric + 1}`;\n};\n\n// Maps a generator name prefix to the SDK entry point that should re-export it\nconst SDK_EXPORT_PREFIXES: Record<string, string> = {\n  'ts#': 'ts',\n  'py#': 'py',\n};\n\n// Re-exports a generated generator from the matching SDK entry point so it is\n// available programmatically as part of @aws/nx-plugin's SDK\nconst addSdkExport = (\n  tree: Tree,\n  pluginRoot: string,\n  name: string,\n  generatorSubDir: string,\n  options: { nameCamelCase: string; namePascalCase: string },\n): void => {\n  const prefix = Object.keys(SDK_EXPORT_PREFIXES).find((p) =>\n    name.startsWith(p),\n  );\n  if (!prefix) {\n    return;\n  }\n\n  const sdkPath = joinPathFragments(\n    pluginRoot,\n    'src',\n    'sdk',\n    `${SDK_EXPORT_PREFIXES[prefix]}.ts`,\n  );\n  const generatorExport = `${options.nameCamelCase}Generator`;\n  const schemaExport = `${options.namePascalCase}GeneratorSchema`;\n  const moduleBase = `../${generatorSubDir}`;\n\n  const contents = tree.exists(sdkPath) ? tree.read(sdkPath).toString() : '';\n  // Idempotent: skip if this generator is already exported\n  if (contents.includes(`${moduleBase}/generator`)) {\n    return;\n  }\n\n  const block = `// ${options.namePascalCase} Generator\\nexport { ${generatorExport} } from '${moduleBase}/generator';\\nexport type { ${schemaExport} } from '${moduleBase}/schema';\\n`;\n\n  const prefixContents = contents.trim()\n    ? `${contents.replace(/\\s*$/, '')}\\n\\n`\n    : '';\n  tree.write(sdkPath, `${prefixContents}${block}`);\n};\n\nexport default tsNxGeneratorGenerator;\n"],"names":["generateFiles","joinPathFragments","OverwriteStrategy","readJson","writeJson","camelCase","PackageJson","type","addStarExport","applyGritQL","declareDependencies","formatFilesInSubtree","installDependencies","addGeneratorMetricsIfApplicable","esmVars","kebabCase","pascalCase","snakeCase","addComponentGeneratorMetadata","getGeneratorInfo","readProjectConfigurationUnqualified","sortObjectKeys","getRelativePathToRootByDirectory","configureTsProjectAsNxPlugin","NX_PLUGIN_DEPENDENCIES","DEPENDENCIES","ts","NX_GENERATOR_GENERATOR_INFO","filename","tsNxGeneratorGenerator","tree","options","name","directory","project","pluginProject","description","plugin","sourceRoot","root","sourceRootParts","split","srcDir","length","generatorSubDir","generatorDir","rootPackageJson","exists","undefined","isNxPluginForAws","enhancedOptions","namePascalCase","nameCamelCase","nameKebabCase","nameUpperSnakeCase","toUpperCase","pathToProjectSourceRoot","dirname","overwriteStrategy","KeepExisting","Error","addSdkExport","indexPath","factoryBasePath","generatorsJsonPath","generatorsJson","generators","metric","existingMetrics","Object","values","map","g","filter","m","incrementMetric","factory","schema","preferInstallDependencies","languages","ensureResolvable","metrics","maxMetric","Math","max","Number","slice","SDK_EXPORT_PREFIXES","pluginRoot","prefix","keys","find","p","startsWith","sdkPath","generatorExport","schemaExport","moduleBase","contents","read","toString","includes","block","prefixContents","trim","replace","write"],"mappings":"AAAA;;;CAGC,GACD,SAEEA,aAAa,EACbC,iBAAiB,EACjBC,iBAAiB,EACjBC,QAAQ,EAERC,SAAS,QACJ,aAAa;AACpB,OAAOC,eAAe,mBAAmB;AACzC,OAAOC,iBAAiB,6BAA6B;IAAEC,MAAM;AAAO,EAAE;AACtE,SAASC,aAAa,EAAEC,WAAW,QAAQ,qBAAqB;AAChE,SAASC,mBAAmB,QAAQ,uCAAuC;AAC3E,SAASC,oBAAoB,QAAQ,wBAAwB;AAC7D,SAASC,mBAAmB,QAAQ,yBAAyB;AAC7D,SAASC,+BAA+B,QAAQ,yBAAyB;AACzE,SAASC,OAAO,QAAQ,+BAA+B;AACvD,SAASC,SAAS,EAAEC,UAAU,EAAEC,SAAS,QAAQ,uBAAuB;AACxE,SACEC,6BAA6B,EAC7BC,gBAAgB,EAChBC,mCAAmC,QAC9B,oBAAoB;AAC3B,SAASC,cAAc,QAAQ,wBAAwB;AACvD,SAASC,gCAAgC,QAAQ,uBAAuB;AACxE,SACEC,4BAA4B,EAC5BC,sBAAsB,QACjB,wBAAwB;AAG/B,OAAO,MAAMC,eAAef,sBAAsB;IAChDgB,IAAI;WAAIF;KAAuB;AACjC,GAAG;AAEH,OAAO,MAAMG,8BAA8BR,iBACzC,YAAYS,QAAQ,EACpB;AAEF,OAAO,MAAMC,yBAAyB,OACpCC,MACAC;IAEA,MAAM,EAAEC,IAAI,EAAEC,SAAS,EAAEC,SAASC,aAAa,EAAEC,WAAW,EAAE,GAAGL;IAEjE,MAAMM,SAASjB,oCAAoCU,MAAMK;IACzD,MAAMG,aAAaD,OAAOC,UAAU,IAAIrC,kBAAkBoC,OAAOE,IAAI,EAAE;IACvE,MAAMC,kBAAkBF,WAAWG,KAAK,CAAC;IACzC,MAAMC,SAASF,eAAe,CAACA,gBAAgBG,MAAM,GAAG,EAAE;IAC1D,MAAMC,kBAAkBX,aAAalB,UAAUiB;IAC/C,MAAMa,eAAe5C,kBAAkBqC,YAAYM;IAEnD,MAAME,kBAAkBhB,KAAKiB,MAAM,CAAC,kBAChC5C,SAAS2B,MAAM,kBACfkB;IACJ,MAAMC,mBAAmBH,iBAAiBd,SAAS;IAEnD,iDAAiD;IACjDT,6BAA6BO,MAAMK,eAAeV;IAElD,MAAMyB,kBAAkB;QACtBlB;QACAI;QACAe,gBAAgBnC,WAAWgB;QAC3BoB,eAAe/C,UAAU2B;QACzBqB,eAAetC,UAAUiB;QACzBsB,oBAAoBrC,UAAUe,MAAMuB,WAAW;QAC/CN;QACAO,yBAAyBlC,iCAAiCsB;QAC1DC;QACAD;QACA,GAAG9B,QAAQgB,KAAK;IAClB;IAEA,wEAAwE;IACxE9B,cACE8B,MACA7B,kBAAkB,YAAYwD,OAAO,EAAE,SAAS,WAChDZ,cACA;QACE,GAAGK,eAAe;IACpB,GACA;QAAEQ,mBAAmBxD,kBAAkByD,YAAY;IAAC;IAGtD,8EAA8E;IAC9E,IAAIV,kBAAkB;QACpB,qDAAqD;QACrD,IAAId,kBAAkB7B,YAAY0B,IAAI,EAAE;YACtC,MAAM,IAAI4B,MACR,CAAC,kCAAkC,EAAEtD,YAAY0B,IAAI,CAAC,SAAS,CAAC;QAEpE;QAEA,oBAAoB;QACpBhC,cACE8B,MACA7B,kBACE,YAAYwD,OAAO,EACnB,SACA,qBACA,cAEFZ,cACA;YACE,GAAGK,eAAe;QACpB,GACA;YAAEQ,mBAAmBxD,kBAAkByD,YAAY;QAAC;QAGtD,8BAA8B;QAC9B3D,cACE8B,MACA7B,kBACE,YAAYwD,OAAO,EACnB,SACA,qBACA,SAEFxD,kBAAkB,QAAQ,OAAO,WAAW,QAAQ,MAAM,WAC1D;YACE,GAAGiD,eAAe;QACpB,GACA;YAAEQ,mBAAmBxD,kBAAkByD,YAAY;QAAC;QAGtD,uFAAuF;QACvF,MAAMlD,YACJqB,MACA7B,kBAAkB,QAAQ,qBAC1B,CAAC,uIAAuI,EAAEiD,gBAAgBG,aAAa,CAAC,6BAA6B,EAAErB,KAAK,kBAAkB,EAAEkB,gBAAgBG,aAAa,CAAC,OAAO,CAAC;QAGxQ,mEAAmE;QACnEQ,aAAa/B,MAAMO,OAAOE,IAAI,EAAEP,MAAMY,iBAAiBM;IACzD,OAAO;QACL,4DAA4D;QAC5DlD,cACE8B,MACA7B,kBAAkB,YAAYwD,OAAO,EAAE,SAAS,UAChDZ,cACA;YACE,GAAGK,eAAe;QACpB,GACA;YAAEQ,mBAAmBxD,kBAAkByD,YAAY;QAAC;QAGtD,MAAMG,YAAY7D,kBAAkBqC,YAAY;QAChD,IAAIR,KAAKiB,MAAM,CAACe,YAAY;YAC1B,qEAAqE;YACrE,qCAAqC;YACrC,MAAMtD,cAAcsB,MAAMgC,WAAW,CAAC,EAAE,EAAElB,gBAAgB,aAAa,CAAC;QAC1E;QAEA1B,8BACEY,MACAO,OAAOL,IAAI,EACXL,6BACA1B,kBAAkByC,QAAQE,kBAC1BZ;IAEJ;IAEA,MAAM+B,kBAAkB,CAAC,EAAE,EAAErB,OAAO,CAAC,EAAEE,iBAAiB;IAExD,yBAAyB;IACzB,MAAMoB,qBAAqB/D,kBAAkBoC,OAAOE,IAAI,EAAE;IAC1D,MAAM0B,iBAAiBnC,KAAKiB,MAAM,CAACiB,sBAC/B7D,SAAS2B,MAAMkC,sBACf;QAAEE,YAAY,CAAC;IAAE;IACrB,8EAA8E;IAC9E,+DAA+D;IAC/D,IAAIC;IACJ,IAAIlB,kBAAkB;QACpB,MAAMmB,kBAAkBC,OAAOC,MAAM,CAACL,gBAAgBC,cAAc,CAAC,GAClEK,GAAG,CAAC,CAACC,IAAWA,EAAEL,MAAM,EACxBM,MAAM,CAAC,CAACC,IAAmB,OAAOA,MAAM;QAC3CP,SACEF,gBAAgBC,YAAY,CAAClC,KAAK,EAAEmC,UACnCC,CAAAA,gBAAgBzB,MAAM,GAAG,IAAIgC,gBAAgBP,mBAAmB,IAAG;IACxE;IACAhE,UAAU0B,MAAMkC,oBAAoB;QAClC,GAAGC,cAAc;QACjBC,YAAY7C,eAAe;YACzB,GAAG4C,gBAAgBC,UAAU;YAC7B,CAAClC,KAAK,EAAE;gBACN4C,SAAS,GAAGb,gBAAgB,UAAU,CAAC;gBACvCc,QAAQ,GAAGd,gBAAgB,YAAY,CAAC;gBACxC3B,aACEA,eAAe;gBACjB,GAAIa,mBAAmB;oBAAEkB;gBAAO,IAAI,CAAC,CAAC;YACxC;QACF;IACF;IAEA,MAAMtD,gCAAgCiB,MAAM;QAACH;KAA4B;IAEzE,MAAMhB,qBAAqBmB;IAE3B,wEAAwE;IACxE,qEAAqE;IACrE,OAAO,IACLlB,oBAAoBkB,MAAMC,QAAQ+C,yBAAyB,EAAE;YAC3DC,WAAW;gBAAC;aAAa;YACzBC,kBAAkB;gBAAC;aAAa;QAClC;AACJ,EAAE;AAEF,MAAML,kBAAkB,CAACM;IACvB,MAAMC,YAAYC,KAAKC,GAAG,IAAIH,QAAQV,GAAG,CAAC,CAACG,IAAMW,OAAOX,EAAEY,KAAK,CAAC;IAChE,OAAO,CAAC,CAAC,EAAEJ,YAAY,GAAG;AAC5B;AAEA,+EAA+E;AAC/E,MAAMK,sBAA8C;IAClD,OAAO;IACP,OAAO;AACT;AAEA,8EAA8E;AAC9E,6DAA6D;AAC7D,MAAM1B,eAAe,CACnB/B,MACA0D,YACAxD,MACAY,iBACAb;IAEA,MAAM0D,SAASpB,OAAOqB,IAAI,CAACH,qBAAqBI,IAAI,CAAC,CAACC,IACpD5D,KAAK6D,UAAU,CAACD;IAElB,IAAI,CAACH,QAAQ;QACX;IACF;IAEA,MAAMK,UAAU7F,kBACduF,YACA,OACA,OACA,GAAGD,mBAAmB,CAACE,OAAO,CAAC,GAAG,CAAC;IAErC,MAAMM,kBAAkB,GAAGhE,QAAQqB,aAAa,CAAC,SAAS,CAAC;IAC3D,MAAM4C,eAAe,GAAGjE,QAAQoB,cAAc,CAAC,eAAe,CAAC;IAC/D,MAAM8C,aAAa,CAAC,GAAG,EAAErD,iBAAiB;IAE1C,MAAMsD,WAAWpE,KAAKiB,MAAM,CAAC+C,WAAWhE,KAAKqE,IAAI,CAACL,SAASM,QAAQ,KAAK;IACxE,yDAAyD;IACzD,IAAIF,SAASG,QAAQ,CAAC,GAAGJ,WAAW,UAAU,CAAC,GAAG;QAChD;IACF;IAEA,MAAMK,QAAQ,CAAC,GAAG,EAAEvE,QAAQoB,cAAc,CAAC,qBAAqB,EAAE4C,gBAAgB,SAAS,EAAEE,WAAW,4BAA4B,EAAED,aAAa,SAAS,EAAEC,WAAW,WAAW,CAAC;IAErL,MAAMM,iBAAiBL,SAASM,IAAI,KAChC,GAAGN,SAASO,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,GACrC;IACJ3E,KAAK4E,KAAK,CAACZ,SAAS,GAAGS,iBAAiBD,OAAO;AACjD;AAEA,eAAezE,uBAAuB"}

package/src/ts/nx-generator/schema.d.js

@@ -0,0 +1,6 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ export { };
+
+//# sourceMappingURL=schema.d.js.map

package/src/ts/nx-generator/schema.d.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/ts/nx-generator/schema.d.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\n\nexport interface TsNxGeneratorGeneratorSchema {\n  project: string;\n  name: string;\n  directory?: string;\n  description?: string;\n  preferInstallDependencies?: boolean;\n}\n"],"names":[],"mappings":"AAAA;;;CAGC,GAED,WAMC"}

package/src/ts/nx-generator/schema.d.ts

@@ -8,4 +8,5 @@ export interface TsNxGeneratorGeneratorSchema {
   name: string;
   directory?: string;
   description?: string;
+  preferInstallDependencies?: boolean;
 }

package/src/ts/nx-generator/schema.json

@@ -32,6 +32,11 @@
       "type": "string",
       "description": "The directory within the plugin project's source folder to add the generator to (default: <name>)",
       "x-prompt": "Choose the directory you would like to generate the generator in relative to the project's source folder (default: <name>)"
+    },
+    "preferInstallDependencies": {
+      "type": "boolean",
+      "description": "Whether to prefer installing dependencies after the generator runs. Set to false to defer installing when batching multiple generators (an install still runs if needed so subsequent generators can compute the Nx project graph); install once at the end.",
+      "default": true
     }
   },
   "required": ["project", "name"]

package/src/ts/nx-migration/files/migration.spec.ts.template

@@ -0,0 +1,26 @@
+import type { Tree } from '@nx/devkit';
+import { createTreeUsingTsSolutionSetup } from '<%- testImportPath %>';
+import migration from './migration<% if (esm) { %>.js<% } %>';
+
+describe('<%= name %> migration', () => {
+  let tree: Tree;
+
+  beforeEach(() => {
+    tree = createTreeUsingTsSolutionSetup();
+  });
+
+  it('should apply to the shape your generators produce', async () => {
+    // TODO: arrange the "before" state and assert the expected changes.
+    const result = await migration(tree);
+    expect(result.nextSteps).toBeDefined();
+  });
+
+  it('should skip and report a customised file', () => {
+    // TODO: arrange a diverged file and assert it is left untouched and
+    // reported via nextSteps.
+  });
+
+  it('should be idempotent', () => {
+    // TODO: run the migration twice and assert the second run is a no-op.
+  });
+});

package/src/ts/nx-migration/files/migration.ts.template

@@ -0,0 +1,65 @@
+import { type MigrationReturnObject, type Tree } from '@nx/devkit';
+import { formatFilesInSubtree } from '<%- formatImportPath %>';
+
+/**
+ * <%= description %>
+<%_ if (isHybrid) { _%>
+ *
+ * Hybrid migration: this codemod does the mechanical part, then the paired
+ * prompt (prompt.md) hands off to the user's agent for the rest.
+ *
+ * How to write a migration:
+ * - https://nx.dev/docs/kb/migration-generators
+ * - `nextSteps` and `agentContext`: https://nx.dev/docs/reference/devkit/MigrationReturnObject
+ *
+ * Guardrails:
+ * - Transform source with GritQL (`applyGritQL`, `matchGritQL`), not regexes or
+ *   string replacements: it matches the AST, so it holds up against however the
+ *   user's copy has been formatted. Use `updateJson` for JSON.
+ * - Pattern-match before writing: skip files that have diverged from the shape
+ *   your generators produce, and report them via `agentContext` so the prompt
+ *   can pick them up, rather than clobbering the user's changes.
+ * - `nextSteps` is for work left for the user to do by hand, not a log of the
+ *   edits you made: an edit that applied cleanly needs no entry.
+ * - Idempotent: re-running must be a no-op.
+ * - Format what you write: finish with `formatFilesInSubtree` so the files your
+ *   migration wrote are formatted correctly.
+ */
+<%_ } else { _%>
+ *
+ * How to write a migration:
+ * - https://nx.dev/docs/kb/migration-generators
+ * - What `nextSteps` means: https://nx.dev/docs/reference/devkit/MigrationReturnObject
+ *
+ * Guardrails:
+ * - Transform source with GritQL (`applyGritQL`, `matchGritQL`), not regexes or
+ *   string replacements: it matches the AST, so it holds up against however the
+ *   user's copy has been formatted. Use `updateJson` for JSON.
+ * - Pattern-match before writing: skip files that have diverged from the shape
+ *   your generators produce and report them via `nextSteps`, or consider a
+ *   hybrid migration, rather than clobbering the user's changes.
+ * - `nextSteps` is for work left for the user to do by hand, not a log of the
+ *   edits you made: an edit that applied cleanly needs no entry.
+ * - Idempotent: re-running must be a no-op.
+ * - Format what you write: finish with `formatFilesInSubtree` so the files your
+ *   migration wrote are formatted correctly.
+ */
+<%_ } _%>
+export default async function migration(
+  tree: Tree,
+): Promise<MigrationReturnObject> {
+  const nextSteps: string[] = [];
+<% if (isHybrid) { %>  const agentContext: string[] = [];
+<% } %>
+  // TODO: read the workspace's files and update the ones matching the shape
+  // your generators produce, noting any you skip in `nextSteps`.
+<% if (isHybrid) { %>
+  // `agentContext` reaches the paired prompt under `--agentic` and is dropped
+  // otherwise.
+  // TODO: describe what changed in `agentContext`, e.g.:
+  // agentContext.push('Renamed the `foo` target to `bar` in every project.json.');
+<% } %>
+  await formatFilesInSubtree(tree);
+
+  return { nextSteps<% if (isHybrid) { %>, agentContext<% } %> };
+}