@kamaalio/codemod-kit 0.0.17 → 0.0.19

package/README.md

@@ -50,7 +50,7 @@ A utility function for finding and replacing AST nodes based on a rule.
 
 - `content`: An `SgRoot<TypesMap>` object representing the parsed AST.
 - `rule`: A `Rule<TypesMap>` object defining the pattern to search for.
-- `transformer`: A function that takes a matched node and returns an optional string replacement.
+- `transformer`: A function that takes a matched node and returns an optional string replacement, or a string for direct replacement.
 
 Returns the transformed content as a string with all matching nodes replaced.
 
@@ -65,11 +65,20 @@ function oldFunction() {
 `;
 
 const ast = await parseAsync('javascript', code);
-const result = findAndReplace(
+
+// Using a function transformer
+const result1 = findAndReplace(
   ast,
   { pattern: 'function oldFunction() { $$$ }' },
   node => 'function newFunction() { return "hello world"; }',
 );
+
+// Using a string transformer
+const result2 = findAndReplace(
+  ast,
+  { pattern: 'function oldFunction() { $$$ }' },
+  'function newFunction() { return "hello world"; }',
+);
 ```
 
 ### `findAndReplaceEdits(content, rule, transformer)`
@@ -78,7 +87,7 @@ A utility function for finding AST nodes and generating edit operations without
 
 - `content`: An `SgRoot<TypesMap>` object representing the parsed AST.
 - `rule`: A `Rule<TypesMap>` object defining the pattern to search for.
-- `transformer`: A function that takes a matched node and returns an optional string replacement.
+- `transformer`: A function that takes a matched node and returns an optional string replacement, or a string for direct replacement.
 
 Returns an array of `Edit` objects that can be committed later using `commitEdits()`.
 
@@ -93,14 +102,23 @@ function oldFunction() {
 `;
 
 const ast = await parseAsync('javascript', code);
-const edits = findAndReplaceEdits(
+
+// Using a function transformer
+const edits1 = findAndReplaceEdits(
   ast,
   { pattern: 'function oldFunction() { $$$ }' },
   node => 'function newFunction() { return "hello world"; }',
 );
 
+// Using a string transformer
+const edits2 = findAndReplaceEdits(
+  ast,
+  { pattern: 'function oldFunction() { $$$ }' },
+  'function newFunction() { return "hello world"; }',
+);
+
 // Commit the edits later
-const result = ast.root().commitEdits(edits);
+const result = ast.root().commitEdits(edits1);
 ```
 
 ### `findAndReplaceConfig(content, lang, config)`
@@ -109,7 +127,7 @@ A utility function for applying multiple find-and-replace operations sequentiall
 
 - `content`: An `SgRoot<TypesMap>` object representing the parsed AST.
 - `lang`: A `NapiLang` value specifying the language for re-parsing after each transformation.
-- `config`: An array of objects containing `rule` and `transformer` pairs to apply sequentially.
+- `config`: An array of objects containing `rule` and `transformer` pairs to apply sequentially. The `transformer` can be either a function or a string.
 
 Returns the final transformed content as a string after applying all transformations.
 
@@ -132,41 +150,54 @@ const result = await findAndReplaceConfig(ast, 'javascript', [
   },
   {
     rule: { pattern: 'const value = $VAL' },
-    transformer: node => 'const value = 100',
+    transformer: 'const value = 100', // String transformer
   },
 ]);
 ```
 
-### `findAndReplaceConfigEdits(content, lang, config)`
+### `findAndReplaceConfigModifications(modifications, config)`
 
-A utility function for applying multiple find-and-replace operations sequentially and returning the edit history.
+A utility function for applying multiple find-and-replace operations sequentially on a `Modifications` object.
 
-- `content`: An `SgRoot<TypesMap>` object representing the parsed AST.
-- `lang`: A `NapiLang` value specifying the language for re-parsing after each transformation.
-- `config`: An array of objects containing `rule` and `transformer` pairs to apply sequentially.
+- `modifications`: A `Modifications` object containing the AST, language, and transformation history.
+- `config`: An array of objects containing `rule` and `transformer` pairs to apply sequentially. The `transformer` can be either a function or a string.
 
-Returns an array of objects containing the AST content and edits for each transformation step.
+Returns a `Promise<Modifications>` with the updated AST, accumulated edit count, and transformation history.
 
 ```typescript
-import { findAndReplaceConfigEdits } from '@kamaalio/codemod-kit';
+import { findAndReplaceConfigModifications } from '@kamaalio/codemod-kit';
 import { parseAsync } from '@ast-grep/napi';
 
 const code = `
 function oldFunction() {
   return "hello";
 }
+const value = 42;
 `;
 
 const ast = await parseAsync('javascript', code);
-const editsHistory = await findAndReplaceConfigEdits(ast, 'javascript', [
+const initialModifications = {
+  ast,
+  lang: 'javascript' as const,
+  filename: 'example.js',
+  report: { changesApplied: 0 },
+  history: [ast],
+};
+
+const result = await findAndReplaceConfigModifications(initialModifications, [
   {
     rule: { pattern: 'function oldFunction() { $$$ }' },
     transformer: node => 'function newFunction() { return "hello world"; }',
   },
+  {
+    rule: { pattern: 'const value = $VAL' },
+    transformer: 'const value = 100', // String transformer
+  },
 ]);
 
-// Each element contains { content: SgRoot, edits: Edit[] }
-// Useful for tracking transformation history or debugging
+// result.ast contains the final transformed AST
+// result.report.changesApplied contains the total number of edits applied
+// result.history contains the transformation history
 ```
 
 ### `Codemod`

package/dist/codemods/index.d.ts

@@ -1,2 +1,2 @@
-export { runCodemods, runCodemod, commitEditModifications, findAndReplace, findAndReplaceEdits, findAndReplaceConfig, findAndReplaceConfigEdits, } from './utils.js';
+export { runCodemods, runCodemod, commitEditModifications, findAndReplace, findAndReplaceEdits, findAndReplaceConfig, findAndReplaceConfigModifications, } from './utils.js';
 export type { Codemod, Modifications } from './types.js';

package/dist/codemods/utils.d.ts

@@ -14,6 +14,10 @@ type RunCodemodOptions<C extends Codemod> = {
     log?: boolean;
     dry?: boolean;
 };
+type FindAndReplaceConfig = {
+    rule: Rule<TypesMap>;
+    transformer: ((node: SgNode<TypesMap, Kinds<TypesMap>>) => Optional<string>) | 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;
@@ -22,18 +26,9 @@ export declare function runCodemod<C extends Codemod>(codemod: C, transformation
     hasChanges: boolean;
     content: string;
 }, Error>>>;
-export declare function findAndReplaceConfigEdits(content: SgRoot<TypesMap>, lang: NapiLang, config: Array<{
-    rule: Rule<TypesMap>;
-    transformer: (node: SgNode<TypesMap, Kinds<TypesMap>>) => Optional<string>;
-}>): Promise<Array<{
-    content: SgRoot<TypesMap>;
-    edits: Array<Edit>;
-}>>;
-export declare function findAndReplaceConfig(content: SgRoot<TypesMap>, lang: NapiLang, config: Array<{
-    rule: Rule<TypesMap>;
-    transformer: (node: SgNode<TypesMap, Kinds<TypesMap>>) => Optional<string>;
-}>): Promise<string>;
-export declare function findAndReplaceEdits(content: SgRoot<TypesMap>, rule: Rule<TypesMap>, transformer: (node: SgNode<TypesMap, Kinds<TypesMap>>) => Optional<string>): Array<Edit>;
-export declare function findAndReplace(content: SgRoot<TypesMap>, rule: Rule<TypesMap>, transformer: (node: SgNode<TypesMap, Kinds<TypesMap>>) => Optional<string>): string;
+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>;
+export declare function findAndReplaceEdits(content: SgRoot<TypesMap>, rule: FindAndReplaceConfig['rule'], transformer: FindAndReplaceConfig['transformer']): Array<Edit>;
+export declare function findAndReplace(content: SgRoot<TypesMap>, rule: FindAndReplaceConfig['rule'], transformer: FindAndReplaceConfig['transformer']): string;
 export declare function commitEditModifications(edits: Array<Edit>, modifications: Modifications): Promise<Modifications>;
 export {};

package/dist/index.cjs

@@ -34,11 +34,11 @@ var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
     commitEditModifications: ()=>commitEditModifications,
-    findAndReplaceConfigEdits: ()=>findAndReplaceConfigEdits,
+    runCodemods: ()=>runCodemods,
     runCodemod: ()=>runCodemod,
     findAndReplace: ()=>findAndReplace,
+    findAndReplaceConfigModifications: ()=>findAndReplaceConfigModifications,
     findAndReplaceEdits: ()=>findAndReplaceEdits,
-    runCodemods: ()=>runCodemods,
     findAndReplaceConfig: ()=>findAndReplaceConfig
 });
 const external_node_path_namespaceObject = require("node:path");
@@ -131,6 +131,16 @@ async function runCodemod(codemod, transformationPath, options) {
         }
     }));
 }
+async function findAndReplaceConfigModifications(modifications, config) {
+    let currentModifications = {
+        ...modifications
+    };
+    for (const { rule, transformer } of config){
+        const edits = findAndReplaceEdits(currentModifications.ast, rule, transformer);
+        currentModifications = await commitEditModifications(edits, currentModifications);
+    }
+    return currentModifications;
+}
 async function findAndReplaceConfigEdits(content, lang, config) {
     let currentContent = content;
     const editsAndContent = [];
@@ -154,8 +164,9 @@ function findAndReplaceEdits(content, rule, transformer) {
         rule
     });
     return kamaal_namespaceObject.arrays.compactMap(nodes, (node)=>{
-        const transformed = transformer(node);
+        const transformed = 'string' == typeof transformer ? transformer : transformer(node);
         if (null == transformed) return null;
+        if (transformed === node.text()) return null;
         return node.replace(transformed);
     });
 }
@@ -200,7 +211,7 @@ function defaultedHooks(hooks) {
 exports.commitEditModifications = __webpack_exports__.commitEditModifications;
 exports.findAndReplace = __webpack_exports__.findAndReplace;
 exports.findAndReplaceConfig = __webpack_exports__.findAndReplaceConfig;
-exports.findAndReplaceConfigEdits = __webpack_exports__.findAndReplaceConfigEdits;
+exports.findAndReplaceConfigModifications = __webpack_exports__.findAndReplaceConfigModifications;
 exports.findAndReplaceEdits = __webpack_exports__.findAndReplaceEdits;
 exports.runCodemod = __webpack_exports__.runCodemod;
 exports.runCodemods = __webpack_exports__.runCodemods;
@@ -208,7 +219,7 @@ for(var __webpack_i__ in __webpack_exports__)if (-1 === [
     "commitEditModifications",
     "findAndReplace",
     "findAndReplaceConfig",
-    "findAndReplaceConfigEdits",
+    "findAndReplaceConfigModifications",
     "findAndReplaceEdits",
     "runCodemod",
     "runCodemods"

package/dist/index.d.ts

@@ -1 +1 @@
-export { runCodemods, runCodemod, commitEditModifications, findAndReplace, findAndReplaceEdits, findAndReplaceConfig, findAndReplaceConfigEdits, type Codemod, type Modifications, } from './codemods/index.js';
+export { runCodemods, runCodemod, commitEditModifications, findAndReplace, findAndReplaceEdits, findAndReplaceConfig, findAndReplaceConfigModifications, type Codemod, type Modifications, } from './codemods/index.js';

package/dist/index.js

@@ -85,6 +85,16 @@ async function runCodemod(codemod, transformationPath, options) {
         }
     }));
 }
+async function findAndReplaceConfigModifications(modifications, config) {
+    let currentModifications = {
+        ...modifications
+    };
+    for (const { rule, transformer } of config){
+        const edits = findAndReplaceEdits(currentModifications.ast, rule, transformer);
+        currentModifications = await commitEditModifications(edits, currentModifications);
+    }
+    return currentModifications;
+}
 async function findAndReplaceConfigEdits(content, lang, config) {
     let currentContent = content;
     const editsAndContent = [];
@@ -108,8 +118,9 @@ function findAndReplaceEdits(content, rule, transformer) {
         rule
     });
     return arrays.compactMap(nodes, (node)=>{
-        const transformed = transformer(node);
+        const transformed = 'string' == typeof transformer ? transformer : transformer(node);
         if (null == transformed) return null;
+        if (transformed === node.text()) return null;
         return node.replace(transformed);
     });
 }
@@ -151,4 +162,4 @@ function defaultedHooks(hooks) {
         preCodemodRun
     };
 }
-export { commitEditModifications, findAndReplace, findAndReplaceConfig, findAndReplaceConfigEdits, findAndReplaceEdits, runCodemod, runCodemods };
+export { commitEditModifications, findAndReplace, findAndReplaceConfig, findAndReplaceConfigModifications, findAndReplaceEdits, runCodemod, runCodemods };

package/package.json

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