refactor(nx-plugin): enhance plugin handling and directory management

- Replace direct mkdir calls with makeDir utility for consistent directory creation.
- Update plugin handling in client generation to support additional plugins.
- Modify tests and schemas to reflect changes in plugin structure and options.
- Improve error handling and logging in updateApi executor.
- Add formatting functionality for generated files and update README for clarity.

Author: seriouslag

packages/nx-plugin/src/executors/update-api/schema.d.ts

@@ -1,3 +1,5 @@
+import type { Plugin } from '../../utils';
+
 export interface UpdateApiExecutorSchema {
   client: string;
   directory: string;
@@ -6,7 +8,7 @@ export interface UpdateApiExecutorSchema {
    */
   force?: boolean;
   name: string;
-  plugins: string[];
+  plugins: Plugin[];
   scope: string;
   spec: string;
   /**

packages/nx-plugin/src/executors/update-api/updateApi.spec.ts

@@ -1,5 +1,5 @@
 import { existsSync } from 'node:fs';
-import { mkdir, readFile, rm, writeFile } from 'node:fs/promises';
+import { readFile, rm, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 
 import type { initConfigs } from '@hey-api/openapi-ts/internal';
@@ -9,6 +9,7 @@ import { afterAll, describe, expect, it, vi } from 'vitest';
 
 import generator from '../../generators/openapi-client/openapiClient';
 import { getGeneratorOptions, TestOptions } from '../../test-utils';
+import { makeDir } from '../../utils';
 import { CONSTANTS } from '../../vars';
 import type { UpdateApiExecutorSchema } from './schema';
 import executor from './updateApi';
@@ -55,7 +56,7 @@ const getExecutorOptions = async (name: string) => {
   // Create the API directory and spec file
   const absoluteApiDir = join(process.cwd(), apiDir);
   if (!existsSync(absoluteApiDir)) {
-    await mkdir(absoluteApiDir, { recursive: true });
+    await makeDir(absoluteApiDir);
   }
   const specPath = join(apiDir, testSpecName);
   const absoluteSpecPath = join(process.cwd(), specPath);
@@ -140,9 +141,7 @@ describe('UpdateApi Executor', () => {
       'api',
       'invalid.yaml',
     );
-    await mkdir(join(process.cwd(), options.directory, options.name, 'api'), {
-      recursive: true,
-    });
+    await makeDir(join(process.cwd(), options.directory, options.name, 'api'));
     await writeFile(invalidSpecPath, 'invalid: yaml');
     options.spec = invalidSpecPath;
 
@@ -197,16 +196,13 @@ describe('UpdateApi Executor', () => {
       'new-spec.yaml',
     );
     const existingSpec = await readFile(existingSpecPath, 'utf-8');
-    await mkdir(
+    await makeDir(
       join(
         process.cwd(),
         options.directory,
         options.name,
         CONSTANTS.SPEC_DIR_NAME,
       ),
-      {
-        recursive: true,
-      },
     );
     await writeFile(newSpecPath, existingSpec);
     options.spec = newSpecPath;
@@ -257,9 +253,7 @@ paths:
 `;
     await generator(tree, generatorOptions);
 
-    await mkdir(absoluteApiDir, {
-      recursive: true,
-    });
+    await makeDir(absoluteApiDir);
     if (existsSync(v2SpecPath)) {
       logger.debug(`Spec file already exists: ${v2SpecPath}`);
       await writeFile(v2SpecPath, v2Spec);

packages/nx-plugin/src/executors/update-api/updateApi.ts

@@ -1,14 +1,17 @@
 import { existsSync, writeFileSync } from 'node:fs';
-import { cp, mkdir, readFile, rm } from 'node:fs/promises';
+import { cp, readFile, rm } from 'node:fs/promises';
 import { join } from 'node:path';
 
 import type { PromiseExecutor } from '@nx/devkit';
-import { logger } from '@nx/devkit';
+import { logger, names } from '@nx/devkit';
+import { format } from 'prettier';
 
 import {
   bundleAndDereferenceSpecFile,
   compareSpecs,
+  formatFiles,
   generateClientCode,
+  makeDir,
 } from '../../utils';
 import { CONSTANTS } from '../../vars';
 import type { UpdateApiExecutorSchema } from './schema';
@@ -40,7 +43,7 @@ async function setup({
 
   if (!existsSync(absoluteTempApiFolder)) {
     logger.debug(`Creating executor temp api folder: ${absoluteTempApiFolder}`);
-    await mkdir(absoluteTempApiFolder, { recursive: true });
+    await makeDir(absoluteTempApiFolder);
     logger.debug(`Created temp API folder: ${absoluteTempApiFolder}`);
   } else {
     logger.debug(`Temp API folder already exists: ${absoluteTempApiFolder}`);
@@ -129,7 +132,11 @@ const runExecutor: PromiseExecutor<UpdateApiExecutorSchema> = async (
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   _context,
 ) => {
-  const tempFolder = options.tempFolder ?? CONSTANTS.TMP_DIR_NAME;
+  const tempFolder =
+    // use the provided temp folder or use the default temp folder and append the project name to it
+    // we append the project name to the temp folder to avoid conflicts between different projects using the same temp folder
+    options.tempFolder ??
+    join(CONSTANTS.TMP_DIR_NAME, names(options.name).fileName);
   const absoluteTempFolder = join(process.cwd(), tempFolder);
   const force = options.force ?? false;
 
@@ -160,6 +167,7 @@ const runExecutor: PromiseExecutor<UpdateApiExecutorSchema> = async (
       logger.info('No changes detected in the API spec.');
       if (!force) {
         logger.info('Force flag is false. Skipping client code generation.');
+        await cleanup(absoluteTempFolder);
         return { success: true };
       } else {
         logger.info('Force flag is true. Generating new client code...');
@@ -175,7 +183,7 @@ const runExecutor: PromiseExecutor<UpdateApiExecutorSchema> = async (
     const absoluteGeneratedTempDir = join(process.cwd(), generatedTempDir);
 
     if (!existsSync(absoluteGeneratedTempDir)) {
-      await mkdir(absoluteGeneratedTempDir);
+      await makeDir(absoluteGeneratedTempDir);
     }
 
     // Generate new client code
@@ -200,7 +208,10 @@ const runExecutor: PromiseExecutor<UpdateApiExecutorSchema> = async (
       } else {
         logger.debug('No existing spec file found. Creating...');
       }
-      writeFileSync(absoluteExistingSpecPath, newSpecString);
+      const formattedSpec = await format(newSpecString, {
+        parser: 'yaml',
+      });
+      writeFileSync(absoluteExistingSpecPath, formattedSpec);
       logger.debug(`Spec file updated successfully`);
     } else {
       logger.error(
@@ -224,34 +235,50 @@ const runExecutor: PromiseExecutor<UpdateApiExecutorSchema> = async (
 
     // Remove old generated directory if it exists
     if (existsSync(absoluteProjectGeneratedDir)) {
+      logger.debug(
+        `Removing old generated directory: ${absoluteProjectGeneratedDir}`,
+      );
       await rm(absoluteProjectGeneratedDir, {
         force: true,
         recursive: true,
       });
+      logger.debug(
+        `Old generated directory removed successfully: ${absoluteProjectGeneratedDir}`,
+      );
     }
 
     // Copy new generated directory
     await cp(absoluteGeneratedTempDir, absoluteProjectGeneratedDir, {
       recursive: true,
     });
 
+    logger.debug('Formatting generated directory...');
+    await formatFiles(absoluteProjectGeneratedDir);
+
     logger.info('Successfully updated API client and spec files.');
+    await cleanup(absoluteTempFolder);
     return { success: true };
   } catch (error) {
     const errorMessage = error instanceof Error ? error.message : String(error);
-    logger.debug(`Error details: ${errorMessage}.`);
-    return { success: false };
-  } finally {
+    logger.error(`Error details: ${errorMessage}.`);
     await cleanup(absoluteTempFolder);
+    return { error: errorMessage, success: false };
   }
 };
 
-async function cleanup(tempFolder: string) {
-  const absoluteTempFolder = join(process.cwd(), tempFolder);
+async function cleanup(absoluteTempFolder: string) {
+  logger.debug('Cleaning up executor environment...');
 
   if (existsSync(absoluteTempFolder)) {
+    logger.debug(`Removing temp folder: ${absoluteTempFolder}`);
     await rm(absoluteTempFolder, { force: true, recursive: true });
+    logger.debug(`Temp folder removed successfully: ${absoluteTempFolder}`);
+  } else {
+    logger.debug(
+      `Temp folder does not exist: ${absoluteTempFolder}. Skipping cleanup.`,
+    );
   }
+  logger.debug('Executor  cleaned up successfully.');
 }
 
 export default runExecutor;

packages/nx-plugin/src/generators/openapi-client/README.md

@@ -94,4 +94,4 @@ The generator adds the following dependencies to the created project:
 - [x] Support additional client types
 - [x] Dogfood the spec bundling and dereferencing
 - [ ] Support different test frameworks
-- [ ] Add linting generation for
+- [ ] Add linting generation

packages/nx-plugin/src/generators/openapi-client/files/openapi-ts.config.ts.template

@@ -6,7 +6,7 @@ export default defineConfig({
   plugins: [
     '<%= clientType %>',
     <% for(let x = 0; x < plugins.length; x++) { %>
-      '<%= plugins[x] %>'
+      '<%= plugins[x] %>',
     <% } %>
   ],
 });

packages/nx-plugin/src/generators/openapi-client/files/src/index.ts.template

@@ -1 +1,2 @@
 export * from './generated';
+export * from './generated/client.gen';

packages/nx-plugin/src/generators/openapi-client/openapiClient.schema.json

@@ -61,6 +61,11 @@
       "type": "boolean",
       "description": "Whether to make the generated package private, put false if you want to publish the package.",
       "default": true
+    },
+    "asClass": {
+      "type": "boolean",
+      "description": "** not working ** Whether to use the class style for the generated code, defaults to `false`",
+      "default": false
     }
   },
   "required": ["name", "spec", "scope"]

packages/nx-plugin/src/generators/openapi-client/openapiClient.spec.ts

@@ -1,13 +1,13 @@
 import { randomUUID } from 'node:crypto';
-import { existsSync, mkdirSync, rmSync } from 'node:fs';
+import { existsSync, rmSync } from 'node:fs';
 import { join } from 'node:path';
 
 import type { initConfigs } from '@hey-api/openapi-ts/internal';
 import { readJson } from '@nx/devkit';
 import { afterAll, beforeEach, describe, expect, it, vi } from 'vitest';
 
 import { getGeneratorOptions } from '../../test-utils';
-import { generateClientCode } from '../../utils';
+import { generateClientCode, makeDir } from '../../utils';
 import generator, { updateTsConfig } from './openapiClient';
 import {
   generateApi,
@@ -78,7 +78,7 @@ describe('openapi-client generator', () => {
       expect(normalized).toEqual({
         clientType: '@hey-api/client-fetch',
         isPrivate: true,
-        plugins: [],
+        plugins: ['@hey-api/typescript', '@hey-api/sdk'],
         projectDirectory: `${tempDirectory}/test-api-${uuid}`,
         projectName: 'test-api',
         projectRoot: `${tempDirectory}/test-api-${uuid}/test-api`,
@@ -107,7 +107,7 @@ describe('openapi-client generator', () => {
       expect(normalized).toEqual({
         clientType: '@hey-api/client-fetch',
         isPrivate: true,
-        plugins: [],
+        plugins: ['@hey-api/typescript', '@hey-api/sdk'],
         projectDirectory: 'custom-dir',
         projectName: 'test-api',
         projectRoot: 'custom-dir/test-api',
@@ -330,7 +330,7 @@ describe('openapi-client generator', () => {
       // Create necessary directories
       const fullProjectRoot = join(process.cwd(), projectRoot);
       if (!existsSync(fullProjectRoot)) {
-        mkdirSync(fullProjectRoot, { recursive: true });
+        await makeDir(fullProjectRoot);
       }
 
       await expect(