feat(nx-plugin): add base tsconfig options for improved configuration management

- Introduce `baseTsConfigName` and `baseTsConfigPath` options in the OpenAPI client generator and update executor schemas.
- Enhance README documentation to reflect new options and their usage.
- Implement `getBaseTsConfigPath` utility to resolve tsconfig paths based on provided options.
- Update tests to cover new tsconfig path handling logic.

Author: seriouslag

packages/nx-plugin/README.md

@@ -32,6 +32,8 @@ Run in interactive mode `nx g @hey-api/nx-plugin:openapi-client`
   The defaults tags will not be added to the project if you specify this option.
 - `plugins`: Additional plugins to provide to the client api. [ string[] ] (optional)
 - `test`: The type of tests to setup. [ 'none' | 'vitest' ] (optional) (default: `none`)
+- `baseTsConfigName`: The name of the base tsconfig file that contains the compiler paths used to resolve the imports. Use this if the base tsconfig file is in the workspace root. If provided with a baseTsConfigPath then the baseTsConfigName will be added to the path. Do not use this if the baseTsConfigPath is a file. [ string ] (optional)
+- `baseTsConfigPath`: The path to the base tsconfig file that contains the compiler paths used to resolve the imports. Use this if the base tsconfig file is not in the workspace root. This can be a file or a directory. If it is a directory and the baseTsConfigName is provided then the baseTsConfigName will be added to the path. If it is a file and the baseTsConfigName is provided then there will be an error. [ string ] (optional)
 
 ##### Example
 
@@ -46,6 +48,8 @@ nx g @hey-api/nx-plugin:openapi-client --name=my-api --client=@hey-api/client-fe
 This executor updates the OpenAPI spec file and generates a new client.
 The options for the executor will be populated from the generator.
 
+No need to add them yourself, to modify the options manually edit the `project.json` of the generated project.
+
 Run `nx run @my-org/my-generated-package:updateApi`
 
 ##### Options

packages/nx-plugin/src/executors/update-api/updateApi.schema.json

@@ -39,7 +39,16 @@
       "description": "The plugins to be provided to @hey-api/openapi-ts",
       "default": [],
       "items": {
-        "type": "string"
+        "oneOf": [
+          { "type": "string" },
+          {
+            "type": "object",
+            "properties": {
+              "asClass": { "type": "boolean" },
+              "name": { "type": "string" }
+            }
+          }
+        ]
       }
     },
     "force": {

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

@@ -3,8 +3,12 @@ import { cp, readFile, rm } from 'node:fs/promises';
 import { join } from 'node:path';
 
 import type { PromiseExecutor } from '@nx/devkit';
-import { logger, names } from '@nx/devkit';
-import { format } from 'prettier';
+import { logger, names, workspaceRoot } from '@nx/devkit';
+import {
+  format,
+  type Options as PrettierOptions,
+  resolveConfig,
+} from 'prettier';
 
 import {
   bundleAndDereferenceSpecFile,
@@ -201,6 +205,13 @@ const runExecutor: PromiseExecutor<UpdateApiExecutorSchema> = async (
     const apiDirectoryExists = existsSync(absoluteApiDirectory);
     const existingSpecFileExists = existsSync(absoluteExistingSpecPath);
 
+    const prettierConfig = await resolveConfig(workspaceRoot, {
+      editorconfig: true,
+    });
+    const prettierOptions: PrettierOptions = {
+      ...prettierConfig,
+    };
+
     // Copy new spec to project
     if (apiDirectoryExists) {
       if (existingSpecFileExists) {
@@ -209,8 +220,10 @@ const runExecutor: PromiseExecutor<UpdateApiExecutorSchema> = async (
         logger.debug('No existing spec file found. Creating...');
       }
       const formattedSpec = await format(newSpecString, {
-        parser: 'yaml',
+        ...prettierOptions,
+        filepath: absoluteTempSpecPath,
       });
+
       writeFileSync(absoluteExistingSpecPath, formattedSpec);
       logger.debug(`Spec file updated successfully`);
     } else {
@@ -253,7 +266,7 @@ const runExecutor: PromiseExecutor<UpdateApiExecutorSchema> = async (
     });
 
     logger.debug('Formatting generated directory...');
-    await formatFiles(absoluteProjectGeneratedDir);
+    await formatFiles(absoluteProjectGeneratedDir, prettierOptions);
 
     logger.info('Successfully updated API client and spec files.');
     await cleanup(absoluteTempFolder);

packages/nx-plugin/src/generators/openapi-client/files/tsconfig.json.template

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.base.json",
+  "extends": "<%= pathToTsConfig %>/<%= tsConfigName %>",
   "compilerOptions": {
   },
   "files": [],

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

@@ -66,6 +66,14 @@
       "type": "boolean",
       "description": "** not working ** Whether to use the class style for the generated code, defaults to `false`",
       "default": false
+    },
+    "baseTsConfigName": {
+      "type": "string",
+      "description": "The name of the base tsconfig file that contains the compiler paths used to resolve the imports, use this if the base tsconfig file is in the workspace root, if provided with a baseTsConfigPath then the baseTsConfigName will be added to the path. DO not use this if the baseTsConfigPath is a file."
+    },
+    "baseTsConfigPath": {
+      "type": "string",
+      "description": "The path to the base tsconfig file that contains the compiler paths used to resolve the imports, use this if the base tsconfig file is not in the workspace root. This can be a file or a directory. If it is a directory and the baseTsConfigName is provided then the baseTsConfigName will be added to the path. If it is a file and the baseTsConfigName is provided then there will be an error."
     }
   },
   "required": ["name", "spec", "scope"]

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

@@ -77,7 +77,9 @@ describe('openapi-client generator', () => {
 
       expect(normalized).toEqual({
         clientType: '@hey-api/client-fetch',
+        baseTsConfigName: undefined,
         isPrivate: true,
+        baseTsConfigPath: undefined,
         plugins: ['@hey-api/typescript', '@hey-api/sdk'],
         projectDirectory: `${tempDirectory}/test-api-${uuid}`,
         projectName: 'test-api',
@@ -106,7 +108,9 @@ describe('openapi-client generator', () => {
 
       expect(normalized).toEqual({
         clientType: '@hey-api/client-fetch',
+        baseTsConfigName: undefined,
         isPrivate: true,
+        baseTsConfigPath: undefined,
         plugins: ['@hey-api/typescript', '@hey-api/sdk'],
         projectDirectory: 'custom-dir',
         projectName: 'test-api',

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

@@ -28,6 +28,7 @@ import {
   bundleAndDereferenceSpecFile,
   generateClientCode,
   generateClientCommand,
+  getBaseTsConfigPath,
   getPackageName,
   getPluginName,
   getVersionOfPackage,
@@ -128,6 +129,18 @@ export interface OpenApiClientGeneratorSchema {
    * Whether to use the class style for the generated code, defaults to `false`
    */
   asClass?: boolean;
+  /**
+   * The name of the base tsconfig file that contains the compiler paths used to resolve the imports, use this if the base tsconfig file is in the workspace root,
+   * if provided with a baseTsConfigPath then the baseTsConfigName will be added to the path.
+   * DO not use this if the baseTsConfigPath is a file.
+   */
+  baseTsConfigName?: string;
+  /**
+   * The path to the base tsconfig file that contains the compiler paths used to resolve the imports, use this if the base tsconfig file is not in the workspace root.
+   * This can be a file or a directory. If it is a directory and the baseTsConfigName is provided then the baseTsConfigName will be added to the path.
+   * If it is a file and the baseTsConfigName is provided then there will be an error.
+   */
+  baseTsConfigPath?: string;
   /**
    * The client to use for the OpenAPI client
    */
@@ -286,6 +299,8 @@ export default async function (
 }
 
 export interface NormalizedOptions {
+  baseTsConfigName: string | undefined;
+  baseTsConfigPath: string | undefined;
   clientType: string;
   isPrivate: boolean;
   plugins: Plugin[];
@@ -294,12 +309,16 @@ export interface NormalizedOptions {
   projectRoot: string;
   projectScope: string;
   specFile: string;
+  test: TestRunner | 'none';
   tagArray: string[];
   tempFolder: string;
-  test: TestRunner | 'none';
 }
 
-export type GeneratedOptions = NormalizedOptions & typeof CONSTANTS;
+export type GeneratedOptions = NormalizedOptions &
+  typeof CONSTANTS & {
+    pathToTsConfig: string;
+    tsConfigName: string;
+  };
 
 type ProjectConfigurationTargets = NonNullable<ProjectConfiguration['targets']>;
 type ValueType<T extends Record<string, any>> = T[keyof T];
@@ -335,7 +354,6 @@ export function normalizeOptions(
   const tempFolder =
     options.tempFolderDir ?? join(defaultTempFolder, projectName);
   const [default1, default2, ...rest] = defaultPlugins;
-  logger.debug('As Class', options.asClass);
   const plugins = [
     default1,
     options.asClass
@@ -350,7 +368,9 @@ export function normalizeOptions(
 
   return {
     clientType: options.client,
+    baseTsConfigName: options.baseTsConfigName,
     isPrivate: options.private ?? true,
+    baseTsConfigPath: options.baseTsConfigPath,
     plugins,
     projectDirectory,
     projectName,
@@ -413,6 +433,8 @@ export async function generateNxProject({
 }) {
   logger.debug(`Generating Nx project...`);
   const {
+    baseTsConfigName,
+    baseTsConfigPath,
     clientType,
     plugins,
     projectName,
@@ -476,6 +498,12 @@ export async function generateNxProject({
     );
   }
 
+  const { tsConfigDirectory, tsConfigName } = await getBaseTsConfigPath({
+    baseTsConfigName,
+    baseTsConfigPath,
+    projectRoot,
+  });
+
   // Create basic project structure
   addProjectConfiguration(tree, `${projectScope}/${projectName}`, {
     implicitDependencies: dependsOnProject ? [dependsOnProject] : [],
@@ -536,10 +564,15 @@ export async function generateNxProject({
     },
   });
 
+  /**
+   * The variables that are passed to the template files
+   */
   const generatedOptions: GeneratedOptions = {
     ...normalizedOptions,
     ...CONSTANTS,
+    pathToTsConfig: tsConfigDirectory,
     plugins: plugins.map(getPluginName),
+    tsConfigName,
   };
 
   // Create directory structure

packages/nx-plugin/src/generators/openapi-client/tests/vitest/tsconfig.spec.json.template

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.base.json",
+  "extends": "<%= pathToTsConfig %>/<%= tsConfigName %>",
   "compilerOptions": {
     "outDir": "./out-tsc/vitest",
     "types": [