@aws/nx-plugin 0.2.0 → 0.3.0

package/src/infra/app/__snapshots__/generator.spec.ts.snap

@@ -14,11 +14,11 @@ exports[`infra generator > should add required dependencies to package.json > de
 exports[`infra generator > should add required dependencies to package.json > dev-dependencies 1`] = `
 {
   "@eslint/js": "^9.8.0",
-  "@nx/eslint": "20.3.1",
-  "@nx/eslint-plugin": "20.3.1",
-  "@nx/js": "20.3.1",
-  "@nx/vite": "20.3.1",
-  "@nx/web": "20.3.1",
+  "@nx/eslint": "20.4.0",
+  "@nx/eslint-plugin": "20.4.0",
+  "@nx/js": "20.4.0",
+  "@nx/vite": "20.4.0",
+  "@nx/web": "20.4.0",
   "@swc-node/register": "~1.9.1",
   "@swc/core": "~1.5.7",
   "@swc/helpers": "~0.5.11",
@@ -30,8 +30,8 @@ exports[`infra generator > should add required dependencies to package.json > de
   "jsdom": "~22.1.0",
   "prettier": "^3.4.2",
   "tsx": "^4.19.2",
-  "typescript": "~5.6.2",
-  "typescript-eslint": "^8.13.0",
+  "typescript": "~5.7.2",
+  "typescript-eslint": "^8.19.0",
   "vite": "^5.0.0",
   "vitest": "^1.3.1",
 }
@@ -49,11 +49,11 @@ exports[`infra generator > should add required dependencies to package.json > pa
   },
   "devDependencies": {
     "@eslint/js": "^9.8.0",
-    "@nx/eslint": "20.3.1",
-    "@nx/eslint-plugin": "20.3.1",
-    "@nx/js": "20.3.1",
-    "@nx/vite": "20.3.1",
-    "@nx/web": "20.3.1",
+    "@nx/eslint": "20.4.0",
+    "@nx/eslint-plugin": "20.4.0",
+    "@nx/js": "20.4.0",
+    "@nx/vite": "20.4.0",
+    "@nx/web": "20.4.0",
     "@swc-node/register": "~1.9.1",
     "@swc/core": "~1.5.7",
     "@swc/helpers": "~0.5.11",
@@ -65,29 +65,27 @@ exports[`infra generator > should add required dependencies to package.json > pa
     "jsdom": "~22.1.0",
     "prettier": "^3.4.2",
     "tsx": "^4.19.2",
-    "typescript": "~5.6.2",
-    "typescript-eslint": "^8.13.0",
+    "typescript": "~5.7.2",
+    "typescript-eslint": "^8.19.0",
     "vite": "^5.0.0",
     "vitest": "^1.3.1",
   },
   "name": "@proj/source",
   "type": "module",
+  "workspaces": [
+    "packages/*",
+    "packages/common/*",
+  ],
 }
 `;
 
 exports[`infra generator > should configure project.json with correct targets > build-target 1`] = `
 {
-  "cache": true,
   "dependsOn": [
-    "^build",
-  ],
-  "executor": "nx:run-commands",
-  "options": {
-    "command": "cdk synth",
-    "cwd": "packages/test",
-  },
-  "outputs": [
-    "{workspaceRoot}/dist/packages/test/cdk.out",
+    "lint",
+    "compile",
+    "test",
+    "synth",
   ],
 }
 `;
@@ -112,17 +110,11 @@ exports[`infra generator > should configure project.json with correct targets >
   "tags": [],
   "targets": {
     "build": {
-      "cache": true,
       "dependsOn": [
-        "^build",
-      ],
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "cdk synth",
-        "cwd": "packages/test",
-      },
-      "outputs": [
-        "{workspaceRoot}/dist/packages/test/cdk.out",
+        "lint",
+        "compile",
+        "test",
+        "synth",
       ],
     },
     "compile": {
@@ -131,9 +123,9 @@ exports[`infra generator > should configure project.json with correct targets >
         "assets": [
           "packages/test/*.md",
         ],
-        "main": "packages/test/src/index.ts",
+        "main": "packages/test/src/main.ts",
         "outputPath": "dist/packages/test",
-        "tsConfig": "packages/test/tsconfig.lib.json",
+        "tsConfig": "packages/test/tsconfig.json",
       },
       "outputs": [
         "{options.outputPath}",
@@ -149,6 +141,20 @@ exports[`infra generator > should configure project.json with correct targets >
     "lint": {
       "executor": "@nx/eslint:lint",
     },
+    "synth": {
+      "cache": true,
+      "dependsOn": [
+        "^build",
+      ],
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "cdk synth",
+        "cwd": "packages/test",
+      },
+      "outputs": [
+        "{workspaceRoot}/dist/packages/test/cdk.out",
+      ],
+    },
     "test": {
       "executor": "@nx/vite:test",
       "options": {
@@ -450,13 +456,16 @@ exports[`infra generator > should generate files with correct content > project-
   "tags": [],
   "targets": {
     "build": {
-      "cache": true,
-      "executor": "nx:run-commands",
-      "outputs": ["{workspaceRoot}/dist/packages/test/cdk.out"],
-      "dependsOn": ["^build"],
+      "dependsOn": ["lint", "compile", "test", "synth"]
+    },
+    "compile": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
       "options": {
-        "cwd": "packages/test",
-        "command": "cdk synth"
+        "outputPath": "dist/packages/test",
+        "main": "packages/test/src/main.ts",
+        "tsConfig": "packages/test/tsconfig.json",
+        "assets": ["packages/test/*.md"]
       }
     },
     "lint": {
@@ -469,14 +478,14 @@ exports[`infra generator > should generate files with correct content > project-
         "reportsDirectory": "../../coverage/packages/test"
       }
     },
-    "compile": {
-      "executor": "@nx/js:tsc",
-      "outputs": ["{options.outputPath}"],
+    "synth": {
+      "cache": true,
+      "executor": "nx:run-commands",
+      "outputs": ["{workspaceRoot}/dist/packages/test/cdk.out"],
+      "dependsOn": ["^build"],
       "options": {
-        "outputPath": "dist/packages/test",
-        "main": "packages/test/src/index.ts",
-        "tsConfig": "packages/test/tsconfig.lib.json",
-        "assets": ["packages/test/*.md"]
+        "cwd": "packages/test",
+        "command": "cdk synth"
       }
     },
     "deploy": {
@@ -746,17 +755,11 @@ exports[`infra generator > should handle custom project names correctly > custom
   "tags": [],
   "targets": {
     "build": {
-      "cache": true,
       "dependsOn": [
-        "^build",
-      ],
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "cdk synth",
-        "cwd": "packages/custom-infra",
-      },
-      "outputs": [
-        "{workspaceRoot}/dist/packages/custom-infra/cdk.out",
+        "lint",
+        "compile",
+        "test",
+        "synth",
       ],
     },
     "compile": {
@@ -765,9 +768,9 @@ exports[`infra generator > should handle custom project names correctly > custom
         "assets": [
           "packages/custom-infra/*.md",
         ],
-        "main": "packages/custom-infra/src/index.ts",
+        "main": "packages/custom-infra/src/main.ts",
         "outputPath": "dist/packages/custom-infra",
-        "tsConfig": "packages/custom-infra/tsconfig.lib.json",
+        "tsConfig": "packages/custom-infra/tsconfig.json",
       },
       "outputs": [
         "{options.outputPath}",
@@ -783,6 +786,20 @@ exports[`infra generator > should handle custom project names correctly > custom
     "lint": {
       "executor": "@nx/eslint:lint",
     },
+    "synth": {
+      "cache": true,
+      "dependsOn": [
+        "^build",
+      ],
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "cdk synth",
+        "cwd": "packages/custom-infra",
+      },
+      "outputs": [
+        "{workspaceRoot}/dist/packages/custom-infra/cdk.out",
+      ],
+    },
     "test": {
       "executor": "@nx/vite:test",
       "options": {

package/src/infra/app/files/common/constructs/src/core/cfn-guard.ts.template

@@ -30,7 +30,7 @@ export const suppressRule = (
     .filter((resource) => CfnResource.isCfnResource(resource));
 
   resources.forEach((resource) => {
-    let metadata = resource.getMetadata('guard') || {};
+    const metadata = resource.getMetadata('guard') || {};
     metadata['SuppressedRules'] = [
       ...(metadata['SuppressedRules'] ?? []),
       ruleName,
@@ -46,7 +46,7 @@ export enum RuleSet {
   NIST_CSF = 'nist-csf.guard',
   PCI_DSS_3_2_1 = 'pci-dss-3-2-1.guard',
   WELL_ARCHITECTED_RELIABILITY = 'wa-reliability-pillar.guard',
-  WELL_ARCHITECTED_SECURITY = 'wa-security-pillar.guard'
+  WELL_ARCHITECTED_SECURITY = 'wa-security-pillar.guard',
 }
 
 export class CfnGuardValidator extends _CfnGuardValidator {

package/src/infra/app/generator.js

@@ -9,14 +9,15 @@ const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const generator_1 = tslib_1.__importStar(require("../../ts/lib/generator"));
 const versions_1 = require("../../utils/versions");
-const format_1 = require("../../utils/format");
 const npm_scope_1 = require("../../utils/npm-scope");
 const shared_constructs_1 = require("../../utils/shared-constructs");
 const ast_1 = require("../../utils/ast");
+const path_1 = tslib_1.__importDefault(require("path"));
+const format_1 = require("../../utils/format");
 function infraGenerator(tree, schema) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const lib = (0, generator_1.getTsLibDetails)(tree, schema);
-        const tsLibGeneratorCallback = yield (0, generator_1.default)(tree, schema);
+        yield (0, generator_1.default)(tree, schema);
         yield (0, shared_constructs_1.sharedConstructsGenerator)(tree);
         const synthDirFromRoot = `/dist/${lib.dir}/cdk.out`;
         const synthDirFromProject = lib.dir
@@ -39,8 +40,14 @@ function infraGenerator(tree, schema) {
             overwriteStrategy: devkit_1.OverwriteStrategy.KeepExisting,
         });
         (0, devkit_1.updateJson)(tree, `${libraryRoot}/project.json`, (config) => {
+            var _a;
             config.projectType = 'application';
-            config.targets.build = {
+            config.targets.build.dependsOn = [
+                ...((_a = config.targets.build.dependsOn) !== null && _a !== void 0 ? _a : []),
+                'synth',
+            ];
+            config.targets.compile.options.main = (0, devkit_1.joinPathFragments)(libraryRoot, 'src', 'main.ts');
+            config.targets.synth = {
                 cache: true,
                 executor: 'nx:run-commands',
                 outputs: [`{workspaceRoot}${synthDirFromRoot}`],
@@ -68,8 +75,16 @@ function infraGenerator(tree, schema) {
             'constructs',
             'source-map-support',
         ]), (0, versions_1.withVersions)(['tsx']));
-        yield (0, format_1.formatFilesInSubtree)(tree, libraryRoot);
-        return tsLibGeneratorCallback;
+        (0, devkit_1.updateJson)(tree, `${libraryRoot}/tsconfig.json`, (tsConfig) => (Object.assign(Object.assign({}, tsConfig), { references: [
+                ...(tsConfig.references || []),
+                {
+                    path: `${path_1.default.relative(libraryRoot, `${tree.root}/${shared_constructs_1.PACKAGES_DIR}`)}/${shared_constructs_1.SHARED_CONSTRUCTS_DIR}/tsconfig.json`,
+                },
+            ] })));
+        yield (0, format_1.formatFilesInSubtree)(tree);
+        return () => {
+            (0, devkit_1.installPackagesTask)(tree);
+        };
     });
 }
 exports.default = infraGenerator;

package/src/infra/app/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/infra/app/generator.ts"],"names":[],"mappings":";;AA2BA,wCAkGC;;AA7HD;;;GAGG;AACH,uCAWoB;AAEpB,4EAAyE;AACzE,mDAAoD;AACpD,+CAA0D;AAC1D,qDAAwE;AACxE,qEAIuC;AACvC,yCAAgD;AAChD,SAAsB,cAAc,CAClC,IAAU,EACV,MAA4B;;QAE5B,MAAM,GAAG,GAAG,IAAA,2BAAe,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1C,MAAM,sBAAsB,GAAG,MAAM,IAAA,mBAAc,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClE,MAAM,IAAA,6CAAyB,EAAC,IAAI,CAAC,CAAC;QACtC,MAAM,gBAAgB,GAAG,SAAS,GAAG,CAAC,GAAG,UAAU,CAAC;QACpD,MAAM,mBAAmB,GACvB,GAAG,CAAC,GAAG;aACJ,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC;QAClC,MAAM,aAAa,GAAG,IAAA,iCAAwB,EAAC,IAAI,EAAE,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAC7E,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC;QACvC,MAAM,cAAc,GAAG,IAAA,6BAAiB,EAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAA,wBAAY,EAAC,cAAc,CAAC,CAAC;QAChD,MAAM,kBAAkB,GAAG,GAAG,cAAc,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC7D,IAAI,CAAC,MAAM,CAAC,IAAA,0BAAiB,EAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;QACnD,IAAA,sBAAa,EACX,IAAI,EAAE,0BAA0B;QAChC,IAAA,0BAAiB,EAAC,SAAS,EAAE,aAAa,CAAC,EAAE,6BAA6B;QAC1E,WAAW,gCAET,QAAQ,EAAE,mBAAmB,EAC7B,UAAU,EAAE,UAAU,EACtB,kBAAkB,EAClB,SAAS,EAAE,IAAA,iCAAwB,GAAE,CAAC,IAAI,IACvC,MAAM,KACT,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,KAEvC;YACE,iBAAiB,EAAE,0BAAiB,CAAC,SAAS;SAC/C,CACF,CAAC;QACF,IAAA,sBAAa,EACX,IAAI,EAAE,0BAA0B;QAChC,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,EAAE,yCAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,EAC3E,IAAA,0BAAiB,EAAC,gCAAY,EAAE,yCAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,kBAEnE,QAAQ,EAAE,mBAAmB,EAC7B,UAAU,EAAE,IAAA,wBAAY,EAAC,IAAA,6BAAiB,EAAC,IAAI,CAAC,CAAC,IAC9C,MAAM,GAEX;YACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;SAClD,CACF,CAAC;QACF,IAAA,mBAAU,EACR,IAAI,EACJ,GAAG,WAAW,eAAe,EAC7B,CAAC,MAA4B,EAAE,EAAE;YAC/B,MAAM,CAAC,WAAW,GAAG,aAAa,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG;gBACrB,KAAK,EAAE,IAAI;gBACX,QAAQ,EAAE,iBAAiB;gBAC3B,OAAO,EAAE,CAAC,kBAAkB,gBAAgB,EAAE,CAAC;gBAC/C,SAAS,EAAE,CAAC,QAAQ,CAAC;gBACrB,OAAO,EAAE;oBACP,GAAG,EAAE,WAAW;oBAChB,OAAO,EAAE,WAAW;iBACrB;aACF,CAAC;YACF,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG;gBACtB,QAAQ,EAAE,iBAAiB;gBAC3B,OAAO,EAAE;oBACP,GAAG,EAAE,WAAW;oBAChB,OAAO,EAAE,6CAA6C,mBAAmB,EAAE;iBAC5E;aACF,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC,CACF,CAAC;QACF,IAAA,mBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,gCAAY,EACZ,yCAAqB,EACrB,KAAK,EACL,MAAM,EACN,UAAU,CACX,EACD,gBAAgB,CACjB,CAAC;QACF,IAAA,qCAA4B,EAC1B,IAAI,EACJ,IAAA,uBAAY,EAAC;YACX,iCAAiC;YACjC,aAAa;YACb,SAAS;YACT,SAAS;YACT,YAAY;YACZ,oBAAoB;SACrB,CAAC,EACF,IAAA,uBAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CACtB,CAAC;QACF,MAAM,IAAA,6BAAoB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,OAAO,sBAAsB,CAAC;IAChC,CAAC;CAAA;AACD,kBAAe,cAAc,CAAC"}
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/infra/app/generator.ts"],"names":[],"mappings":";;AA+BA,wCA2HC;;AA1JD;;;GAGG;AACH,uCAYoB;AAEpB,4EAAyE;AACzE,mDAAoD;AACpD,qDAAwE;AACxE,qEAKuC;AACvC,yCAAgD;AAChD,wDAAwB;AACxB,+CAA0D;AAE1D,SAAsB,cAAc,CAClC,IAAU,EACV,MAA4B;;QAE5B,MAAM,GAAG,GAAG,IAAA,2BAAe,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1C,MAAM,IAAA,mBAAc,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,MAAM,IAAA,6CAAyB,EAAC,IAAI,CAAC,CAAC;QACtC,MAAM,gBAAgB,GAAG,SAAS,GAAG,CAAC,GAAG,UAAU,CAAC;QACpD,MAAM,mBAAmB,GACvB,GAAG,CAAC,GAAG;aACJ,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC;QAClC,MAAM,aAAa,GAAG,IAAA,iCAAwB,EAAC,IAAI,EAAE,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAC7E,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC;QACvC,MAAM,cAAc,GAAG,IAAA,6BAAiB,EAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAA,wBAAY,EAAC,cAAc,CAAC,CAAC;QAChD,MAAM,kBAAkB,GAAG,GAAG,cAAc,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC7D,IAAI,CAAC,MAAM,CAAC,IAAA,0BAAiB,EAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;QACnD,IAAA,sBAAa,EACX,IAAI,EAAE,0BAA0B;QAChC,IAAA,0BAAiB,EAAC,SAAS,EAAE,aAAa,CAAC,EAAE,6BAA6B;QAC1E,WAAW,gCAET,QAAQ,EAAE,mBAAmB,EAC7B,UAAU,EAAE,UAAU,EACtB,kBAAkB,EAClB,SAAS,EAAE,IAAA,iCAAwB,GAAE,CAAC,IAAI,IACvC,MAAM,KACT,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,KAEvC;YACE,iBAAiB,EAAE,0BAAiB,CAAC,SAAS;SAC/C,CACF,CAAC;QACF,IAAA,sBAAa,EACX,IAAI,EAAE,0BAA0B;QAChC,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,EAAE,yCAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,EAC3E,IAAA,0BAAiB,EAAC,gCAAY,EAAE,yCAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,kBAEnE,QAAQ,EAAE,mBAAmB,EAC7B,UAAU,EAAE,IAAA,wBAAY,EAAC,IAAA,6BAAiB,EAAC,IAAI,CAAC,CAAC,IAC9C,MAAM,GAEX;YACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;SAClD,CACF,CAAC;QACF,IAAA,mBAAU,EACR,IAAI,EACJ,GAAG,WAAW,eAAe,EAC7B,CAAC,MAA4B,EAAE,EAAE;;YAC/B,MAAM,CAAC,WAAW,GAAG,aAAa,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG;gBAC/B,GAAG,CAAC,MAAA,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,mCAAI,EAAE,CAAC;gBACzC,OAAO;aACR,CAAC;YACF,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,IAAA,0BAAiB,EACrD,WAAW,EACX,KAAK,EACL,SAAS,CACV,CAAC;YACF,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG;gBACrB,KAAK,EAAE,IAAI;gBACX,QAAQ,EAAE,iBAAiB;gBAC3B,OAAO,EAAE,CAAC,kBAAkB,gBAAgB,EAAE,CAAC;gBAC/C,SAAS,EAAE,CAAC,QAAQ,CAAC;gBACrB,OAAO,EAAE;oBACP,GAAG,EAAE,WAAW;oBAChB,OAAO,EAAE,WAAW;iBACrB;aACF,CAAC;YACF,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG;gBACtB,QAAQ,EAAE,iBAAiB;gBAC3B,OAAO,EAAE;oBACP,GAAG,EAAE,WAAW;oBAChB,OAAO,EAAE,6CAA6C,mBAAmB,EAAE;iBAC5E;aACF,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC,CACF,CAAC;QACF,IAAA,mBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,gCAAY,EACZ,yCAAqB,EACrB,KAAK,EACL,MAAM,EACN,UAAU,CACX,EACD,gBAAgB,CACjB,CAAC;QACF,IAAA,qCAA4B,EAC1B,IAAI,EACJ,IAAA,uBAAY,EAAC;YACX,iCAAiC;YACjC,aAAa;YACb,SAAS;YACT,SAAS;YACT,YAAY;YACZ,oBAAoB;SACrB,CAAC,EACF,IAAA,uBAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CACtB,CAAC;QAEF,IAAA,mBAAU,EAAC,IAAI,EAAE,GAAG,WAAW,gBAAgB,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,iCAC1D,QAAQ,KACX,UAAU,EAAE;gBACV,GAAG,CAAC,QAAQ,CAAC,UAAU,IAAI,EAAE,CAAC;gBAC9B;oBACE,IAAI,EAAE,GAAG,cAAI,CAAC,QAAQ,CACpB,WAAW,EACX,GAAG,IAAI,CAAC,IAAI,IAAI,gCAAY,EAAE,CAC/B,IAAI,yCAAqB,gBAAgB;iBAC3C;aACF,IACD,CAAC,CAAC;QAEJ,MAAM,IAAA,6BAAoB,EAAC,IAAI,CAAC,CAAC;QACjC,OAAO,GAAG,EAAE;YACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC;CAAA;AACD,kBAAe,cAAc,CAAC"}

package/src/license/README.md

@@ -0,0 +1,255 @@
+# License Generator
+
+## Overview
+
+This generator configures `LICENSE` files and source file headers for your project. After you run this generator, a [sync generator](https://nx.dev/concepts/sync-generators) is registered to execute as part of your `lint` targets which will ensure that your source files conform to the desired license content and format, as well as ensuring that all projects in your workspace contain a copy of the root `LICENSE` file.
+
+## Usage
+
+You can run the generator in two ways:
+
+### 1. Using VSCode IDE
+
+First, install the NX Console extension for VSCode:
+
+1. Open VSCode
+2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
+3. Search for "Nx Console"
+4. Install [Nx Console](https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console)
+
+Then generate your API:
+
+1. Open the NX Console in VSCode
+2. Click on "Generate"
+3. Search for "license"
+4. Fill in the required parameters in the form
+5. Click "Run"
+
+### 2. Using CLI
+
+Generate the API:
+
+```bash
+nx g @aws/nx-plugin:license my-api --copyrightHolder="My Company, Inc." --license=MIT
+```
+
+You can also perform a dry-run to see what files would be generated or updated without actually creating them:
+
+```bash
+nx g @aws/nx-plugin:license my-api --copyrightHolder="My Company, Inc." --license=MIT --dry-run
+```
+
+Both methods will create a root `LICENSE` file based on your selected license and copyright holder, as well as configuring the sync generator to ensure that source files specify the correct license header.
+
+## Input Parameters
+
+| Parameter       | Type   | Default                              | Description                                                                            |
+| --------------- | ------ | ------------------------------------ | -------------------------------------------------------------------------------------- |
+| license         | string | "Apache-2.0"                         | The SPDX license identifier for your chosen license.                                   |
+| copyrightHolder | string | "Amazon.com, Inc. or its affiliates" | The copyright holder, included in the LICENSE file and source file headers by default. |
+
+## Expected Output
+
+The generator will create or update the following files:
+
+```
+└── LICENSE                    # The content is written based on the selected license
+└── package.json               # The "license" field is updated with the selected license
+└── nx.json                    # The "lint" target is configured to sync LICENSE files and source file headers
+└── aws-nx-plugin.config.mts   # Configuration for the license sync, such as customising the license header content and format for different languages
+```
+
+Some default configuration for license header content and format is added to `aws-nx-plugin.config.mts` to write appropriate headers for a handful of file types. You may wish to customise this further; please see the [configuration section](#configuration) below.
+
+## License Sync Behaviour
+
+The license sync generator performs two main tasks:
+
+### 1. Synchronise Source File License Headers
+
+When the sync generator is run, it will ensure that all source code files in your workspace (based on your configuration) contain the appropriate license header. The header is written as the first block comment or consecutive series of line comments in the file (besides the shebang/hashbang if present in a file).
+
+You can update the configuration at any time to change which files should be included or excluded, as well as the content or format of license headers for different file types. For more details, please see the [configuration section](#configuration) below.
+
+### 2. Synchronise LICENSE Files
+
+When the sync generator is run, it will ensure that all projects in your workspace contain the same `LICENSE` file as the `LICENSE` file in the root of your workspace. If your workspace does not have a root LICENSE file, this is skipped.
+
+You can exclude projects in the configuration if required. For more details, please see the [configuration section](#configuration) below.
+
+## Configuration
+
+Configuration is defined in the `aws-nx-plugin.config.mts` file in the root of your workspace.
+
+### License header content
+
+The license header content can be configured in two ways:
+
+1. Using inline content:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        lines: ['Copyright My Company, Inc.', 'Licensed under MIT License', 'All rights reserved'];
+      }
+      // ... format configuration
+    }
+  }
+}
+```
+
+2. Loading from a file:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        filePath: 'license-header.txt'; // relative to workspace root
+      }
+      // ... format configuration
+    }
+  }
+}
+```
+
+### Including files and specifying a format
+
+You can specify how license headers should be formatted for different file types using glob patterns. The format configuration supports line comments, block comments, or a combination of both:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        lines: ['Copyright notice here']
+      },
+      format: {
+        // Line comments
+        '**/*.ts': {
+          lineStart: '// '
+        },
+
+        // Block comments
+        '**/*.css': {
+          blockStart: '/*',
+          blockEnd: '*/'
+        },
+
+        // Block comments with line prefixes
+        '**/*.java': {
+          blockStart: '/*',
+          lineStart: ' * ',
+          blockEnd: ' */'
+        },
+
+        // Line comments with header/footer
+        '**/*.py': {
+          blockStart: '# ------------',
+          lineStart: '# ',
+          blockEnd: '# ------------'
+        }
+      }
+    }
+  }
+}
+```
+
+The format configuration supports:
+
+- `blockStart`: Text written before the license content (e.g., to start a block comment)
+- `lineStart`: Text prepended to each line of the license content
+- `lineEnd`: Text appended to each line of the license content
+- `blockEnd`: Text written after the license content (e.g., to end a block comment)
+
+### Custom comment syntax
+
+For file types that aren't natively supported, you can specify custom comment syntax:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        lines: ['My license header']
+      },
+      format: {
+        '**/*.xyz': {
+          lineStart: '## '
+        }
+      },
+      commentSyntax: {
+        xyz: {
+          line: '##'  // Define line comment syntax
+        },
+        abc: {
+          block: {    // Define block comment syntax
+            start: '<!--',
+            end: '-->'
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+This tells the sync generator how to identify existing license headers in these file types. The `commentSyntax` configuration supports:
+
+- `line`: Characters that start a line comment
+- `block`: Characters that start and end a block comment
+
+### Excluding files
+
+By default, in a git repository, all `.gitignore` files are honored to ensure that only files managed by version control are synchronized. In non-git repositories, all files are considered unless explicitly excluded in configuration.
+
+You can exclude additional files from license header synchronization using glob patterns:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        lines: ['My license header']
+      },
+      format: {
+        '**/*.ts': {
+          lineStart: '// '
+        }
+      },
+      exclude: [
+        '**/generated/**',
+        '**/dist/**',
+        'some-specific-file.ts'
+      ]
+    }
+  }
+}
+```
+
+### Excluding projects from LICENSE file sync
+
+You can exclude specific projects from LICENSE file synchronization using glob patterns:
+
+```typescript
+{
+  license: {
+    files: {
+      exclude: ['packages/excluded-project', 'apps/internal-*'];
+    }
+  }
+}
+```
+
+When excluded, these projects will not receive a copy of the root LICENSE file during synchronization.
+
+## Disabling license sync
+
+To disable the license sync generator:
+
+1. Remove the `license` section from your configuration in `aws-nx-plugin.config.mts` (or remove the `aws-nx-plugin.config.mts` file)
+2. Remove the `@aws/nx-plugin:license#sync` generator from `targetDefaults.lint.syncGenerators`
+
+To re-enable license sync, simply run the `license` generator again.

package/src/license/__snapshots__/config.spec.ts.snap

@@ -0,0 +1,89 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`license config > defaultLicenseConfig > should generate default license config for ASL 1`] = `
+{
+  "header": {
+    "content": {
+      "lines": [
+        "Copyright Test Inc. or its affiliates. All Rights Reserved.                                                      ",
+        "                                                                                                                 ",
+        "Licensed under the Amazon Software License (the "License"). You may not use this file except in compliance       ",
+        "with the License. A copy of the License is located at                                                            ",
+        "                                                                                                                 ",
+        "   https://aws.amazon.com/asl/                                                                                   ",
+        "                                                                                                                 ",
+        "or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES",
+        "OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions   ",
+        "and limitations under the License.                                                                               ",
+      ],
+    },
+    "exclude": [],
+    "format": {
+      "**/*.{js,ts}": {
+        "blockEnd": " **********************************************************************************************************************/",
+        "blockStart": "/**********************************************************************************************************************",
+        "lineEnd": " *",
+        "lineStart": " *  ",
+      },
+      "**/*.{py,sh}": {
+        "blockEnd": "######################################################################################################################",
+        "blockStart": "######################################################################################################################",
+        "lineEnd": " #",
+        "lineStart": "#  ",
+      },
+    },
+  },
+}
+`;
+
+exports[`license config > defaultLicenseConfig > should generate default license config for Apache-2.0 1`] = `
+{
+  "header": {
+    "content": {
+      "lines": [
+        "Copyright Test Inc. or its affiliates. All Rights Reserved.",
+        "SPDX-License-Identifier: Apache-2.0",
+      ],
+    },
+    "exclude": [],
+    "format": {
+      "**/*.{js,ts}": {
+        "blockEnd": " */",
+        "blockStart": "/**",
+        "lineStart": " * ",
+      },
+      "**/*.{py,sh}": {
+        "blockEnd": "# ",
+        "blockStart": "# ",
+        "lineStart": "# ",
+      },
+    },
+  },
+}
+`;
+
+exports[`license config > defaultLicenseConfig > should generate default license config for MIT 1`] = `
+{
+  "header": {
+    "content": {
+      "lines": [
+        "Copyright Test Inc. or its affiliates. All Rights Reserved.",
+        "SPDX-License-Identifier: MIT",
+      ],
+    },
+    "exclude": [],
+    "format": {
+      "**/*.{js,ts}": {
+        "blockEnd": " */",
+        "blockStart": "/**",
+        "lineStart": " * ",
+      },
+      "**/*.{py,sh}": {
+        "blockEnd": "# ",
+        "blockStart": "# ",
+        "lineStart": "# ",
+      },
+    },
+  },
+}
+`;