feat: add format effected files

heroui-inc · Jan 11, 2025 · 64caf22 · 64caf22
1 parent b3bf4a8
commit 64caf22
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 6 deletions.
diff --git a/packages/codemod/src/actions/migrate-action.ts b/packages/codemod/src/actions/migrate-action.ts
@@ -6,14 +6,15 @@ import chalk from 'chalk';
 import {confirmClack} from 'src/prompts/clack';
 
 import {NEXTUI_PREFIX} from '../constants/prefix';
+import {lintEffectedFiles} from '../helpers/actions/lint-effected-files';
 import {migrateCssVariables} from '../helpers/actions/migrate/migrate-css-variables';
 import {migrateImportPackageWithPaths} from '../helpers/actions/migrate/migrate-import';
 import {migrateJson} from '../helpers/actions/migrate/migrate-json';
 import {migrateNextuiProvider} from '../helpers/actions/migrate/migrate-nextui-provider';
 import {migrateNpmrc} from '../helpers/actions/migrate/migrate-npmrc';
 import {migrateTailwindcss} from '../helpers/actions/migrate/migrate-tailwindcss';
 import {findFiles} from '../helpers/find-files';
-import {getStore, storeParsedContent, storePathsRawContent} from '../helpers/store';
+import {effectedFiles, getStore, storeParsedContent, storePathsRawContent} from '../helpers/store';
 import {transformPaths} from '../helpers/transform';
 import {getCanRunCodemod} from '../helpers/utils';
 
@@ -144,5 +145,20 @@ export async function migrateAction(projectPaths?: string[], options = {} as Mig
     step++;
   }
 
+  /** ======================== 7. Formatting effected files (Optional) ======================== */
+  const runFormatEffectedFiles = effectedFiles.size > 0;
+
+  if (runFormatEffectedFiles) {
+    p.log.step(`${step}. Formatting effected files (Optional)`);
+    const selectMigrateNpmrc = await confirmClack({
+      message: `Do you want to format effected files? (${effectedFiles.size})`
+    });
+
+    if (selectMigrateNpmrc) {
+      await lintEffectedFiles();
+    }
+    step++;
+  }
+
   p.outro(chalk.green('✅ Migration completed!'));
 }
diff --git a/packages/codemod/src/helpers/actions/lint-effected-files.ts b/packages/codemod/src/helpers/actions/lint-effected-files.ts
@@ -0,0 +1,10 @@
+import {tryLintFile} from '../lint';
+import {effectedFiles} from '../store';
+
+export async function lintEffectedFiles() {
+  try {
+    await tryLintFile(Array.from(effectedFiles));
+  } catch (error) {
+    return;
+  }
+}
diff --git a/packages/codemod/src/helpers/actions/migrate/migrate-css-variables.ts b/packages/codemod/src/helpers/actions/migrate/migrate-css-variables.ts
@@ -1,5 +1,5 @@
 import {HEROUI_CSS_VARIABLES_PREFIX, NEXTUI_CSS_VARIABLES_PREFIX} from '../../../constants/prefix';
-import {getStore, writeFileAndUpdateStore} from '../../store';
+import {getStore, updateEffectedFiles, writeFileAndUpdateStore} from '../../store';
 
 export function migrateCssVariables(files: string[]) {
   for (const file of files) {
@@ -13,6 +13,7 @@ export function migrateCssVariables(files: string[]) {
       );
 
       writeFileAndUpdateStore(file, 'rawContent', content);
+      updateEffectedFiles(file);
     }
   }
 }
diff --git a/packages/codemod/src/helpers/actions/migrate/migrate-import.ts b/packages/codemod/src/helpers/actions/migrate/migrate-import.ts
@@ -1,7 +1,12 @@
 import jscodeshift from 'jscodeshift';
 
 import {HEROUI_PREFIX, NEXTUI_PREFIX} from '../../../constants/prefix';
-import {type StoreObject, getStore, writeFileAndUpdateStore} from '../../store';
+import {
+  type StoreObject,
+  getStore,
+  updateEffectedFiles,
+  writeFileAndUpdateStore
+} from '../../store';
 
 /**
  * Migrate the import package will directly write the file
@@ -24,6 +29,7 @@ export function migrateImportPackageWithPaths(paths: string[]) {
       if (dirtyFlag) {
         // Write the modified content back to the file
         writeFileAndUpdateStore(path, 'parsedContent', parsedContent);
+        updateEffectedFiles(path);
       }
       // eslint-disable-next-line no-empty
     } catch {}

diff --git a/packages/codemod/src/helpers/actions/migrate/migrate-json.ts b/packages/codemod/src/helpers/actions/migrate/migrate-json.ts
@@ -5,7 +5,7 @@ import {Logger} from '@helpers/logger';
 import {HEROUI_PREFIX, NEXTUI_PREFIX} from '../../../constants/prefix';
 import {fetchPackageLatestVersion} from '../../https';
 import {safeParseJson} from '../../parse';
-import {getStore, writeFileAndUpdateStore} from '../../store';
+import {getStore, updateEffectedFiles, writeFileAndUpdateStore} from '../../store';
 
 const DEFAULT_INDENT = 2;
 
@@ -51,6 +51,7 @@ export async function migrateJson(files: string[]) {
           const indent = detectIndent(content);
 
           writeFileAndUpdateStore(file, 'rawContent', JSON.stringify(json, null, indent));
+          updateEffectedFiles(file);
         }
       })
     );

diff --git a/packages/codemod/src/helpers/actions/migrate/migrate-nextui-provider.ts b/packages/codemod/src/helpers/actions/migrate/migrate-nextui-provider.ts
@@ -1,5 +1,5 @@
 import {HEROUI_PROVIDER, NEXTUI_PROVIDER} from '../../../constants/prefix';
-import {getStore, writeFileAndUpdateStore} from '../../store';
+import {getStore, updateEffectedFiles, writeFileAndUpdateStore} from '../../store';
 
 import {migrateImportName, migrateJSXElementName} from './migrate-common';
 
@@ -28,6 +28,7 @@ export function migrateNextuiProvider(paths: string[]) {
 
         // Write the modified content back to the file
         writeFileAndUpdateStore(path, 'parsedContent', parsedContent);
+        updateEffectedFiles(path);
       }
       // eslint-disable-next-line no-empty
     } catch {}

diff --git a/packages/codemod/src/helpers/actions/migrate/migrate-tailwindcss.ts b/packages/codemod/src/helpers/actions/migrate/migrate-tailwindcss.ts
@@ -8,7 +8,7 @@ import {
   NEXTUI_PLUGIN,
   NEXTUI_PREFIX
 } from '../../../constants/prefix';
-import {getStore, writeFileAndUpdateStore} from '../../store';
+import {getStore, updateEffectedFiles, writeFileAndUpdateStore} from '../../store';
 
 import {migrateCallExpressionName, migrateImportName} from './migrate-common';
 import {migrateImportPackage} from './migrate-import';
@@ -56,6 +56,7 @@ export function migrateTailwindcss(paths: string[]) {
 
     if (dirtyFlag) {
       writeFileAndUpdateStore(path, 'parsedContent', parsedContent);
+      updateEffectedFiles(path);
     }
   }
 }
diff --git a/packages/codemod/src/helpers/lint.ts b/packages/codemod/src/helpers/lint.ts
@@ -0,0 +1,44 @@
+import {getStore, writeFileAndUpdateStore} from './store';
+
+async function tryImportPackage(packageName: string) {
+  try {
+    return await import(packageName);
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Try linting a file with ESLint/Prettier
+ * First try ESLint, if it fails, try Prettier.
+ */
+export async function tryLintFile(filePaths: string[]) {
+  const eslintPkg = await tryImportPackage('eslint');
+
+  if (eslintPkg) {
+    const ESLint = eslintPkg.ESLint;
+    const eslint = new ESLint({
+      fix: true
+    });
+    const result = await eslint.lintFiles(filePaths);
+
+    await ESLint.outputFixes(result);
+  } else {
+    const prettier = await tryImportPackage('prettier');
+    const options = await prettier.resolveConfig(process.cwd());
+
+    if (prettier) {
+      await Promise.all(
+        filePaths.map(async (filePath) => {
+          const rawContent = getStore(filePath, 'rawContent');
+          const formattedContent = await prettier.format(rawContent, {
+            options,
+            parser: 'typescript'
+          });
+
+          writeFileAndUpdateStore(filePath, 'rawContent', formattedContent);
+        })
+      );
+    }
+  }
+}
diff --git a/packages/codemod/src/helpers/store.ts b/packages/codemod/src/helpers/store.ts
@@ -100,3 +100,9 @@ export function writeFileAndUpdateStore<K extends ExcludeStoreKey>(
   updateStore(path, key, value);
   key === 'parsedContent' && updateStore(path, 'rawContent', data.rawContent);
 }
+
+export const effectedFiles = new Set<string>();
+
+export function updateEffectedFiles(path: string) {
+  effectedFiles.add(path);
+}