@kamaalio/codemod-kit 0.0.18 → 0.0.20

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,7 +150,7 @@ const result = await findAndReplaceConfig(ast, 'javascript', [
   },
   {
     rule: { pattern: 'const value = $VAL' },
-    transformer: node => 'const value = 100',
+    transformer: 'const value = 100', // String transformer
   },
 ]);
 ```
@@ -142,7 +160,7 @@ const result = await findAndReplaceConfig(ast, 'javascript', [
 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.
+- `config`: An array of objects containing `rule` and `transformer` pairs to apply sequentially. The `transformer` can be either a function or a string.
 
 Returns a `Promise<Modifications>` with the updated AST, accumulated edit count, and transformation history.
 
@@ -173,7 +191,7 @@ const result = await findAndReplaceConfigModifications(initialModifications, [
   },
   {
     rule: { pattern: 'const value = $VAL' },
-    transformer: node => 'const value = 100',
+    transformer: 'const value = 100', // String transformer
   },
 ]);
 

package/dist/codemods/index.d.ts

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

package/dist/codemods/types.d.ts

@@ -1,6 +1,6 @@
-import type { SgRoot } from '@ast-grep/napi';
+import type { Rule, SgNode, SgRoot } from '@ast-grep/napi';
 import type { NapiLang } from '@ast-grep/napi/types/lang.js';
-import type { TypesMap } from '@ast-grep/napi/types/staticTypes.js';
+import type { Kinds, TypesMap } from '@ast-grep/napi/types/staticTypes.js';
 import type { Optional } from '../utils/type-utils.js';
 export type Codemod = {
     name: string;
@@ -17,3 +17,7 @@ export type Modifications = {
     filename: Optional<string>;
     history: Array<SgRoot<TypesMap>>;
 };
+export type FindAndReplaceConfig = {
+    rule: Rule<TypesMap>;
+    transformer: ((node: SgNode<TypesMap, Kinds<TypesMap>>) => Optional<string>) | string;
+};

package/dist/codemods/utils.d.ts

@@ -1,9 +1,8 @@
 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 Edit, type SgRoot } from '@ast-grep/napi';
+import type { 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';
+import type { Codemod, FindAndReplaceConfig, Modifications } from './types.js';
 type RunCodemodHooks<C extends Codemod> = {
     targetFiltering?: (filepath: string, codemod: C) => boolean;
     preCodemodRun?: (codemod: C) => Promise<void>;
@@ -22,15 +21,9 @@ 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 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

@@ -164,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);
     });
 }

package/dist/index.d.ts

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

package/dist/index.js

@@ -118,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);
     });
 }

package/package.json

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