@kamaalio/codemod-kit 0.0.15 → 0.0.17

package/README.md

@@ -72,6 +72,103 @@ const result = findAndReplace(
 );
 ```
 
+### `findAndReplaceEdits(content, rule, transformer)`
+
+A utility function for finding AST nodes and generating edit operations without committing them.
+
+- `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.
+
+Returns an array of `Edit` objects that can be committed later using `commitEdits()`.
+
+```typescript
+import { findAndReplaceEdits } from '@kamaalio/codemod-kit';
+import { parseAsync } from '@ast-grep/napi';
+
+const code = `
+function oldFunction() {
+  return "hello";
+}
+`;
+
+const ast = await parseAsync('javascript', code);
+const edits = findAndReplaceEdits(
+  ast,
+  { pattern: 'function oldFunction() { $$$ }' },
+  node => 'function newFunction() { return "hello world"; }',
+);
+
+// Commit the edits later
+const result = ast.root().commitEdits(edits);
+```
+
+### `findAndReplaceConfig(content, lang, config)`
+
+A utility function for applying multiple find-and-replace operations sequentially on AST content.
+
+- `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.
+
+Returns the final transformed content as a string after applying all transformations.
+
+```typescript
+import { findAndReplaceConfig } 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 result = await findAndReplaceConfig(ast, 'javascript', [
+  {
+    rule: { pattern: 'function oldFunction() { $$$ }' },
+    transformer: node => 'function newFunction() { return "hello world"; }',
+  },
+  {
+    rule: { pattern: 'const value = $VAL' },
+    transformer: node => 'const value = 100',
+  },
+]);
+```
+
+### `findAndReplaceConfigEdits(content, lang, config)`
+
+A utility function for applying multiple find-and-replace operations sequentially and returning the edit history.
+
+- `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.
+
+Returns an array of objects containing the AST content and edits for each transformation step.
+
+```typescript
+import { findAndReplaceConfigEdits } from '@kamaalio/codemod-kit';
+import { parseAsync } from '@ast-grep/napi';
+
+const code = `
+function oldFunction() {
+  return "hello";
+}
+`;
+
+const ast = await parseAsync('javascript', code);
+const editsHistory = await findAndReplaceConfigEdits(ast, 'javascript', [
+  {
+    rule: { pattern: 'function oldFunction() { $$$ }' },
+    transformer: node => 'function newFunction() { return "hello world"; }',
+  },
+]);
+
+// Each element contains { content: SgRoot, edits: Edit[] }
+// Useful for tracking transformation history or debugging
+```
+
 ### `Codemod`
 
 A codemod is defined by the `Codemod` type:

package/dist/codemods/index.d.ts

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

package/dist/codemods/utils.d.ts

@@ -1,6 +1,7 @@
 import { type Result } from 'neverthrow';
 import { type Rule, type Edit, type SgNode, type SgRoot } 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 { Codemod, Modifications } from './types.js';
 import type { Optional } from '../utils/type-utils.js';
 type RunCodemodHooks<C extends Codemod> = {
@@ -21,6 +22,18 @@ 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 commitEditModifications(edits: Array<Edit>, modifications: Modifications): Promise<Modifications>;
 export {};

package/dist/index.cjs

@@ -34,9 +34,12 @@ var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
     commitEditModifications: ()=>commitEditModifications,
+    findAndReplaceConfigEdits: ()=>findAndReplaceConfigEdits,
     runCodemod: ()=>runCodemod,
     findAndReplace: ()=>findAndReplace,
-    runCodemods: ()=>runCodemods
+    findAndReplaceEdits: ()=>findAndReplaceEdits,
+    runCodemods: ()=>runCodemods,
+    findAndReplaceConfig: ()=>findAndReplaceConfig
 });
 const external_node_path_namespaceObject = require("node:path");
 var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
@@ -128,15 +131,37 @@ async function runCodemod(codemod, transformationPath, options) {
         }
     }));
 }
-function findAndReplace(content, rule, transformer) {
-    const root = content.root();
-    const edits = kamaal_namespaceObject.arrays.compactMap(root.findAll({
+async function findAndReplaceConfigEdits(content, lang, config) {
+    let currentContent = content;
+    const editsAndContent = [];
+    for (const { rule, transformer } of config){
+        const edits = findAndReplaceEdits(currentContent, rule, transformer);
+        const updatedContent = currentContent.root().commitEdits(edits);
+        editsAndContent.push({
+            content: currentContent,
+            edits
+        });
+        currentContent = await (0, napi_namespaceObject.parseAsync)(lang, updatedContent);
+    }
+    return editsAndContent;
+}
+async function findAndReplaceConfig(content, lang, config) {
+    const edits = await findAndReplaceConfigEdits(content, lang, config);
+    return edits.at(-1)?.content.root().text() ?? content.root().text();
+}
+function findAndReplaceEdits(content, rule, transformer) {
+    const nodes = content.root().findAll({
         rule
-    }), (node)=>{
+    });
+    return kamaal_namespaceObject.arrays.compactMap(nodes, (node)=>{
         const transformed = transformer(node);
         if (null == transformed) return null;
         return node.replace(transformed);
     });
+}
+function findAndReplace(content, rule, transformer) {
+    const root = content.root();
+    const edits = findAndReplaceEdits(content, rule, transformer);
     return root.commitEdits(edits);
 }
 async function commitEditModifications(edits, modifications) {
@@ -174,11 +199,17 @@ function defaultedHooks(hooks) {
 }
 exports.commitEditModifications = __webpack_exports__.commitEditModifications;
 exports.findAndReplace = __webpack_exports__.findAndReplace;
+exports.findAndReplaceConfig = __webpack_exports__.findAndReplaceConfig;
+exports.findAndReplaceConfigEdits = __webpack_exports__.findAndReplaceConfigEdits;
+exports.findAndReplaceEdits = __webpack_exports__.findAndReplaceEdits;
 exports.runCodemod = __webpack_exports__.runCodemod;
 exports.runCodemods = __webpack_exports__.runCodemods;
 for(var __webpack_i__ in __webpack_exports__)if (-1 === [
     "commitEditModifications",
     "findAndReplace",
+    "findAndReplaceConfig",
+    "findAndReplaceConfigEdits",
+    "findAndReplaceEdits",
     "runCodemod",
     "runCodemods"
 ].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];

package/dist/index.d.ts

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

package/dist/index.js

@@ -85,15 +85,37 @@ async function runCodemod(codemod, transformationPath, options) {
         }
     }));
 }
-function findAndReplace(content, rule, transformer) {
-    const root = content.root();
-    const edits = arrays.compactMap(root.findAll({
+async function findAndReplaceConfigEdits(content, lang, config) {
+    let currentContent = content;
+    const editsAndContent = [];
+    for (const { rule, transformer } of config){
+        const edits = findAndReplaceEdits(currentContent, rule, transformer);
+        const updatedContent = currentContent.root().commitEdits(edits);
+        editsAndContent.push({
+            content: currentContent,
+            edits
+        });
+        currentContent = await parseAsync(lang, updatedContent);
+    }
+    return editsAndContent;
+}
+async function findAndReplaceConfig(content, lang, config) {
+    const edits = await findAndReplaceConfigEdits(content, lang, config);
+    return edits.at(-1)?.content.root().text() ?? content.root().text();
+}
+function findAndReplaceEdits(content, rule, transformer) {
+    const nodes = content.root().findAll({
         rule
-    }), (node)=>{
+    });
+    return arrays.compactMap(nodes, (node)=>{
         const transformed = transformer(node);
         if (null == transformed) return null;
         return node.replace(transformed);
     });
+}
+function findAndReplace(content, rule, transformer) {
+    const root = content.root();
+    const edits = findAndReplaceEdits(content, rule, transformer);
     return root.commitEdits(edits);
 }
 async function commitEditModifications(edits, modifications) {
@@ -129,4 +151,4 @@ function defaultedHooks(hooks) {
         preCodemodRun
     };
 }
-export { commitEditModifications, findAndReplace, runCodemod, runCodemods };
+export { commitEditModifications, findAndReplace, findAndReplaceConfig, findAndReplaceConfigEdits, findAndReplaceEdits, runCodemod, runCodemods };

package/package.json

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