@kamaalio/codemod-kit 0.0.16 → 0.0.18

package/README.md

@@ -103,6 +103,85 @@ const edits = findAndReplaceEdits(
 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',
+  },
+]);
+```
+
+### `findAndReplaceConfigModifications(modifications, config)`
+
+A utility function for applying multiple find-and-replace operations sequentially on a `Modifications` object.
+
+- `modifications`: A `Modifications` object containing the AST, language, and transformation history.
+- `config`: An array of objects containing `rule` and `transformer` pairs to apply sequentially.
+
+Returns a `Promise<Modifications>` with the updated AST, accumulated edit count, and transformation history.
+
+```typescript
+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 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: node => 'const value = 100',
+  },
+]);
+
+// result.ast contains the final transformed AST
+// result.report.changesApplied contains the total number of edits applied
+// result.history contains the transformation history
+```
+
 ### `Codemod`
 
 A codemod is defined by the `Codemod` type:

package/dist/codemods/index.d.ts

@@ -1,2 +1,2 @@
-export { runCodemods, runCodemod, commitEditModifications, findAndReplace, findAndReplaceEdits } 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

@@ -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,14 @@ export declare function runCodemod<C extends Codemod>(codemod: C, transformation
     hasChanges: boolean;
     content: string;
 }, Error>>>;
+export declare function findAndReplaceConfigModifications(modifications: Modifications, config: Array<{
+    rule: Rule<TypesMap>;
+    transformer: (node: SgNode<TypesMap, Kinds<TypesMap>>) => Optional<string>;
+}>): Promise<Modifications>;
+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>;

package/dist/index.cjs

@@ -34,10 +34,12 @@ var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
     commitEditModifications: ()=>commitEditModifications,
+    runCodemods: ()=>runCodemods,
     runCodemod: ()=>runCodemod,
     findAndReplace: ()=>findAndReplace,
+    findAndReplaceConfigModifications: ()=>findAndReplaceConfigModifications,
     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);
@@ -129,6 +131,34 @@ 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 = [];
+    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
@@ -179,12 +209,16 @@ function defaultedHooks(hooks) {
 }
 exports.commitEditModifications = __webpack_exports__.commitEditModifications;
 exports.findAndReplace = __webpack_exports__.findAndReplace;
+exports.findAndReplaceConfig = __webpack_exports__.findAndReplaceConfig;
+exports.findAndReplaceConfigModifications = __webpack_exports__.findAndReplaceConfigModifications;
 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",
+    "findAndReplaceConfigModifications",
     "findAndReplaceEdits",
     "runCodemod",
     "runCodemods"

package/dist/index.d.ts

@@ -1 +1 @@
-export { runCodemods, runCodemod, commitEditModifications, findAndReplace, findAndReplaceEdits, 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,34 @@ 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 = [];
+    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
@@ -133,4 +161,4 @@ function defaultedHooks(hooks) {
         preCodemodRun
     };
 }
-export { commitEditModifications, findAndReplace, 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.16",
+  "version": "0.0.18",
   "type": "module",
   "author": "Kamaal Farah",
   "license": "MIT",