@kamaalio/codemod-kit 0.0.14 → 0.0.16

package/README.md

@@ -44,6 +44,65 @@ Runs a single codemod.
 - `globItems`: An array of file paths to transform.
 - `options`: Optional configuration for the run.
 
+### `findAndReplace(content, rule, transformer)`
+
+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.
+
+Returns the transformed content as a string with all matching nodes replaced.
+
+```typescript
+import { findAndReplace } from '@kamaalio/codemod-kit';
+import { parseAsync } from '@ast-grep/napi';
+
+const code = `
+function oldFunction() {
+  return "hello";
+}
+`;
+
+const ast = await parseAsync('javascript', code);
+const result = findAndReplace(
+  ast,
+  { pattern: 'function oldFunction() { $$$ }' },
+  node => 'function newFunction() { return "hello world"; }',
+);
+```
+
+### `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);
+```
+
 ### `Codemod`
 
 A codemod is defined by the `Codemod` type:

package/dist/codemods/index.d.ts

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

package/dist/codemods/utils.d.ts

@@ -1,6 +1,8 @@
 import { type Result } from 'neverthrow';
-import { type Edit } from '@ast-grep/napi';
+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 { Codemod, Modifications } from './types.js';
+import type { Optional } from '../utils/type-utils.js';
 type RunCodemodHooks<C extends Codemod> = {
     targetFiltering?: (filepath: string, codemod: C) => boolean;
     preCodemodRun?: (codemod: C) => Promise<void>;
@@ -19,5 +21,7 @@ export declare function runCodemod<C extends Codemod>(codemod: C, transformation
     hasChanges: boolean;
     content: string;
 }, Error>>>;
+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

@@ -35,6 +35,8 @@ __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
     commitEditModifications: ()=>commitEditModifications,
     runCodemod: ()=>runCodemod,
+    findAndReplace: ()=>findAndReplace,
+    findAndReplaceEdits: ()=>findAndReplaceEdits,
     runCodemods: ()=>runCodemods
 });
 const external_node_path_namespaceObject = require("node:path");
@@ -45,6 +47,7 @@ const external_fast_glob_namespaceObject = require("fast-glob");
 var external_fast_glob_default = /*#__PURE__*/ __webpack_require__.n(external_fast_glob_namespaceObject);
 const external_neverthrow_namespaceObject = require("neverthrow");
 const napi_namespaceObject = require("@ast-grep/napi");
+const kamaal_namespaceObject = require("@kamaalio/kamaal");
 const JAVASCRIPT_EXTENSIONS = [
     '.js',
     '.cjs',
@@ -126,6 +129,21 @@ async function runCodemod(codemod, transformationPath, options) {
         }
     }));
 }
+function findAndReplaceEdits(content, rule, transformer) {
+    const nodes = content.root().findAll({
+        rule
+    });
+    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) {
     if (0 === edits.length) return modifications;
     const root = modifications.ast.root();
@@ -160,10 +178,14 @@ function defaultedHooks(hooks) {
     };
 }
 exports.commitEditModifications = __webpack_exports__.commitEditModifications;
+exports.findAndReplace = __webpack_exports__.findAndReplace;
+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",
+    "findAndReplaceEdits",
     "runCodemod",
     "runCodemods"
 ].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];

package/dist/index.d.ts

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

package/dist/index.js

@@ -3,6 +3,7 @@ import promises from "node:fs/promises";
 import fast_glob from "fast-glob";
 import { err, ok } from "neverthrow";
 import { Lang, parseAsync } from "@ast-grep/napi";
+import { arrays } from "@kamaalio/kamaal";
 const JAVASCRIPT_EXTENSIONS = [
     '.js',
     '.cjs',
@@ -84,6 +85,21 @@ async function runCodemod(codemod, transformationPath, options) {
         }
     }));
 }
+function findAndReplaceEdits(content, rule, transformer) {
+    const nodes = content.root().findAll({
+        rule
+    });
+    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) {
     if (0 === edits.length) return modifications;
     const root = modifications.ast.root();
@@ -117,4 +133,4 @@ function defaultedHooks(hooks) {
         preCodemodRun
     };
 }
-export { commitEditModifications, runCodemod, runCodemods };
+export { commitEditModifications, findAndReplace, findAndReplaceEdits, runCodemod, runCodemods };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kamaalio/codemod-kit",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "type": "module",
   "author": "Kamaal Farah",
   "license": "MIT",
@@ -20,6 +20,7 @@
   ],
   "dependencies": {
     "@ast-grep/napi": "^0.38.5",
+    "@kamaalio/kamaal": "^0.7.6",
     "fast-glob": "^3.3.3",
     "neverthrow": "^8.2.0"
   },