refactor(nx-plugin): improve file formatting utilities

Author: seriouslag

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

@@ -9,17 +9,13 @@ import {
 import { join } from 'node:path';
 
 import type { PromiseExecutor } from '@nx/devkit';
-import { logger, names, workspaceRoot } from '@nx/devkit';
-import {
-  format,
-  type Options as PrettierOptions,
-  resolveConfig,
-} from 'prettier';
+import { logger, names } from '@nx/devkit';
 
 import {
   bundleAndDereferenceSpecFile,
   compareSpecs,
   formatFiles,
+  formatStringFromFilePath,
   generateClientCode,
   isUrl,
   makeDir,
@@ -241,24 +237,17 @@ 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) {
         logger.debug('Existing spec file found. Updating...');
       } else {
         logger.debug('No existing spec file found. Creating...');
       }
-      const formattedSpec = await format(newSpecString, {
-        ...prettierOptions,
-        filepath: absoluteTempSpecPath,
-      });
+      const formattedSpec = await formatStringFromFilePath(
+        newSpecString,
+        absoluteTempSpecPath,
+      );
 
       await writeFile(absoluteExistingSpecPath, formattedSpec);
       logger.debug(`Spec file updated successfully`);
@@ -302,7 +291,7 @@ const runExecutor: PromiseExecutor<UpdateApiExecutorSchema> = async (
     });
 
     logger.debug('Formatting generated directory...');
-    await formatFiles(absoluteProjectGeneratedDir, prettierOptions);
+    await formatFiles(absoluteProjectGeneratedDir);
 
     logger.info('Successfully updated API client and spec files.');
     await cleanup(absoluteTempFolder);

packages/nx-plugin/src/utils.ts

@@ -11,7 +11,7 @@ import {
 } from '@hey-api/openapi-ts/internal';
 import { logger, workspaceRoot } from '@nx/devkit';
 import { compareOpenApi } from 'api-smart-diff';
-import { format, type Options as PrettierOptions } from 'prettier';
+import { format, resolveConfig } from 'prettier';
 import { convert } from 'swagger2openapi';
 
 import { CONSTANTS } from './vars';
@@ -335,22 +335,17 @@ export async function makeDir(path: string) {
   await mkdir(path, { recursive: true });
 }
 
-export async function formatFiles(
-  dir: string,
-  prettierOptions?: PrettierOptions,
-) {
+/**
+ * Formats all files in a directory
+ */
+export async function formatFiles(dir: string) {
   const files = await readdir(dir, { withFileTypes: true });
   const tasks = files.map(async (file) => {
     const filePath = join(dir, file.name);
     if (file.isDirectory()) {
-      await formatFiles(filePath, prettierOptions);
-    } else if (file.name.endsWith('.ts')) {
-      const content = await readFile(filePath, 'utf-8');
-      const formatted = await format(content, {
-        ...prettierOptions,
-        filepath: filePath,
-      });
-      await writeFile(filePath, formatted);
+      await formatFiles(filePath);
+    } else if (file.isFile()) {
+      await formatFile(filePath);
     }
   });
   await Promise.all(tasks);
@@ -434,3 +429,21 @@ export async function getBaseTsConfigPath({
   logger.error(message);
   throw new Error(message);
 }
+
+export async function formatFile(filePath: string) {
+  const content = await readFile(filePath, 'utf-8');
+  const formatted = await formatStringFromFilePath(content, filePath);
+  await writeFile(filePath, formatted);
+}
+
+export async function formatStringFromFilePath(
+  content: string,
+  filePath: string,
+) {
+  const prettierOptions = await resolveConfig(filePath);
+  const formatted = await format(content, {
+    ...prettierOptions,
+    filepath: filePath,
+  });
+  return formatted;
+}