@kamaalio/codemod-kit 0.0.26 → 0.0.28

package/dist/codemods/types.d.ts

@@ -1,11 +1,21 @@
 import type { Edit, Rule, SgNode, SgRoot } from '@ast-grep/napi';
 import type { NapiLang } from '@ast-grep/napi/types/lang.js';
 import type { Kinds, TypesMap } from '@ast-grep/napi/types/staticTypes.js';
-import type { Optional } from '../utils/type-utils.js';
+import type { types } from '@kamaalio/kamaal';
+export type RunCodemodOkResult = {
+    hasChanges: boolean;
+    content: string;
+    fullPath: string;
+    root: string;
+};
 export type Codemod = {
     name: string;
     languages: Set<NapiLang> | Array<NapiLang>;
-    transformer: (content: string, filename?: Optional<string>) => Promise<string>;
+    transformer: (content: string, filename?: types.Optional<string>) => Promise<string>;
+    postTransform?: (rootPath: {
+        root: string;
+        results: Array<RunCodemodOkResult>;
+    }) => Promise<void>;
 };
 export type ModificationsReport = {
     changesApplied: number;
@@ -14,10 +24,10 @@ export type Modifications = {
     ast: SgRoot<TypesMap>;
     report: ModificationsReport;
     lang: NapiLang;
-    filename: Optional<string>;
+    filename: types.Optional<string>;
     history: Array<SgRoot<TypesMap>>;
 };
 export type FindAndReplaceConfig = {
     rule: Rule<TypesMap>;
-    transformer: ((node: SgNode<TypesMap, Kinds<TypesMap>>, rule: Rule<TypesMap>) => Optional<Edit | string> | Array<Edit | string>) | string;
+    transformer: ((node: SgNode<TypesMap, Kinds<TypesMap>>, rule: Rule<TypesMap>) => types.Optional<Edit | string> | Array<Edit | string>) | string;
 };

package/dist/codemods/utils.d.ts

@@ -3,7 +3,7 @@ import { type Edit, type SgRoot, type SgNode } from '@ast-grep/napi';
 import type { Kinds, TypesMap } from '@ast-grep/napi/types/staticTypes.js';
 import type { NapiLang } from '@ast-grep/napi/types/lang.js';
 import { type types } from '@kamaalio/kamaal';
-import type { Codemod, FindAndReplaceConfig, Modifications } from './types.js';
+import type { Codemod, FindAndReplaceConfig, Modifications, RunCodemodOkResult } from './types.js';
 type RunCodemodHooks<C extends Codemod> = {
     targetFiltering?: (filepath: string, codemod: C) => boolean;
     preCodemodRun?: (codemod: C) => Promise<void>;
@@ -13,15 +13,11 @@ type RunCodemodOptions<C extends Codemod> = {
     hooks?: RunCodemodHooks<C>;
     log?: boolean;
     dry?: boolean;
+    rootPaths?: Array<string>;
 };
-export declare function runCodemods<C extends Codemod>(codemods: Array<C>, transformationPath: string, options?: RunCodemodOptions<C>): Promise<Record<string, Array<Result<{
-    hasChanges: boolean;
-    content: string;
-}, Error>>>>;
-export declare function runCodemod<C extends Codemod>(codemod: C, transformationPath: string, options?: RunCodemodOptions<C>): Promise<Array<Result<{
-    hasChanges: boolean;
-    content: string;
-}, Error>>>;
+type RunCodemodResult = Result<RunCodemodOkResult, Error>;
+export declare function runCodemods<C extends Codemod>(codemods: Array<C>, transformationPath: string, options?: RunCodemodOptions<C>): Promise<Record<string, Array<RunCodemodResult>>>;
+export declare function runCodemod<C extends Codemod>(codemod: C, transformationPath: string, options?: RunCodemodOptions<C>): Promise<Array<RunCodemodResult>>;
 export declare function traverseUp(node: SgNode<TypesMap, Kinds<TypesMap>>, until: (node: SgNode<TypesMap, Kinds<TypesMap>>) => boolean): types.Optional<SgNode<TypesMap, Kinds<TypesMap>>>;
 export declare function findAndReplaceConfigModifications(modifications: Modifications, config: Array<FindAndReplaceConfig>): Promise<Modifications>;
 export declare function findAndReplaceConfig(content: SgRoot<TypesMap>, lang: NapiLang, config: Array<FindAndReplaceConfig>): Promise<string>;

package/dist/index.cjs

@@ -83,13 +83,26 @@ function getCollectionCount(collection) {
 function collectionIsEmpty(collection) {
     return 0 === getCollectionCount(collection);
 }
+function groupBy(array, key) {
+    const arrayCopy = [
+        ...array
+    ];
+    return arrayCopy.reduce((acc, current)=>{
+        const keyValue = String(current[key]);
+        if (null == acc[keyValue]) acc[keyValue] = [
+            current
+        ];
+        else acc[keyValue].push(current);
+        return acc;
+    }, {});
+}
 async function runCodemods(codemods, transformationPath, options) {
     const results = {};
     for (const codemod of codemods)results[codemod.name] = await runCodemod(codemod, transformationPath, options);
     return results;
 }
 async function runCodemod(codemod, transformationPath, options) {
-    const { hooks, log: enableLogging, dry: runInDryMode } = defaultedOptions(options);
+    const { hooks, log: enableLogging, dry: runInDryMode, rootPaths } = defaultedOptions(options);
     await hooks.preCodemodRun(codemod);
     const globItems = await external_fast_glob_default().glob([
         '**/*'
@@ -107,7 +120,7 @@ async function runCodemod(codemod, transformationPath, options) {
     });
     if (0 === targets.length) return [];
     if (enableLogging) console.log(`\u{1F9C9} '${codemod.name}' targeting ${targets.length} ${1 === targets.length ? 'file' : 'files'} to transform, chill and grab some mat\xe9`);
-    return Promise.all(targets.map(async (filepath)=>{
+    const results = await Promise.all(targets.map(async (filepath)=>{
         const fullPath = external_node_path_default().join(transformationPath, filepath);
         try {
             const content = await promises_default().readFile(fullPath, {
@@ -124,13 +137,26 @@ async function runCodemod(codemod, transformationPath, options) {
             }
             return (0, external_neverthrow_namespaceObject.ok)({
                 hasChanges,
-                content: modifiedContent
+                content: modifiedContent,
+                fullPath,
+                root: filepath.split('/')[0]
             });
         } catch (error) {
             if (enableLogging) console.error(`\u{274C} '${codemod.name}' failed to parse file`, filepath, error);
             return (0, external_neverthrow_namespaceObject.err)(error);
         }
     }));
+    const successes = kamaal_namespaceObject.arrays.compactMap(results, (result)=>{
+        if (result.isErr()) return null;
+        return result.value;
+    });
+    const successesGroupedByRoot = groupBy(successes, 'root');
+    const rootPathsWithResults = rootPaths.map((root)=>({
+            root,
+            results: successesGroupedByRoot[root] ?? []
+        }));
+    await Promise.all(rootPathsWithResults.map((r)=>(codemod.postTransform ?? (async ()=>{}))(r)));
+    return results;
 }
 function traverseUp(node, until) {
     let current = node.parent();
@@ -262,7 +288,8 @@ function defaultedOptions(options) {
     return {
         hooks: defaultedHooks(options?.hooks),
         log: options?.log ?? true,
-        dry: options?.dry ?? false
+        dry: options?.dry ?? false,
+        rootPaths: options?.rootPaths ?? []
     };
 }
 function defaultedHooks(hooks) {

package/dist/index.js

@@ -36,13 +36,26 @@ function getCollectionCount(collection) {
 function collectionIsEmpty(collection) {
     return 0 === getCollectionCount(collection);
 }
+function groupBy(array, key) {
+    const arrayCopy = [
+        ...array
+    ];
+    return arrayCopy.reduce((acc, current)=>{
+        const keyValue = String(current[key]);
+        if (null == acc[keyValue]) acc[keyValue] = [
+            current
+        ];
+        else acc[keyValue].push(current);
+        return acc;
+    }, {});
+}
 async function runCodemods(codemods, transformationPath, options) {
     const results = {};
     for (const codemod of codemods)results[codemod.name] = await runCodemod(codemod, transformationPath, options);
     return results;
 }
 async function runCodemod(codemod, transformationPath, options) {
-    const { hooks, log: enableLogging, dry: runInDryMode } = defaultedOptions(options);
+    const { hooks, log: enableLogging, dry: runInDryMode, rootPaths } = defaultedOptions(options);
     await hooks.preCodemodRun(codemod);
     const globItems = await fast_glob.glob([
         '**/*'
@@ -60,7 +73,7 @@ async function runCodemod(codemod, transformationPath, options) {
     });
     if (0 === targets.length) return [];
     if (enableLogging) console.log(`\u{1F9C9} '${codemod.name}' targeting ${targets.length} ${1 === targets.length ? 'file' : 'files'} to transform, chill and grab some mat\xe9`);
-    return Promise.all(targets.map(async (filepath)=>{
+    const results = await Promise.all(targets.map(async (filepath)=>{
         const fullPath = node_path.join(transformationPath, filepath);
         try {
             const content = await promises.readFile(fullPath, {
@@ -77,13 +90,26 @@ async function runCodemod(codemod, transformationPath, options) {
             }
             return ok({
                 hasChanges,
-                content: modifiedContent
+                content: modifiedContent,
+                fullPath,
+                root: filepath.split('/')[0]
             });
         } catch (error) {
             if (enableLogging) console.error(`\u{274C} '${codemod.name}' failed to parse file`, filepath, error);
             return err(error);
         }
     }));
+    const successes = arrays.compactMap(results, (result)=>{
+        if (result.isErr()) return null;
+        return result.value;
+    });
+    const successesGroupedByRoot = groupBy(successes, 'root');
+    const rootPathsWithResults = rootPaths.map((root)=>({
+            root,
+            results: successesGroupedByRoot[root] ?? []
+        }));
+    await Promise.all(rootPathsWithResults.map((r)=>(codemod.postTransform ?? (async ()=>{}))(r)));
+    return results;
 }
 function traverseUp(node, until) {
     let current = node.parent();
@@ -215,7 +241,8 @@ function defaultedOptions(options) {
     return {
         hooks: defaultedHooks(options?.hooks),
         log: options?.log ?? true,
-        dry: options?.dry ?? false
+        dry: options?.dry ?? false,
+        rootPaths: options?.rootPaths ?? []
     };
 }
 function defaultedHooks(hooks) {

package/dist/utils/arrays.d.ts

@@ -0,0 +1 @@
+export declare function groupBy<T, K extends keyof T>(array: Array<T>, key: K): Record<string, Array<T>>;

package/dist/utils/type-utils.d.ts

@@ -1,4 +1,3 @@
-export type Optional<T> = T | undefined | null;
 export type ReplaceObjectProperty<A extends Record<string, unknown>, K extends keyof A, B> = Omit<A, K> & {
     [P in K]: B;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kamaalio/codemod-kit",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "type": "module",
   "author": "Kamaal Farah",
   "license": "MIT",