@aws/nx-plugin 1.0.0-rc.5 → 1.0.0-rc.50

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

@@ -1,32 +1,35 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tsNxPluginGenerator = exports.TS_NX_PLUGIN_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 nx_1 = require("../../utils/nx");
-const metrics_1 = require("../../utils/metrics");
-const format_1 = require("../../utils/format");
-const generator_1 = tslib_1.__importStar(require("../lib/generator"));
-const utils_1 = require("./utils");
-const generator_2 = tslib_1.__importDefault(require("../mcp-server/generator"));
-exports.TS_NX_PLUGIN_GENERATOR_INFO = (0, nx_1.getGeneratorInfo)(__filename);
-const tsNxPluginGenerator = async (tree, options) => {
+ */ import { generateFiles, joinPathFragments, OverwriteStrategy, updateProjectConfiguration } from "@nx/devkit";
+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 { addDependencyToTargetIfNotPresent, addGeneratorMetadata, getGeneratorInfo, readProjectConfigurationUnqualified } from "../../utils/nx.js";
+import { sortObjectKeys } from "../../utils/object.js";
+import tsProjectGenerator, { getTsLibDetails } from "../lib/generator.js";
+import tsMcpServerGenerator from "../mcp-server/generator.js";
+import { configureTsProjectAsNxPlugin } from "./utils.js";
+export const TS_NX_PLUGIN_GENERATOR_INFO = getGeneratorInfo(import.meta.filename);
+export const tsNxPluginGenerator = async (tree, options)=>{
     // Generate a TypeScript project as the base
-    const { fullyQualifiedName, dir } = (0, generator_1.getTsLibDetails)(tree, options);
-    await (0, generator_1.default)(tree, options);
+    const { fullyQualifiedName, dir } = getTsLibDetails(tree, options);
+    await tsProjectGenerator(tree, {
+        ...options,
+        preferInstallDependencies: false
+    });
     // Configure the typescript project as an Nx Plugin
-    (0, utils_1.configureTsProjectAsNxPlugin)(tree, fullyQualifiedName);
+    configureTsProjectAsNxPlugin(tree, fullyQualifiedName);
     // Add a "package" target which creates a package which can be published to NPM
-    const project = (0, nx_1.readProjectConfigurationUnqualified)(tree, fullyQualifiedName);
+    const project = readProjectConfigurationUnqualified(tree, fullyQualifiedName);
     project.targets = {
         ...project.targets,
         package: {
             executor: '@nx/js:tsc',
-            outputs: ['{options.outputPath}'],
+            outputs: [
+                '{options.outputPath}'
+            ],
             options: {
                 outputPath: `dist/{projectRoot}/package`,
                 main: `{projectRoot}/src/index.ts`,
@@ -38,59 +41,67 @@ const tsNxPluginGenerator = async (tree, options) => {
                     {
                         input: './{projectRoot}/src',
                         glob: '**/!(*.ts)',
-                        output: './src',
+                        output: './src'
                     },
                     {
                         input: './{projectRoot}/src',
                         glob: '**/*.d.ts',
-                        output: './src',
+                        output: './src'
                     },
                     {
                         input: './{projectRoot}',
                         glob: 'generators.json',
-                        output: '.',
+                        output: '.'
                     },
                     {
                         input: './{projectRoot}',
                         glob: 'executors.json',
-                        output: '.',
-                    },
-                ],
-            },
+                        output: '.'
+                    }
+                ]
+            }
         },
         build: {
-            dependsOn: [
-                ...(project.targets?.build?.dependsOn ?? []).filter((d) => typeof d !== 'string' || d !== 'package'),
-                'package',
-            ],
-        },
+            ...project.targets?.build
+        }
     };
-    (0, devkit_1.updateProjectConfiguration)(tree, fullyQualifiedName, project);
-    // Remove the hello world example from index.ts
-    tree.write((0, devkit_1.joinPathFragments)(project.sourceRoot, 'index.ts'), '');
+    // Append the package dependency without moving an existing entry, so re-runs
+    // do not reorder the build dependencies.
+    addDependencyToTargetIfNotPresent(project, 'build', 'package');
+    // Sort targets so their order is stable regardless of insertion order.
+    project.targets = sortObjectKeys(project.targets);
+    updateProjectConfiguration(tree, fullyQualifiedName, project);
     // Add an MCP Server
-    await (0, generator_2.default)(tree, {
+    await tsMcpServerGenerator(tree, {
         project: fullyQualifiedName,
         infra: 'none',
-        iac: 'cdk', // not used
+        iac: 'cdk',
+        preferInstallDependencies: false
     });
-    const mcpPath = (0, devkit_1.joinPathFragments)(project.sourceRoot, 'mcp-server');
-    const mcpServerPath = (0, devkit_1.joinPathFragments)(mcpPath, 'server.ts');
+    const mcpPath = joinPathFragments(project.sourceRoot, 'mcp-server');
+    const mcpServerPath = joinPathFragments(mcpPath, 'server.ts');
     // Remove the sample server and tools
     tree.delete(mcpServerPath);
-    tree.delete((0, devkit_1.joinPathFragments)(mcpPath, 'tools', 'add.ts'));
-    tree.delete((0, devkit_1.joinPathFragments)(mcpPath, 'resources', 'sample-guidance.ts'));
+    tree.delete(joinPathFragments(mcpPath, 'tools', 'add.ts'));
+    tree.delete(joinPathFragments(mcpPath, 'resources', 'sample-guidance.ts'));
     // Add generator MCP server
-    (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, 'files', 'mcp-server'), mcpPath, {
+    generateFiles(tree, joinPathFragments(import.meta.dirname, 'files', 'mcp-server'), mcpPath, {
         name: fullyQualifiedName,
-    }, { overwriteStrategy: devkit_1.OverwriteStrategy.KeepExisting });
-    (0, nx_1.addGeneratorMetadata)(tree, project.name, exports.TS_NX_PLUGIN_GENERATOR_INFO);
-    await (0, metrics_1.addGeneratorMetricsIfApplicable)(tree, [exports.TS_NX_PLUGIN_GENERATOR_INFO]);
-    await (0, format_1.formatFilesInSubtree)(tree);
-    return () => {
-        (0, devkit_1.installPackagesTask)(tree);
-    };
+        ...esmVars(tree)
+    }, {
+        overwriteStrategy: OverwriteStrategy.KeepExisting
+    });
+    addGeneratorMetadata(tree, project.name, TS_NX_PLUGIN_GENERATOR_INFO);
+    await addGeneratorMetricsIfApplicable(tree, [
+        TS_NX_PLUGIN_GENERATOR_INFO
+    ]);
+    await formatFilesInSubtree(tree);
+    return ()=>installDependencies(tree, options.preferInstallDependencies, {
+            languages: [
+                'typescript'
+            ]
+        });
 };
-exports.tsNxPluginGenerator = tsNxPluginGenerator;
-exports.default = exports.tsNxPluginGenerator;
+export default tsNxPluginGenerator;
+
 //# sourceMappingURL=generator.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/ts/nx-plugin/generator.ts"],"names":[],"mappings":";;;;AAAA;;;GAGG;AACH,uCASoB;AAEpB,uCAKwB;AACxB,iDAAsE;AACtE,+CAA0D;AAC1D,sEAAuE;AACvE,mCAAuD;AACvD,gFAA2D;AAE9C,QAAA,2BAA2B,GACtC,IAAA,qBAAgB,EAAC,UAAU,CAAC,CAAC;AAExB,MAAM,mBAAmB,GAAG,KAAK,EACtC,IAAU,EACV,OAAkC,EACN,EAAE;IAC9B,4CAA4C;IAC5C,MAAM,EAAE,kBAAkB,EAAE,GAAG,EAAE,GAAG,IAAA,2BAAe,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnE,MAAM,IAAA,mBAAkB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAExC,mDAAmD;IACnD,IAAA,oCAA4B,EAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;IAEvD,+EAA+E;IAC/E,MAAM,OAAO,GAAG,IAAA,wCAAmC,EAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;IAC9E,OAAO,CAAC,OAAO,GAAG;QAChB,GAAG,OAAO,CAAC,OAAO;QAClB,OAAO,EAAE;YACP,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,CAAC,sBAAsB,CAAC;YACjC,OAAO,EAAE;gBACP,UAAU,EAAE,4BAA4B;gBACxC,IAAI,EAAE,4BAA4B;gBAClC,QAAQ,EAAE,iCAAiC;gBAC3C,MAAM,EAAE;oBACN,oBAAoB;oBACpB,wBAAwB;oBACxB,sBAAsB;oBACtB;wBACE,KAAK,EAAE,qBAAqB;wBAC5B,IAAI,EAAE,YAAY;wBAClB,MAAM,EAAE,OAAO;qBAChB;oBACD;wBACE,KAAK,EAAE,qBAAqB;wBAC5B,IAAI,EAAE,WAAW;wBACjB,MAAM,EAAE,OAAO;qBAChB;oBACD;wBACE,KAAK,EAAE,iBAAiB;wBACxB,IAAI,EAAE,iBAAiB;wBACvB,MAAM,EAAE,GAAG;qBACZ;oBACD;wBACE,KAAK,EAAE,iBAAiB;wBACxB,IAAI,EAAE,gBAAgB;wBACtB,MAAM,EAAE,GAAG;qBACZ;iBACF;aACF;SACF;QACD,KAAK,EAAE;YACL,SAAS,EAAE;gBACT,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CACjD,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,SAAS,CAChD;gBACD,SAAS;aACV;SACF;KACF,CAAC;IACF,IAAA,mCAA0B,EAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAE9D,+CAA+C;IAC/C,IAAI,CAAC,KAAK,CAAC,IAAA,0BAAiB,EAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;IAElE,oBAAoB;IACpB,MAAM,IAAA,mBAAoB,EAAC,IAAI,EAAE;QAC/B,OAAO,EAAE,kBAAkB;QAC3B,KAAK,EAAE,MAAM;QACb,GAAG,EAAE,KAAK,EAAE,WAAW;KACxB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,0BAAiB,EAAC,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,IAAA,0BAAiB,EAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAE9D,qCAAqC;IACrC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAC3B,IAAI,CAAC,MAAM,CAAC,IAAA,0BAAiB,EAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3D,IAAI,CAAC,MAAM,CAAC,IAAA,0BAAiB,EAAC,OAAO,EAAE,WAAW,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAE3E,2BAA2B;IAC3B,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,EAAE,YAAY,CAAC,EACnD,OAAO,EACP;QACE,IAAI,EAAE,kBAAkB;KACzB,EACD,EAAE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY,EAAE,CACtD,CAAC;IAEF,IAAA,yBAAoB,EAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,mCAA2B,CAAC,CAAC;IAEtE,MAAM,IAAA,yCAA+B,EAAC,IAAI,EAAE,CAAC,mCAA2B,CAAC,CAAC,CAAC;IAE3E,MAAM,IAAA,6BAAoB,EAAC,IAAI,CAAC,CAAC;IACjC,OAAO,GAAG,EAAE;QACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC;AACJ,CAAC,CAAC;AAjGW,QAAA,mBAAmB,uBAiG9B;AAEF,kBAAe,2BAAmB,CAAC"}
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/ts/nx-plugin/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  type Tree,\n  updateJson,\n  updateProjectConfiguration,\n} from '@nx/devkit';\nimport { formatFilesInSubtree } from '../../utils/format';\nimport { installDependencies } from '../../utils/install';\nimport { addGeneratorMetricsIfApplicable } from '../../utils/metrics';\nimport { esmVars } from '../../utils/module-format';\nimport {\n  addDependencyToTargetIfNotPresent,\n  addGeneratorMetadata,\n  getGeneratorInfo,\n  type NxGeneratorInfo,\n  readProjectConfigurationUnqualified,\n} from '../../utils/nx';\nimport { sortObjectKeys } from '../../utils/object';\nimport tsProjectGenerator, { getTsLibDetails } from '../lib/generator';\nimport tsMcpServerGenerator from '../mcp-server/generator';\nimport type { TsNxPluginGeneratorSchema } from './schema';\nimport { configureTsProjectAsNxPlugin } from './utils';\n\nexport const TS_NX_PLUGIN_GENERATOR_INFO: NxGeneratorInfo = getGeneratorInfo(\n  import.meta.filename,\n);\n\nexport const tsNxPluginGenerator = async (\n  tree: Tree,\n  options: TsNxPluginGeneratorSchema,\n): Promise<GeneratorCallback> => {\n  // Generate a TypeScript project as the base\n  const { fullyQualifiedName, dir } = getTsLibDetails(tree, options);\n  await tsProjectGenerator(tree, {\n    ...options,\n    preferInstallDependencies: false,\n  });\n\n  // Configure the typescript project as an Nx Plugin\n  configureTsProjectAsNxPlugin(tree, fullyQualifiedName);\n\n  // Add a \"package\" target which creates a package which can be published to NPM\n  const project = readProjectConfigurationUnqualified(tree, fullyQualifiedName);\n  project.targets = {\n    ...project.targets,\n    package: {\n      executor: '@nx/js:tsc',\n      outputs: ['{options.outputPath}'],\n      options: {\n        outputPath: `dist/{projectRoot}/package`,\n        main: `{projectRoot}/src/index.ts`,\n        tsConfig: `{projectRoot}/tsconfig.lib.json`,\n        assets: [\n          `{projectRoot}/*.md`,\n          `{projectRoot}/LICENSE*`,\n          `{projectRoot}/NOTICE`,\n          {\n            input: './{projectRoot}/src',\n            glob: '**/!(*.ts)',\n            output: './src',\n          },\n          {\n            input: './{projectRoot}/src',\n            glob: '**/*.d.ts',\n            output: './src',\n          },\n          {\n            input: './{projectRoot}',\n            glob: 'generators.json',\n            output: '.',\n          },\n          {\n            input: './{projectRoot}',\n            glob: 'executors.json',\n            output: '.',\n          },\n        ],\n      },\n    },\n    build: {\n      ...project.targets?.build,\n    },\n  };\n  // Append the package dependency without moving an existing entry, so re-runs\n  // do not reorder the build dependencies.\n  addDependencyToTargetIfNotPresent(project, 'build', 'package');\n  // Sort targets so their order is stable regardless of insertion order.\n  project.targets = sortObjectKeys(project.targets);\n  updateProjectConfiguration(tree, fullyQualifiedName, project);\n\n  // Add an MCP Server\n  await tsMcpServerGenerator(tree, {\n    project: fullyQualifiedName,\n    infra: 'none',\n    iac: 'cdk', // not used\n    preferInstallDependencies: false,\n  });\n\n  const mcpPath = joinPathFragments(project.sourceRoot, 'mcp-server');\n  const mcpServerPath = joinPathFragments(mcpPath, 'server.ts');\n\n  // Remove the sample server and tools\n  tree.delete(mcpServerPath);\n  tree.delete(joinPathFragments(mcpPath, 'tools', 'add.ts'));\n  tree.delete(joinPathFragments(mcpPath, 'resources', 'sample-guidance.ts'));\n\n  // Add generator MCP server\n  generateFiles(\n    tree,\n    joinPathFragments(import.meta.dirname, 'files', 'mcp-server'),\n    mcpPath,\n    {\n      name: fullyQualifiedName,\n      ...esmVars(tree),\n    },\n    { overwriteStrategy: OverwriteStrategy.KeepExisting },\n  );\n\n  addGeneratorMetadata(tree, project.name, TS_NX_PLUGIN_GENERATOR_INFO);\n\n  await addGeneratorMetricsIfApplicable(tree, [TS_NX_PLUGIN_GENERATOR_INFO]);\n\n  await formatFilesInSubtree(tree);\n  return () =>\n    installDependencies(tree, options.preferInstallDependencies, {\n      languages: ['typescript'],\n    });\n};\n\nexport default tsNxPluginGenerator;\n"],"names":["generateFiles","joinPathFragments","OverwriteStrategy","updateProjectConfiguration","formatFilesInSubtree","installDependencies","addGeneratorMetricsIfApplicable","esmVars","addDependencyToTargetIfNotPresent","addGeneratorMetadata","getGeneratorInfo","readProjectConfigurationUnqualified","sortObjectKeys","tsProjectGenerator","getTsLibDetails","tsMcpServerGenerator","configureTsProjectAsNxPlugin","TS_NX_PLUGIN_GENERATOR_INFO","filename","tsNxPluginGenerator","tree","options","fullyQualifiedName","dir","preferInstallDependencies","project","targets","package","executor","outputs","outputPath","main","tsConfig","assets","input","glob","output","build","infra","iac","mcpPath","sourceRoot","mcpServerPath","delete","dirname","name","overwriteStrategy","KeepExisting","languages"],"mappings":"AAAA;;;CAGC,GACD,SAEEA,aAAa,EACbC,iBAAiB,EACjBC,iBAAiB,EAGjBC,0BAA0B,QACrB,aAAa;AACpB,SAASC,oBAAoB,QAAQ,wBAAqB;AAC1D,SAASC,mBAAmB,QAAQ,yBAAsB;AAC1D,SAASC,+BAA+B,QAAQ,yBAAsB;AACtE,SAASC,OAAO,QAAQ,+BAA4B;AACpD,SACEC,iCAAiC,EACjCC,oBAAoB,EACpBC,gBAAgB,EAEhBC,mCAAmC,QAC9B,oBAAiB;AACxB,SAASC,cAAc,QAAQ,wBAAqB;AACpD,OAAOC,sBAAsBC,eAAe,QAAQ,sBAAmB;AACvE,OAAOC,0BAA0B,6BAA0B;AAE3D,SAASC,4BAA4B,QAAQ,aAAU;AAEvD,OAAO,MAAMC,8BAA+CP,iBAC1D,YAAYQ,QAAQ,EACpB;AAEF,OAAO,MAAMC,sBAAsB,OACjCC,MACAC;IAEA,4CAA4C;IAC5C,MAAM,EAAEC,kBAAkB,EAAEC,GAAG,EAAE,GAAGT,gBAAgBM,MAAMC;IAC1D,MAAMR,mBAAmBO,MAAM;QAC7B,GAAGC,OAAO;QACVG,2BAA2B;IAC7B;IAEA,mDAAmD;IACnDR,6BAA6BI,MAAME;IAEnC,+EAA+E;IAC/E,MAAMG,UAAUd,oCAAoCS,MAAME;IAC1DG,QAAQC,OAAO,GAAG;QAChB,GAAGD,QAAQC,OAAO;QAClBC,SAAS;YACPC,UAAU;YACVC,SAAS;gBAAC;aAAuB;YACjCR,SAAS;gBACPS,YAAY,CAAC,0BAA0B,CAAC;gBACxCC,MAAM,CAAC,0BAA0B,CAAC;gBAClCC,UAAU,CAAC,+BAA+B,CAAC;gBAC3CC,QAAQ;oBACN,CAAC,kBAAkB,CAAC;oBACpB,CAAC,sBAAsB,CAAC;oBACxB,CAAC,oBAAoB,CAAC;oBACtB;wBACEC,OAAO;wBACPC,MAAM;wBACNC,QAAQ;oBACV;oBACA;wBACEF,OAAO;wBACPC,MAAM;wBACNC,QAAQ;oBACV;oBACA;wBACEF,OAAO;wBACPC,MAAM;wBACNC,QAAQ;oBACV;oBACA;wBACEF,OAAO;wBACPC,MAAM;wBACNC,QAAQ;oBACV;iBACD;YACH;QACF;QACAC,OAAO;YACL,GAAGZ,QAAQC,OAAO,EAAEW,KAAK;QAC3B;IACF;IACA,6EAA6E;IAC7E,yCAAyC;IACzC7B,kCAAkCiB,SAAS,SAAS;IACpD,uEAAuE;IACvEA,QAAQC,OAAO,GAAGd,eAAea,QAAQC,OAAO;IAChDvB,2BAA2BiB,MAAME,oBAAoBG;IAErD,oBAAoB;IACpB,MAAMV,qBAAqBK,MAAM;QAC/BK,SAASH;QACTgB,OAAO;QACPC,KAAK;QACLf,2BAA2B;IAC7B;IAEA,MAAMgB,UAAUvC,kBAAkBwB,QAAQgB,UAAU,EAAE;IACtD,MAAMC,gBAAgBzC,kBAAkBuC,SAAS;IAEjD,qCAAqC;IACrCpB,KAAKuB,MAAM,CAACD;IACZtB,KAAKuB,MAAM,CAAC1C,kBAAkBuC,SAAS,SAAS;IAChDpB,KAAKuB,MAAM,CAAC1C,kBAAkBuC,SAAS,aAAa;IAEpD,2BAA2B;IAC3BxC,cACEoB,MACAnB,kBAAkB,YAAY2C,OAAO,EAAE,SAAS,eAChDJ,SACA;QACEK,MAAMvB;QACN,GAAGf,QAAQa,KAAK;IAClB,GACA;QAAE0B,mBAAmB5C,kBAAkB6C,YAAY;IAAC;IAGtDtC,qBAAqBW,MAAMK,QAAQoB,IAAI,EAAE5B;IAEzC,MAAMX,gCAAgCc,MAAM;QAACH;KAA4B;IAEzE,MAAMb,qBAAqBgB;IAC3B,OAAO,IACLf,oBAAoBe,MAAMC,QAAQG,yBAAyB,EAAE;YAC3DwB,WAAW;gBAAC;aAAa;QAC3B;AACJ,EAAE;AAEF,eAAe7B,oBAAoB"}

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

@@ -0,0 +1,9 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ /**
+ * TypeScript types for options defined in schema.json
+ * Update this to match schema.json if you make changes.
+ */ export { };
+
+//# sourceMappingURL=schema.d.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/ts/nx-plugin/schema.d.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport { TsProjectGeneratorSchema } from '../lib/schema';\n\n/**\n * TypeScript types for options defined in schema.json\n * Update this to match schema.json if you make changes.\n */\nexport type TsNxPluginGeneratorSchema = TsProjectGeneratorSchema;\n"],"names":[],"mappings":"AAAA;;;CAGC,GAGD;;;CAGC,GACD,WAAiE"}

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

@@ -26,6 +26,11 @@
       "type": "string",
       "description": "The sub directory the lib is placed in. By default this is the library name.",
       "x-prompt": "Which sub directory do you want to create the library in? (By default this is the library 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": ["name"]

package/src/ts/nx-plugin/utils.d.ts

@@ -2,8 +2,28 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Tree } from '@nx/devkit';
+import { type ProjectConfiguration, type Tree } from '@nx/devkit';
+import type { PackageJson } from 'nx/src/utils/package-json';
+/**
+ * Read the configuration of a project which can host Nx Plugin generators or
+ * migrations, ie a TypeScript project.
+ */
+export declare const readNxPluginProject: (tree: Tree, projectName: string) => ProjectConfiguration;
+/** `package.json` field pointing Nx at one of a plugin's manifests. */
+type NxPluginManifestField = 'generators' | 'nx-migrations';
+/**
+ * Create the plugin project's package.json if absent and point it at the given
+ * manifest, returning its path.
+ */
+export declare const configureNxPluginPackageJson: <TField extends NxPluginManifestField>(tree: Tree, project: ProjectConfiguration, manifestField: TField, manifestValue: PackageJson[TField]) => string;
+/**
+ * Declare the dependencies the plugin's `.ts` files import on both the
+ * workspace and the plugin, since both must resolve for Nx to load them. A
+ * no-op inside the plugin's own monorepo, where they are already present.
+ */
+export declare const addNxPluginDependencies: (tree: Tree, pluginPackageJsonPath: string) => void;
 /**
  * Configures a TypeScript project as an Nx Plugin
  */
 export declare const configureTsProjectAsNxPlugin: (tree: Tree, projectName: string) => void;
+export {};

package/src/ts/nx-plugin/utils.js

@@ -1,66 +1,75 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.configureTsProjectAsNxPlugin = 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 nx_1 = require("../../utils/nx");
-const versions_1 = require("../../utils/versions");
-const package_json_1 = tslib_1.__importDefault(require("../../../package.json"));
+ */ import { joinPathFragments, updateJson, writeJson } from "@nx/devkit";
+import { addDependenciesToPackageJson } from "../../utils/dependencies.js";
+import { isEsmWorkspace } from "../../utils/module-format.js";
+import { nxPluginSelfDependency, readProjectConfigurationUnqualified } from "../../utils/nx.js";
+import { withVersions } from "../../utils/versions.js";
 /**
- * Configures a TypeScript project as an Nx Plugin
- */
-const configureTsProjectAsNxPlugin = (tree, projectName) => {
-    const project = (0, nx_1.readProjectConfigurationUnqualified)(tree, projectName);
-    const tsConfigPath = (0, devkit_1.joinPathFragments)(project.root, 'tsconfig.json');
+ * Read the configuration of a project which can host Nx Plugin generators or
+ * migrations, ie a TypeScript project.
+ */ export const readNxPluginProject = (tree, projectName)=>{
+    const project = readProjectConfigurationUnqualified(tree, projectName);
+    const tsConfigPath = joinPathFragments(project.root, 'tsconfig.json');
     if (!tree.exists(tsConfigPath)) {
         throw new Error(`Selected plugin project ${projectName} is not a TypeScript project`);
     }
-    // Nx Plugins must use commonjs as a limitation of nx
-    // https://github.com/nrwl/nx/issues/15682
-    (0, devkit_1.updateJson)(tree, tsConfigPath, (tsConfig) => {
-        tsConfig.compilerOptions ??= {};
-        tsConfig.compilerOptions.module ??= 'commonjs';
-        // TypeScript 6 allows bundler + commonjs together, avoiding deprecated node/node10
-        tsConfig.compilerOptions.moduleResolution ??= 'bundler';
-        return tsConfig;
-    });
-    // Create an empty generators.json if one dosn't exist
-    const generatorsJsonPath = (0, devkit_1.joinPathFragments)(project.root, 'generators.json');
-    if (!tree.exists(generatorsJsonPath)) {
-        (0, devkit_1.writeJson)(tree, generatorsJsonPath, {
-            generators: {},
-        });
-    }
-    // Create a package.json if one doesn't exist, and configure "main" and "generators"
-    const pluginPackageJsonPath = (0, devkit_1.joinPathFragments)(project.root, 'package.json');
+    return project;
+};
+/**
+ * Create the plugin project's package.json if absent and point it at the given
+ * manifest, returning its path.
+ */ export const configureNxPluginPackageJson = (tree, project, manifestField, manifestValue)=>{
+    const pluginPackageJsonPath = joinPathFragments(project.root, 'package.json');
     if (!tree.exists(pluginPackageJsonPath)) {
-        (0, devkit_1.writeJson)(tree, pluginPackageJsonPath, {
-            name: project.name,
+        writeJson(tree, pluginPackageJsonPath, {
+            name: project.name
         });
     }
-    (0, devkit_1.updateJson)(tree, pluginPackageJsonPath, (pkg) => {
-        pkg.main ??= './src/index.js';
-        pkg.generators ??= './generators.json';
+    const esm = isEsmWorkspace(tree);
+    updateJson(tree, pluginPackageJsonPath, (pkg)=>{
+        // Match the plugin's module system to the workspace. Nx loads `.ts` files
+        // via Node's native type stripping, as ESM (workspace root is
+        // `type: module`) or CommonJS accordingly.
+        pkg.type ??= esm ? 'module' : 'commonjs';
+        pkg.main ??= esm ? './src/index.js' : './src/index';
+        pkg[manifestField] ??= manifestValue;
         return pkg;
     });
-    const rootPackageJson = tree.exists('package.json')
-        ? (0, devkit_1.readJson)(tree, 'package.json')
-        : undefined;
-    const isNxPluginForAws = rootPackageJson?.name === '@aws/nx-plugin-source';
-    if (!isNxPluginForAws) {
-        // Add the required dependencies to the root package.json, and project's package.json
-        const deps = {
-            ...(0, versions_1.withVersions)(['@nx/devkit']),
-            // Include dependency on @aws/nx-plugin
-            [package_json_1.default.name]: `^${package_json_1.default.version}`,
-        };
-        (0, devkit_1.addDependenciesToPackageJson)(tree, {}, deps);
-        (0, devkit_1.addDependenciesToPackageJson)(tree, deps, {}, pluginPackageJsonPath);
+    return pluginPackageJsonPath;
+};
+/**
+ * Declare the dependencies the plugin's `.ts` files import on both the
+ * workspace and the plugin, since both must resolve for Nx to load them. A
+ * no-op inside the plugin's own monorepo, where they are already present.
+ */ export const addNxPluginDependencies = (tree, pluginPackageJsonPath)=>{
+    const selfDependency = nxPluginSelfDependency(tree);
+    if (Object.keys(selfDependency).length === 0) {
+        return;
+    }
+    const deps = {
+        ...withVersions([
+            '@nx/devkit'
+        ]),
+        ...selfDependency
+    };
+    addDependenciesToPackageJson(tree, {}, deps);
+    addDependenciesToPackageJson(tree, deps, {}, pluginPackageJsonPath);
+};
+/**
+ * Configures a TypeScript project as an Nx Plugin
+ */ export const configureTsProjectAsNxPlugin = (tree, projectName)=>{
+    const project = readNxPluginProject(tree, projectName);
+    // Create an empty generators.json if one dosn't exist
+    const generatorsJsonPath = joinPathFragments(project.root, 'generators.json');
+    if (!tree.exists(generatorsJsonPath)) {
+        writeJson(tree, generatorsJsonPath, {
+            generators: {}
+        });
     }
+    const pluginPackageJsonPath = configureNxPluginPackageJson(tree, project, 'generators', './generators.json');
+    addNxPluginDependencies(tree, pluginPackageJsonPath);
 };
-exports.configureTsProjectAsNxPlugin = configureTsProjectAsNxPlugin;
+
 //# sourceMappingURL=utils.js.map

package/src/ts/nx-plugin/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/ts/nx-plugin/utils.ts"],"names":[],"mappings":";;;;AAAA;;;GAGG;AACH,uCAOoB;AACpB,uCAAqE;AACrE,mDAAoD;AACpD,iFAAgD;AAEhD;;GAEG;AACI,MAAM,4BAA4B,GAAG,CAC1C,IAAU,EACV,WAAmB,EACnB,EAAE;IACF,MAAM,OAAO,GAAG,IAAA,wCAAmC,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAEvE,MAAM,YAAY,GAAG,IAAA,0BAAiB,EAAC,OAAO,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACtE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,2BAA2B,WAAW,8BAA8B,CACrE,CAAC;IACJ,CAAC;IAED,qDAAqD;IACrD,0CAA0C;IAC1C,IAAA,mBAAU,EAAC,IAAI,EAAE,YAAY,EAAE,CAAC,QAAQ,EAAE,EAAE;QAC1C,QAAQ,CAAC,eAAe,KAAK,EAAE,CAAC;QAChC,QAAQ,CAAC,eAAe,CAAC,MAAM,KAAK,UAAU,CAAC;QAC/C,mFAAmF;QACnF,QAAQ,CAAC,eAAe,CAAC,gBAAgB,KAAK,SAAS,CAAC;QACxD,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,sDAAsD;IACtD,MAAM,kBAAkB,GAAG,IAAA,0BAAiB,EAAC,OAAO,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC9E,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACrC,IAAA,kBAAS,EAAC,IAAI,EAAE,kBAAkB,EAAE;YAClC,UAAU,EAAE,EAAE;SACf,CAAC,CAAC;IACL,CAAC;IAED,oFAAoF;IACpF,MAAM,qBAAqB,GAAG,IAAA,0BAAiB,EAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC9E,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,EAAE,CAAC;QACxC,IAAA,kBAAS,EAAC,IAAI,EAAE,qBAAqB,EAAE;YACrC,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;IACD,IAAA,mBAAU,EAAC,IAAI,EAAE,qBAAqB,EAAE,CAAC,GAAG,EAAE,EAAE;QAC9C,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC;QAC9B,GAAG,CAAC,UAAU,KAAK,mBAAmB,CAAC;QACvC,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;IAEH,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,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,qFAAqF;QACrF,MAAM,IAAI,GAAG;YACX,GAAG,IAAA,uBAAY,EAAC,CAAC,YAAY,CAAC,CAAC;YAC/B,uCAAuC;YACvC,CAAC,sBAAW,CAAC,IAAI,CAAC,EAAE,IAAI,sBAAW,CAAC,OAAO,EAAE;SAC9C,CAAC;QACF,IAAA,qCAA4B,EAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAC7C,IAAA,qCAA4B,EAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,qBAAqB,CAAC,CAAC;IACtE,CAAC;AACH,CAAC,CAAC;AA3DW,QAAA,4BAA4B,gCA2DvC"}
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/ts/nx-plugin/utils.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport {\n  joinPathFragments,\n  type ProjectConfiguration,\n  type Tree,\n  updateJson,\n  writeJson,\n} from '@nx/devkit';\nimport type { PackageJson } from 'nx/src/utils/package-json';\nimport { addDependenciesToPackageJson } from '../../utils/dependencies';\nimport { isEsmWorkspace } from '../../utils/module-format';\nimport {\n  nxPluginSelfDependency,\n  readProjectConfigurationUnqualified,\n} from '../../utils/nx';\nimport { withVersions } from '../../utils/versions';\n\n/**\n * Read the configuration of a project which can host Nx Plugin generators or\n * migrations, ie a TypeScript project.\n */\nexport const readNxPluginProject = (\n  tree: Tree,\n  projectName: string,\n): ProjectConfiguration => {\n  const project = readProjectConfigurationUnqualified(tree, projectName);\n\n  const tsConfigPath = joinPathFragments(project.root, 'tsconfig.json');\n  if (!tree.exists(tsConfigPath)) {\n    throw new Error(\n      `Selected plugin project ${projectName} is not a TypeScript project`,\n    );\n  }\n\n  return project;\n};\n\n/** `package.json` field pointing Nx at one of a plugin's manifests. */\ntype NxPluginManifestField = 'generators' | 'nx-migrations';\n\n/**\n * Create the plugin project's package.json if absent and point it at the given\n * manifest, returning its path.\n */\nexport const configureNxPluginPackageJson = <\n  TField extends NxPluginManifestField,\n>(\n  tree: Tree,\n  project: ProjectConfiguration,\n  manifestField: TField,\n  manifestValue: PackageJson[TField],\n): string => {\n  const pluginPackageJsonPath = joinPathFragments(project.root, 'package.json');\n  if (!tree.exists(pluginPackageJsonPath)) {\n    writeJson(tree, pluginPackageJsonPath, {\n      name: project.name,\n    });\n  }\n  const esm = isEsmWorkspace(tree);\n  updateJson(tree, pluginPackageJsonPath, (pkg) => {\n    // Match the plugin's module system to the workspace. Nx loads `.ts` files\n    // via Node's native type stripping, as ESM (workspace root is\n    // `type: module`) or CommonJS accordingly.\n    pkg.type ??= esm ? 'module' : 'commonjs';\n    pkg.main ??= esm ? './src/index.js' : './src/index';\n    pkg[manifestField] ??= manifestValue;\n    return pkg;\n  });\n  return pluginPackageJsonPath;\n};\n\n/**\n * Declare the dependencies the plugin's `.ts` files import on both the\n * workspace and the plugin, since both must resolve for Nx to load them. A\n * no-op inside the plugin's own monorepo, where they are already present.\n */\nexport const addNxPluginDependencies = (\n  tree: Tree,\n  pluginPackageJsonPath: string,\n): void => {\n  const selfDependency = nxPluginSelfDependency(tree);\n  if (Object.keys(selfDependency).length === 0) {\n    return;\n  }\n  const deps = {\n    ...withVersions(['@nx/devkit']),\n    ...selfDependency,\n  };\n  addDependenciesToPackageJson(tree, {}, deps);\n  addDependenciesToPackageJson(tree, deps, {}, pluginPackageJsonPath);\n};\n\n/**\n * Configures a TypeScript project as an Nx Plugin\n */\nexport const configureTsProjectAsNxPlugin = (\n  tree: Tree,\n  projectName: string,\n) => {\n  const project = readNxPluginProject(tree, projectName);\n\n  // Create an empty generators.json if one dosn't exist\n  const generatorsJsonPath = joinPathFragments(project.root, 'generators.json');\n  if (!tree.exists(generatorsJsonPath)) {\n    writeJson(tree, generatorsJsonPath, {\n      generators: {},\n    });\n  }\n\n  const pluginPackageJsonPath = configureNxPluginPackageJson(\n    tree,\n    project,\n    'generators',\n    './generators.json',\n  );\n\n  addNxPluginDependencies(tree, pluginPackageJsonPath);\n};\n"],"names":["joinPathFragments","updateJson","writeJson","addDependenciesToPackageJson","isEsmWorkspace","nxPluginSelfDependency","readProjectConfigurationUnqualified","withVersions","readNxPluginProject","tree","projectName","project","tsConfigPath","root","exists","Error","configureNxPluginPackageJson","manifestField","manifestValue","pluginPackageJsonPath","name","esm","pkg","type","main","addNxPluginDependencies","selfDependency","Object","keys","length","deps","configureTsProjectAsNxPlugin","generatorsJsonPath","generators"],"mappings":"AAAA;;;CAGC,GACD,SACEA,iBAAiB,EAGjBC,UAAU,EACVC,SAAS,QACJ,aAAa;AAEpB,SAASC,4BAA4B,QAAQ,8BAA2B;AACxE,SAASC,cAAc,QAAQ,+BAA4B;AAC3D,SACEC,sBAAsB,EACtBC,mCAAmC,QAC9B,oBAAiB;AACxB,SAASC,YAAY,QAAQ,0BAAuB;AAEpD;;;CAGC,GACD,OAAO,MAAMC,sBAAsB,CACjCC,MACAC;IAEA,MAAMC,UAAUL,oCAAoCG,MAAMC;IAE1D,MAAME,eAAeZ,kBAAkBW,QAAQE,IAAI,EAAE;IACrD,IAAI,CAACJ,KAAKK,MAAM,CAACF,eAAe;QAC9B,MAAM,IAAIG,MACR,CAAC,wBAAwB,EAAEL,YAAY,4BAA4B,CAAC;IAExE;IAEA,OAAOC;AACT,EAAE;AAKF;;;CAGC,GACD,OAAO,MAAMK,+BAA+B,CAG1CP,MACAE,SACAM,eACAC;IAEA,MAAMC,wBAAwBnB,kBAAkBW,QAAQE,IAAI,EAAE;IAC9D,IAAI,CAACJ,KAAKK,MAAM,CAACK,wBAAwB;QACvCjB,UAAUO,MAAMU,uBAAuB;YACrCC,MAAMT,QAAQS,IAAI;QACpB;IACF;IACA,MAAMC,MAAMjB,eAAeK;IAC3BR,WAAWQ,MAAMU,uBAAuB,CAACG;QACvC,0EAA0E;QAC1E,8DAA8D;QAC9D,2CAA2C;QAC3CA,IAAIC,IAAI,KAAKF,MAAM,WAAW;QAC9BC,IAAIE,IAAI,KAAKH,MAAM,mBAAmB;QACtCC,GAAG,CAACL,cAAc,KAAKC;QACvB,OAAOI;IACT;IACA,OAAOH;AACT,EAAE;AAEF;;;;CAIC,GACD,OAAO,MAAMM,0BAA0B,CACrChB,MACAU;IAEA,MAAMO,iBAAiBrB,uBAAuBI;IAC9C,IAAIkB,OAAOC,IAAI,CAACF,gBAAgBG,MAAM,KAAK,GAAG;QAC5C;IACF;IACA,MAAMC,OAAO;QACX,GAAGvB,aAAa;YAAC;SAAa,CAAC;QAC/B,GAAGmB,cAAc;IACnB;IACAvB,6BAA6BM,MAAM,CAAC,GAAGqB;IACvC3B,6BAA6BM,MAAMqB,MAAM,CAAC,GAAGX;AAC/C,EAAE;AAEF;;CAEC,GACD,OAAO,MAAMY,+BAA+B,CAC1CtB,MACAC;IAEA,MAAMC,UAAUH,oBAAoBC,MAAMC;IAE1C,sDAAsD;IACtD,MAAMsB,qBAAqBhC,kBAAkBW,QAAQE,IAAI,EAAE;IAC3D,IAAI,CAACJ,KAAKK,MAAM,CAACkB,qBAAqB;QACpC9B,UAAUO,MAAMuB,oBAAoB;YAClCC,YAAY,CAAC;QACf;IACF;IAEA,MAAMd,wBAAwBH,6BAC5BP,MACAE,SACA,cACA;IAGFc,wBAAwBhB,MAAMU;AAChC,EAAE"}