@codegraft/codemod 0.1.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-present Joël Charles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/codemod.d.ts

@@ -0,0 +1,37 @@
+import type { Collection, GrammarId, Transformer, ZoneSplitter } from '@codegraft/core';
+/** A codemod body: receives the file's {@link Collection} and the run context, records edits.
+ *  `G` types the node-type/field vocabulary; annotate `root` (`Collection<'tsx'>`) to narrow it. */
+export type CodemodFn<Ctx extends Record<string, unknown>, G extends GrammarId = GrammarId> = (root: Collection<G>, context: Ctx) => void;
+/** Options for a codemod. */
+export interface CodemodConfig {
+    /**
+     * The build-time global marker the codemod keys off (e.g. `$$`). Enables the source-scan
+     * optimisation — files that never mention it are returned untouched without being parsed.
+     */
+    namespace?: string;
+}
+/**
+ * Authoring handle for a codemod. `forTarget` builds a transformer for one target; `codegraft run`
+ * and `@codegraft/unplugin` call it to apply the codemod live (no build step).
+ *
+ * `G` is the grammar the body was authored against (inferred from a `root: Collection<'tsx'>`
+ * annotation, else every built-in grammar); it ties `forTarget` to a matching bare-grammar target.
+ */
+export declare class Codemod<Ctx extends Record<string, unknown> = Record<string, unknown>, G extends GrammarId = GrammarId> {
+    readonly fn: CodemodFn<Ctx, G>;
+    readonly namespace: string | undefined;
+    constructor(fn: CodemodFn<Ctx, G>, namespace?: string);
+    /** Interpreted mode: build a ready transformer for `target`. A grammar-annotated codemod only
+     *  accepts its own bare grammar; a {@link ZoneSplitter} is always allowed (its grammars aren't
+     *  statically known). */
+    forTarget(target: G | ZoneSplitter): Promise<Transformer<Ctx>>;
+}
+/**
+ * Entry point for authoring a codemod. An optional {@link CodemodConfig} may precede the body.
+ * `Ctx` types the run context threaded into the body (and the resulting transformer's
+ * `transform(src, ctx)`); defaults to an open record. `G` is inferred from the body's `root`
+ * annotation (defaulting to every built-in grammar).
+ */
+export declare function defineCodemod<Ctx extends Record<string, unknown> = Record<string, unknown>, G extends GrammarId = GrammarId>(fn: CodemodFn<Ctx, G>): Codemod<Ctx, G>;
+export declare function defineCodemod<Ctx extends Record<string, unknown> = Record<string, unknown>, G extends GrammarId = GrammarId>(config: CodemodConfig, fn: CodemodFn<Ctx, G>): Codemod<Ctx, G>;
+//# sourceMappingURL=codemod.d.ts.map

package/dist/codemod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codemod.d.ts","sourceRoot":"","sources":["../src/codemod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAGvF;oGACoG;AACpG,MAAM,MAAM,SAAS,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,CAC5F,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,OAAO,EAAE,GAAG,KACT,IAAI,CAAA;AAET,6BAA6B;AAC7B,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;GAMG;AACH,qBAAa,OAAO,CAClB,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7D,CAAC,SAAS,SAAS,GAAG,SAAS;IAE/B,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;IAC9B,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;gBAE1B,EAAE,EAAE,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM;IAKrD;;6BAEyB;IACzB,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;CAG/D;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,SAAS,SAAS,GAAG,SAAS,EAC1H,EAAE,EAAE,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,GACpB,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;AAClB,wBAAgB,aAAa,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,SAAS,SAAS,GAAG,SAAS,EAC1H,MAAM,EAAE,aAAa,EACrB,EAAE,EAAE,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,GACpB,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA"}

package/dist/codemod.js

@@ -0,0 +1,28 @@
+import { createCodemodTransformer } from '@codegraft/core';
+/**
+ * Authoring handle for a codemod. `forTarget` builds a transformer for one target; `codegraft run`
+ * and `@codegraft/unplugin` call it to apply the codemod live (no build step).
+ *
+ * `G` is the grammar the body was authored against (inferred from a `root: Collection<'tsx'>`
+ * annotation, else every built-in grammar); it ties `forTarget` to a matching bare-grammar target.
+ */
+export class Codemod {
+    fn;
+    namespace;
+    constructor(fn, namespace) {
+        this.fn = fn;
+        this.namespace = namespace;
+    }
+    /** Interpreted mode: build a ready transformer for `target`. A grammar-annotated codemod only
+     *  accepts its own bare grammar; a {@link ZoneSplitter} is always allowed (its grammars aren't
+     *  statically known). */
+    forTarget(target) {
+        return createCodemodTransformer(target, this.fn, { namespace: this.namespace }).init();
+    }
+}
+export function defineCodemod(configOrFn, maybeFn) {
+    const fn = maybeFn ?? configOrFn;
+    const namespace = maybeFn ? configOrFn.namespace : undefined;
+    return new Codemod(fn, namespace);
+}
+//# sourceMappingURL=codemod.js.map

package/dist/codemod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codemod.js","sourceRoot":"","sources":["../src/codemod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAkB1D;;;;;;GAMG;AACH,MAAM,OAAO,OAAO;IAIT,EAAE,CAAmB;IACrB,SAAS,CAAoB;IAEtC,YAAY,EAAqB,EAAE,SAAkB;QACnD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;QACZ,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;6BAEyB;IACzB,SAAS,CAAC,MAAwB;QAChC,OAAO,wBAAwB,CAAS,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;IAChG,CAAC;CACF;AAeD,MAAM,UAAU,aAAa,CAC3B,UAA6C,EAC7C,OAA2B;IAE3B,MAAM,EAAE,GAAG,OAAO,IAAK,UAAgC,CAAA;IACvD,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAE,UAA4B,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAA;IAC/E,OAAO,IAAI,OAAO,CAAS,EAAE,EAAE,SAAS,CAAC,CAAA;AAC3C,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { defineCodemod, Codemod } from './codemod.js';
+export type { CodemodFn, CodemodConfig } from './codemod.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACrD,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { defineCodemod, Codemod } from './codemod.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@codegraft/codemod",
+  "version": "0.1.0-beta.0",
+  "description": "Authoring API for Codegraft codemods: defineCodemod and a jscodeshift-style collection over the CST.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/magne4000/codegraft.git",
+    "directory": "packages/codemod"
+  },
+  "homepage": "https://github.com/magne4000/codegraft#readme",
+  "bugs": "https://github.com/magne4000/codegraft/issues",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "engines": {
+    "node": ">=22.13"
+  },
+  "dependencies": {
+    "@codegraft/core": "0.1.0-beta.0"
+  },
+  "devDependencies": {
+    "@codegraft/vue": "0.1.0-beta.0"
+  },
+  "scripts": {
+    "build": "tsc -b"
+  }
+}