@aligent/nx-cdk 0.7.0 → 0.8.1

package/README.md

@@ -59,13 +59,17 @@ The service generator creates a new CDK service within the `services/` folder of
 
 ```bash
 yarn nx g @aligent/nx-cdk:service <service-name>
+
+# Or simply (since the generator name is unique):
+yarn nx g service <service-name>
 ```
 
 #### Options
 
-| Option | Type   | Required | Description                                                               |
-| ------ | ------ | -------- | ------------------------------------------------------------------------- |
-| `name` | string | Yes      | The name of the service (cannot contain 'Stack' or 'Service' in the name) |
+| Option    | Type    | Required | Default | Description                                                               |
+| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------- |
+| `name`    | string  | Yes      | -       | The name of the service (cannot contain 'Stack' or 'Service' in the name) |
+| `example` | boolean | No       | `false` | Generate example code with sample resources                               |
 
 #### What it creates
 
@@ -89,11 +93,56 @@ The service generator creates a new service in `services/<service-name>/` with:
 #### Example
 
 ```bash
-# Create a new service named "user-management"
+# Create a new service named "user-management" (short form)
+yarn nx g service user-management
+
+# Or with the full plugin prefix
 yarn nx g @aligent/nx-cdk:service user-management
+```
+
+### Remove Service Generator
+
+The remove-service generator cleanly removes a service and all of its references from the project. It reverses the changes made by the service generator, ensuring no dangling imports or references are left behind.
+
+#### Usage
+
+```bash
+yarn nx g @aligent/nx-cdk:remove-service <service-name>
+
+# Or simply (since the generator name is unique):
+yarn nx g remove-service <service-name>
+```
+
+#### Options
+
+| Option        | Type    | Required | Default | Description                                     |
+| ------------- | ------- | -------- | ------- | ----------------------------------------------- |
+| `name`        | string  | Yes      | -       | The name of the service to remove               |
+| `forceRemove` | boolean | No       | `false` | Skip dependency check when removing the project |
+
+#### What it does
+
+The remove generator performs the following cleanup:
+
+- **Application updates**:
+  - Removes the service's import declaration from `application/lib/service-stacks.ts`
+  - Removes the stack instantiation from the `ApplicationStage` constructor
+
+- **Root updates**:
+  - Removes the service from the root `tsconfig.json` references
+  - Removes the service from the root `package.json` workspaces (if present)
+
+- **Service files**:
+  - Deletes the entire `services/<service-name>/` directory
+
+#### Example
+
+```bash
+# Remove the "user-management" service (short form)
+yarn nx g remove-service user-management
 
-# Create a new service named "payment-processing"
-yarn nx g @aligent/nx-cdk:service payment-processing
+# Or with the full plugin prefix
+yarn nx g @aligent/nx-cdk:remove-service user-management
 ```
 
 ## Project Structure

package/generators.json

@@ -10,6 +10,11 @@
             "factory": "./src/generators/service/generator",
             "schema": "./src/generators/service/schema.json",
             "description": "Generate a new service"
+        },
+        "remove-service": {
+            "factory": "./src/generators/remove-service/generator",
+            "schema": "./src/generators/remove-service/schema.json",
+            "description": "Remove a service and clean up its references"
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aligent/nx-cdk",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",

package/src/generators/constants.d.ts

@@ -0,0 +1,5 @@
+export type ProjectType = 'application' | 'service';
+export declare const MAIN_APPLICATION_FOLDER = "application";
+export declare const MAIN_APPLICATION_NAME = "application";
+export declare const SERVICES_FOLDER = "services";
+export declare const SERVICES_SCOPE = "@services";

package/src/generators/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SERVICES_SCOPE = exports.SERVICES_FOLDER = exports.MAIN_APPLICATION_NAME = exports.MAIN_APPLICATION_FOLDER = void 0;
+exports.MAIN_APPLICATION_FOLDER = 'application';
+exports.MAIN_APPLICATION_NAME = 'application';
+exports.SERVICES_FOLDER = 'services';
+exports.SERVICES_SCOPE = '@services';

package/src/generators/helpers/configs/base-package/package.json

@@ -24,7 +24,7 @@
     "@aligent/cdk-aspects": "^0.5.5",
     "@aligent/cdk-nodejs-function-from-entry": "^0.2.1",
     "@aligent/cdk-step-function-from-file": "^0.5.1",
-    "@aligent/nx-openapi": "^2.2.1",
+    "@aligent/nx-openapi": "^2.1.1",
     "@aligent/ts-code-standards": "^4.2.1",
     "@nx/eslint": "22.1.3",
     "@nx/eslint-plugin": "22.1.3",

package/src/generators/helpers/configs/nxJson.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NX_JSON = void 0;
+const constants_1 = require("../../constants");
 exports.NX_JSON = {
     $schema: './node_modules/nx/schemas/nx-schema.json',
     defaultBase: 'origin/staging',
@@ -37,7 +38,11 @@ exports.NX_JSON = {
             configurations: { coverage: { coverage: true } },
         },
         typecheck: { cache: true, inputs: ['default', '^production'] },
-        cdk: { dependsOn: [{ target: 'build', params: 'forward', projects: '@services/*' }] },
-        pg: { dependsOn: [{ target: 'build', params: 'forward', projects: '@services/*' }] },
+        cdk: {
+            dependsOn: [{ target: 'build', params: 'forward', projects: `${constants_1.SERVICES_SCOPE}/*` }],
+        },
+        pg: {
+            dependsOn: [{ target: 'build', params: 'forward', projects: `${constants_1.SERVICES_SCOPE}/*` }],
+        },
     },
 };

package/src/generators/helpers/utilities.d.ts

@@ -1,4 +1,5 @@
 import { Tree } from '@nx/devkit';
+import { ProjectType } from '../constants';
 interface PackageJsonInput {
     name: string;
     projectName: string;
@@ -20,7 +21,7 @@ export declare function constructPackageJsonFile(input: PackageJsonInput): {
         node?: never;
     };
 };
-export declare function constructProjectTsConfigFiles(type: 'application' | 'service'): {
+export declare function constructProjectTsConfigFiles(type: ProjectType): {
     tsConfig: {
         extends: string;
         compilerOptions?: Record<string, unknown>;
@@ -61,6 +62,25 @@ export declare function getGeneratorVersion(): string;
  * @throws {Error} If the ApplicationStage constructor cannot be found in service-stacks.ts
  */
 export declare function addServiceStackToMainApplication(tree: Tree, service: Service, projectName: string): void;
+/**
+ * Removes a service stack registration from the main CDK application's ApplicationStage.
+ *
+ * This function modifies the service-stacks.ts file by:
+ * 1. Removing import statements that reference the service's module specifier
+ * 2. Removing statements in the ApplicationStage constructor that reference the service's stack class
+ *
+ * @param tree - The Nx virtual file system tree
+ * @param serviceName - The name of the service (e.g., "companies")
+ * @param projectName - The name of the main application project
+ */
+export declare function removeServiceFromMainApplication(tree: Tree, serviceName: string, projectName: string): void;
+/**
+ * Removes a project reference from the root tsconfig.json.
+ *
+ * @param tree - The Nx virtual file system tree
+ * @param referencePath - The path to remove from the references array
+ */
+export declare function removeTsConfigReference(tree: Tree, referencePath: string): void;
 /**
  * Splits a kebab-case name into an array of capitalized parts.
  *

package/src/generators/helpers/utilities.js

@@ -4,11 +4,14 @@ exports.constructPackageJsonFile = constructPackageJsonFile;
 exports.constructProjectTsConfigFiles = constructProjectTsConfigFiles;
 exports.getGeneratorVersion = getGeneratorVersion;
 exports.addServiceStackToMainApplication = addServiceStackToMainApplication;
+exports.removeServiceFromMainApplication = removeServiceFromMainApplication;
+exports.removeTsConfigReference = removeTsConfigReference;
 exports.splitInputName = splitInputName;
 /* v8 ignore start */
 const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
 const ts_morph_1 = require("ts-morph");
+const constants_1 = require("../constants");
 const tsConfigs_1 = require("./configs/tsConfigs");
 /**
  * Reads the base package.json configuration from a JSON file.
@@ -101,7 +104,7 @@ function addServiceStackToMainApplication(tree, service, projectName) {
         throw new Error('Unable to find main application stage constructor');
     }
     stackSource.addImportDeclaration({
-        moduleSpecifier: `@services/${service.name}`,
+        moduleSpecifier: `${constants_1.SERVICES_SCOPE}/${service.name}`,
         namedImports: [service.constant, service.stack],
     });
     const sharedInfra = stageConstructor.getVariableStatement('sharedInfra');
@@ -109,6 +112,69 @@ function addServiceStackToMainApplication(tree, service, projectName) {
     stageConstructor.addStatements(`new ${service.stack}(this, ${service.constant}.NAME, { ...props, ${sharedPropsStatement} description: ${service.constant}.DESCRIPTION });`);
     tree.write(stacksRelativePath, stackSource.getFullText());
 }
+/**
+ * Removes a service stack registration from the main CDK application's ApplicationStage.
+ *
+ * This function modifies the service-stacks.ts file by:
+ * 1. Removing import statements that reference the service's module specifier
+ * 2. Removing statements in the ApplicationStage constructor that reference the service's stack class
+ *
+ * @param tree - The Nx virtual file system tree
+ * @param serviceName - The name of the service (e.g., "companies")
+ * @param projectName - The name of the main application project
+ */
+function removeServiceFromMainApplication(tree, serviceName, projectName) {
+    const application = (0, devkit_1.readProjectConfiguration)(tree, projectName);
+    if (application.root.includes('..')) {
+        throw new Error('Invalid application root path');
+    }
+    const stacksRelativePath = (0, path_1.join)(application.root, 'lib/service-stacks.ts');
+    if (!tree.exists(stacksRelativePath)) {
+        console.log('Service Stacks does not exist, skipping service stacks cleanup.');
+        return;
+    }
+    const content = tree.read(stacksRelativePath, 'utf-8');
+    if (content === null) {
+        throw new Error(`Failed to read file: ${stacksRelativePath}`);
+    }
+    const fs = new ts_morph_1.InMemoryFileSystemHost();
+    fs.writeFileSync(stacksRelativePath, content);
+    const project = new ts_morph_1.Project({ fileSystem: fs });
+    const stackSource = project.addSourceFileAtPath(stacksRelativePath);
+    const imports = stackSource.getImportDeclarations();
+    for (const importDecl of imports) {
+        if (importDecl.getModuleSpecifierValue() === `${constants_1.SERVICES_SCOPE}/${serviceName}`) {
+            importDecl.remove();
+        }
+    }
+    const nameParts = splitInputName(serviceName);
+    const stackClassName = `${nameParts.join('')}Stack`;
+    const applicationStage = stackSource.getClass('ApplicationStage');
+    if (applicationStage) {
+        const stageConstructor = applicationStage.getConstructors()[0];
+        if (stageConstructor) {
+            const statements = stageConstructor.getStatements();
+            for (const statement of statements) {
+                if (statement.getText().includes(`new ${stackClassName}(`)) {
+                    statement.remove();
+                }
+            }
+        }
+    }
+    tree.write(stacksRelativePath, stackSource.getFullText());
+}
+/**
+ * Removes a project reference from the root tsconfig.json.
+ *
+ * @param tree - The Nx virtual file system tree
+ * @param referencePath - The path to remove from the references array
+ */
+function removeTsConfigReference(tree, referencePath) {
+    (0, devkit_1.updateJson)(tree, 'tsconfig.json', json => {
+        json.references = (json.references ?? []).filter((r) => r.path !== referencePath);
+        return json;
+    });
+}
 /**
  * Splits a kebab-case name into an array of capitalized parts.
  *

package/src/generators/preset/files/.github/workflows/release.yml.template

@@ -12,6 +12,7 @@ jobs:
     with:
       deploy: true
       deploy-command: yarn nx run application:cdk deploy
+      stack-name: prd/*
       environment-target: prd
       github-environment: production
     secrets: inherit

package/src/generators/preset/files/.github/workflows/stg-deployment.yml.template

@@ -12,6 +12,7 @@ jobs:
     with:
       deploy: true
       deploy-command: yarn nx run application:cdk deploy
+      stack-name: stg/*
       environment-target: stg
       github-environment: staging
     secrets: inherit

package/src/generators/preset/files/application/lib/service-stacks.ts.template

@@ -14,7 +14,13 @@ import type { Construct } from 'constructs';
  */
 export class ApplicationStage extends Stage {
     constructor(scope: Construct, id: string, props?: StageProps) {
-        super(scope, id, props);
+        super(scope, id, {
+            ...props,
+            env: {
+                account: process.env.CDK_DEFAULT_ACCOUNT,
+                region: process.env.CDK_DEFAULT_REGION || 'ap-southeast-2',
+            },
+        });
 
         const sharedInfra = new SharedInfraStack(this, 'shared-infra', props);
 

package/src/generators/preset/preset.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.presetGenerator = presetGenerator;
 const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
+const constants_1 = require("../constants");
 const nxJson_1 = require("../helpers/configs/nxJson");
 const utilities_1 = require("../helpers/utilities");
 async function presetGenerator(tree, options) {
@@ -30,8 +31,8 @@ async function presetGenerator(tree, options) {
     });
     (0, devkit_1.writeJson)(tree, 'package.json', packageJson);
     // Generate application's tsconfigs
-    const { tsConfig } = (0, utilities_1.constructProjectTsConfigFiles)('application');
-    (0, devkit_1.writeJson)(tree, 'application/tsconfig.json', tsConfig);
+    const { tsConfig } = (0, utilities_1.constructProjectTsConfigFiles)(constants_1.MAIN_APPLICATION_NAME);
+    (0, devkit_1.writeJson)(tree, `${constants_1.MAIN_APPLICATION_FOLDER}/tsconfig.json`, tsConfig);
     await (0, devkit_1.formatFiles)(tree);
 }
 exports.default = presetGenerator;

package/src/generators/remove-service/generator.d.ts

@@ -0,0 +1,4 @@
+import { Tree } from '@nx/devkit';
+import { RemoveGeneratorSchema } from './schema';
+export declare function removeGenerator(tree: Tree, options: RemoveGeneratorSchema): Promise<void>;
+export default removeGenerator;

package/src/generators/remove-service/generator.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeGenerator = removeGenerator;
+const devkit_1 = require("@nx/devkit");
+const constants_1 = require("../constants");
+const utilities_1 = require("../helpers/utilities");
+async function removeGenerator(tree, options) {
+    const { name, forceRemove } = options;
+    const projectRoot = `${constants_1.SERVICES_FOLDER}/${name}`;
+    const projectName = `${constants_1.SERVICES_SCOPE}/${name}`;
+    if (!tree.exists(projectRoot)) {
+        throw new Error(`Service "${name}" does not exist at "${projectRoot}".`);
+    }
+    if (!forceRemove) {
+        const graph = await (0, devkit_1.createProjectGraphAsync)();
+        const dependents = Object.entries(graph.dependencies)
+            .filter(([source]) => source !== projectName)
+            .filter(([, deps]) => deps.some(d => d.target === projectName))
+            .map(([source]) => source);
+        if (dependents.length > 0) {
+            throw new Error(`Cannot remove "${name}": it is depended on by ${dependents.join(', ')}. ` +
+                'Use --forceRemove to skip this check.');
+        }
+    }
+    (0, utilities_1.removeServiceFromMainApplication)(tree, name, constants_1.MAIN_APPLICATION_NAME);
+    (0, utilities_1.removeTsConfigReference)(tree, `./${projectRoot}`);
+    tree.delete(projectRoot);
+    if (tree.exists('package.json')) {
+        (0, devkit_1.updateJson)(tree, 'package.json', json => {
+            if (Array.isArray(json.workspaces)) {
+                json.workspaces = json.workspaces.filter((w) => w !== projectRoot);
+            }
+            return json;
+        });
+    }
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.default = removeGenerator;

package/src/generators/remove-service/schema.d.ts

@@ -0,0 +1,4 @@
+export interface RemoveGeneratorSchema {
+    name: string;
+    forceRemove?: boolean;
+}

package/src/generators/remove-service/schema.json

@@ -0,0 +1,23 @@
+{
+    "$schema": "http://json-schema.org/schema",
+    "$id": "RemoveServiceGenerator",
+    "title": "Remove a service and clean up its references",
+    "type": "object",
+    "properties": {
+        "name": {
+            "type": "string",
+            "description": "The name of the service to remove",
+            "$default": {
+                "$source": "argv",
+                "index": 0
+            },
+            "x-prompt": "What is the name of the service to remove?"
+        },
+        "forceRemove": {
+            "type": "boolean",
+            "description": "Skip dependency check when removing the project",
+            "default": false
+        }
+    },
+    "required": ["name"]
+}

package/src/generators/service/generator.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.serviceGenerator = serviceGenerator;
 const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
+const constants_1 = require("../constants");
 const utilities_1 = require("../helpers/utilities");
-const SERVICES_FOLDER = 'services';
 function addTsConfigReference(tree, referencePath) {
     (0, devkit_1.updateJson)(tree, 'tsconfig.json', json => {
         json.references ??= [];
@@ -16,12 +16,12 @@ function addTsConfigReference(tree, referencePath) {
     });
 }
 async function serviceGenerator(tree, options) {
-    const projectRoot = `${SERVICES_FOLDER}/${options.name}`;
+    const projectRoot = `${constants_1.SERVICES_FOLDER}/${options.name}`;
     const nameParts = (0, utilities_1.splitInputName)(options.name);
     const constant = nameParts.map(name => name.toUpperCase()).join('_');
     const stack = `${nameParts.join('')}Stack`;
-    if (!tree.exists(SERVICES_FOLDER)) {
-        tree.write(`${SERVICES_FOLDER}/.gitkeep`, '');
+    if (!tree.exists(constants_1.SERVICES_FOLDER)) {
+        tree.write(`${constants_1.SERVICES_FOLDER}/.gitkeep`, '');
     }
     const templateVars = {
         ...options,
@@ -41,7 +41,7 @@ async function serviceGenerator(tree, options) {
     (0, devkit_1.writeJson)(tree, `${projectRoot}/tsconfig.spec.json`, tsConfigSpec);
     // Integrate the new service with the root application
     addTsConfigReference(tree, `./${projectRoot}`);
-    (0, utilities_1.addServiceStackToMainApplication)(tree, { name: options.name, constant, stack }, 'application');
+    (0, utilities_1.addServiceStackToMainApplication)(tree, { name: options.name, constant, stack }, constants_1.MAIN_APPLICATION_NAME);
     await (0, devkit_1.formatFiles)(tree);
 }
 exports.default = serviceGenerator;