feat(add-generate-api-target): add support for custom target name

Allow users to provide a custom target name when running the add-generate-api-target generator.
If a build target exists, automatically add the custom target to its dependsOn array.

Closes #38

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

Author: 2 people

packages/nx-plugin-openapi/src/generators/add-generate-api-target/generator.spec.ts

@@ -5,6 +5,7 @@ import {
   logger,
   readProjectConfiguration,
   Tree,
+  updateProjectConfiguration,
 } from '@nx/devkit';
 import { addGenerateApiGenerator } from './generator';
 import { AddGenerateApiSchema } from './schema';
@@ -206,4 +207,108 @@ describe('add-generate-api-target generator', () => {
       '[@lambda-solutions/nx-plugin-openapi] ✨ Successfully added generate-api target to test-app project'
     );
   });
+
+  describe('custom target name', () => {
+    it('should use custom target name when provided', async () => {
+      const options: AddGenerateApiSchema = {
+        project: 'test-app',
+        inputSpec: 'swagger.json',
+        outputPath: 'libs/api',
+        targetName: 'generate-client',
+      };
+
+      await addGenerateApiGenerator(tree, options);
+
+      const projectConfig = readProjectConfiguration(tree, 'test-app');
+      const target = projectConfig.targets['generate-client'];
+
+      expect(target).toBeDefined();
+      expect(projectConfig.targets['generate-api']).toBeUndefined();
+      expect(target.executor).toBe(
+        '@lambda-solutions/nx-plugin-openapi:generate-api'
+      );
+    });
+
+    it('should add custom target to build dependsOn', async () => {
+      // Add build target
+      const projectConfig = readProjectConfiguration(tree, 'test-app');
+      projectConfig.targets['build'] = {
+        executor: '@nx/webpack:build',
+        options: {},
+      };
+      updateProjectConfiguration(tree, 'test-app', projectConfig);
+
+      const options: AddGenerateApiSchema = {
+        project: 'test-app',
+        inputSpec: 'swagger.json',
+        outputPath: 'libs/api',
+        targetName: 'generate-client',
+      };
+
+      await addGenerateApiGenerator(tree, options);
+
+      const updatedConfig = readProjectConfiguration(tree, 'test-app');
+      expect(updatedConfig.targets['build'].dependsOn).toContain('generate-client');
+    });
+
+    it('should add default target name to build dependsOn when no custom name', async () => {
+      // Add build target
+      const projectConfig = readProjectConfiguration(tree, 'test-app');
+      projectConfig.targets['build'] = {
+        executor: '@nx/webpack:build',
+        options: {},
+      };
+      updateProjectConfiguration(tree, 'test-app', projectConfig);
+
+      const options: AddGenerateApiSchema = {
+        project: 'test-app',
+        inputSpec: 'swagger.json',
+        outputPath: 'libs/api',
+      };
+
+      await addGenerateApiGenerator(tree, options);
+
+      const updatedConfig = readProjectConfiguration(tree, 'test-app');
+      expect(updatedConfig.targets['build'].dependsOn).toContain('generate-api');
+    });
+
+    it('should not duplicate target in build dependsOn', async () => {
+      // Add build target with existing dependsOn
+      const projectConfig = readProjectConfiguration(tree, 'test-app');
+      projectConfig.targets['build'] = {
+        executor: '@nx/webpack:build',
+        options: {},
+        dependsOn: ['generate-client'],
+      };
+      updateProjectConfiguration(tree, 'test-app', projectConfig);
+
+      const options: AddGenerateApiSchema = {
+        project: 'test-app',
+        inputSpec: 'swagger.json',
+        outputPath: 'libs/api',
+        targetName: 'generate-client',
+      };
+
+      await addGenerateApiGenerator(tree, options);
+
+      const updatedConfig = readProjectConfiguration(tree, 'test-app');
+      expect(updatedConfig.targets['build'].dependsOn).toEqual(['generate-client']);
+      expect(updatedConfig.targets['build'].dependsOn.length).toBe(1);
+    });
+
+    it('should log correct success message with custom target name', async () => {
+      const options: AddGenerateApiSchema = {
+        project: 'test-app',
+        inputSpec: 'swagger.json',
+        outputPath: 'libs/api',
+        targetName: 'my-custom-api',
+      };
+
+      await addGenerateApiGenerator(tree, options);
+
+      expect(mockedLogger.info).toHaveBeenCalledWith(
+        '[@lambda-solutions/nx-plugin-openapi] ✨ Successfully added my-custom-api target to test-app project'
+      );
+    });
+  });
 });

packages/nx-plugin-openapi/src/generators/add-generate-api-target/generator.ts

@@ -15,7 +15,7 @@ export async function addGenerateApiGenerator(
   tree: Tree,
   options: AddGenerateApiSchema
 ) {
-  const targetName = 'generate-api';
+  const targetName = options.targetName || 'generate-api';
 
   // Read the project configuration
   const projectConfig = readProjectConfiguration(tree, options.project);
@@ -33,6 +33,9 @@ export async function addGenerateApiGenerator(
   // Add the new target
   addTarget({ projectConfig, targetName, options });
 
+  // Update build target's dependsOn if it exists
+  updateBuildTargetDependsOn({ projectConfig, targetName });
+
   // Update the project configuration
   updateProjectConfiguration(tree, options.project, projectConfig);
 
@@ -78,3 +81,22 @@ function addTarget(args: {
     },
   };
 }
+
+function updateBuildTargetDependsOn(args: {
+  projectConfig: ProjectConfiguration;
+  targetName: string;
+}) {
+  const { projectConfig, targetName } = args;
+  const buildTarget = projectConfig.targets?.['build'];
+  
+  if (buildTarget) {
+    if (!buildTarget.dependsOn) {
+      buildTarget.dependsOn = [];
+    }
+    
+    // Check if the target is already in dependsOn
+    if (!buildTarget.dependsOn.includes(targetName)) {
+      buildTarget.dependsOn.push(targetName);
+    }
+  }
+}

packages/nx-plugin-openapi/src/generators/add-generate-api-target/schema.d.ts

@@ -6,4 +6,5 @@ export interface AddGenerateApiSchema {
   configFile?: string;
   skipValidateSpec?: boolean;
   addToGitignore?: boolean;
+  targetName?: string;
 }

packages/nx-plugin-openapi/src/generators/add-generate-api-target/schema.json

@@ -36,6 +36,12 @@
       "description": "Whether to add the output path to .gitignore",
       "default": true,
       "x-prompt": "Would you like to add the output path to .gitignore?"
+    },
+    "targetName": {
+      "type": "string",
+      "description": "Custom name for the generate-api target",
+      "default": "generate-api",
+      "x-prompt": "What name would you like to use for the target? (default: generate-api)"
     }
   },
   "required": ["project", "inputSpec", "outputPath"]