miniread 1.0.0

package/dist/transforms/rename-catch-parameters/rename-catch-parameters-transform.js

@@ -0,0 +1,67 @@
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+const traverse = require("@babel/traverse").default;
+const BASE_NAME = "caughtError";
+const getRenamedAncestorCatchCount = (path, renamedCatches) => {
+    let count = 0;
+    for (const ancestor of path.getAncestry()) {
+        if (ancestor === path)
+            continue;
+        if (!ancestor.isCatchClause())
+            continue;
+        if (renamedCatches.has(ancestor.node))
+            count++;
+    }
+    return count;
+};
+const getTargetCaughtErrorName = (renamedAncestorCatchCount) => {
+    if (renamedAncestorCatchCount === 0)
+        return BASE_NAME;
+    return `${BASE_NAME}${renamedAncestorCatchCount + 1}`;
+};
+const getCatchParameterNameIfEligible = (path) => {
+    const parameter = path.node.param;
+    if (!parameter)
+        return;
+    if (parameter.type !== "Identifier")
+        return;
+    if (parameter.name.length > 2)
+        return;
+    return parameter.name;
+};
+export const renameCatchParametersTransform = {
+    id: "rename-catch-parameters",
+    description: "Renames minified catch clause parameters to caughtError/caughtError2/...",
+    scope: "file",
+    parallelizable: true,
+    transform(context) {
+        const { projectGraph } = context;
+        let nodesVisited = 0;
+        let transformationsApplied = 0;
+        for (const [, fileInfo] of projectGraph.files) {
+            const renamedCatches = new WeakMap();
+            traverse(fileInfo.ast, {
+                CatchClause(path) {
+                    nodesVisited++;
+                    const currentName = getCatchParameterNameIfEligible(path);
+                    if (!currentName)
+                        return;
+                    const renamedAncestorCatchCount = getRenamedAncestorCatchCount(path, renamedCatches);
+                    const targetName = getTargetCaughtErrorName(renamedAncestorCatchCount);
+                    if (currentName === targetName)
+                        return;
+                    if (path.scope.hasBinding(targetName))
+                        return;
+                    path.scope.rename(currentName, targetName);
+                    renamedCatches.set(path.node, targetName);
+                    transformationsApplied++;
+                },
+            });
+        }
+        return Promise.resolve({
+            nodesVisited,
+            transformationsApplied,
+        });
+    },
+};

package/dist/transforms/rename-loop-index-variables/rename-loop-index-variables-transform.d.ts

@@ -0,0 +1,2 @@
+import type { Transform } from "../../core/types.js";
+export declare const renameLoopIndexVariablesTransform: Transform;

package/dist/transforms/rename-loop-index-variables/rename-loop-index-variables-transform.js

@@ -0,0 +1,125 @@
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+const traverse = require("@babel/traverse").default;
+const getRenamedAncestorLoopCount = (path, renamedLoops) => {
+    let count = 0;
+    for (const ancestor of path.getAncestry()) {
+        if (ancestor === path)
+            continue;
+        if (!ancestor.isForStatement())
+            continue;
+        if (renamedLoops.has(ancestor.node))
+            count++;
+    }
+    return count;
+};
+const getTargetIndexName = (renamedAncestorLoopCount) => {
+    if (renamedAncestorLoopCount === 0)
+        return "index";
+    return `index${renamedAncestorLoopCount + 1}`;
+};
+const getLoopCounterNameIfEligible = (path) => {
+    const init = path.node.init;
+    if (!init)
+        return;
+    if (init.type !== "VariableDeclaration")
+        return;
+    if (init.kind !== "let")
+        return;
+    if (init.declarations.length !== 1)
+        return;
+    const declarator = init.declarations[0];
+    if (!declarator)
+        return;
+    if (declarator.id.type !== "Identifier")
+        return;
+    if (!declarator.init)
+        return;
+    if (declarator.init.type !== "NumericLiteral")
+        return;
+    if (declarator.init.value !== 0)
+        return;
+    const loopCounterName = declarator.id.name;
+    const test = path.node.test;
+    if (!test)
+        return;
+    if (test.type !== "BinaryExpression")
+        return;
+    if (test.operator !== "<" && test.operator !== "<=")
+        return;
+    if (test.left.type !== "Identifier")
+        return;
+    if (test.left.name !== loopCounterName)
+        return;
+    if (test.right.type !== "MemberExpression")
+        return;
+    if (test.right.computed)
+        return;
+    if (test.right.property.type !== "Identifier")
+        return;
+    if (test.right.property.name !== "length")
+        return;
+    const update = path.node.update;
+    if (!update)
+        return;
+    if (update.type === "UpdateExpression") {
+        if (update.operator !== "++")
+            return;
+        if (update.argument.type !== "Identifier")
+            return;
+        if (update.argument.name !== loopCounterName)
+            return;
+    }
+    else if (update.type === "AssignmentExpression") {
+        if (update.operator !== "+=")
+            return;
+        if (update.left.type !== "Identifier")
+            return;
+        if (update.left.name !== loopCounterName)
+            return;
+        if (update.right.type !== "NumericLiteral")
+            return;
+        if (update.right.value <= 0)
+            return;
+    }
+    else {
+        return;
+    }
+    return loopCounterName;
+};
+export const renameLoopIndexVariablesTransform = {
+    id: "rename-loop-index-variables",
+    description: "Renames numeric for-loop counters to index/index2/... based on nesting depth",
+    scope: "file",
+    parallelizable: true,
+    transform(context) {
+        const { projectGraph } = context;
+        let nodesVisited = 0;
+        let transformationsApplied = 0;
+        for (const [, fileInfo] of projectGraph.files) {
+            const renamedLoops = new WeakMap();
+            traverse(fileInfo.ast, {
+                ForStatement(path) {
+                    nodesVisited++;
+                    const loopCounterName = getLoopCounterNameIfEligible(path);
+                    if (!loopCounterName)
+                        return;
+                    const renamedAncestorLoopCount = getRenamedAncestorLoopCount(path, renamedLoops);
+                    const targetName = getTargetIndexName(renamedAncestorLoopCount);
+                    if (loopCounterName === targetName)
+                        return;
+                    if (path.scope.hasBinding(targetName))
+                        return;
+                    path.scope.rename(loopCounterName, targetName);
+                    renamedLoops.set(path.node, targetName);
+                    transformationsApplied++;
+                },
+            });
+        }
+        return Promise.resolve({
+            nodesVisited,
+            transformationsApplied,
+        });
+    },
+};

package/dist/transforms/transform-presets.d.ts

@@ -0,0 +1,3 @@
+export declare const transformPresets: {
+    recommended: string[];
+};

package/dist/transforms/transform-presets.js

@@ -0,0 +1,19 @@
+import transformManifestJson from "../../transform-manifest.json" with { type: "json" };
+import * as z from "zod";
+const TransformManifestEntry = z
+    .object({
+    id: z.string().min(1),
+    enabledByDefault: z.boolean(),
+})
+    .loose();
+const TransformManifest = z
+    .object({
+    transforms: z.array(TransformManifestEntry),
+})
+    .loose();
+const transformManifest = TransformManifest.parse(transformManifestJson);
+export const transformPresets = {
+    recommended: transformManifest.transforms
+        .filter((transform) => transform.enabledByDefault)
+        .map((transform) => transform.id),
+};

package/dist/transforms/transform-registry.d.ts

@@ -0,0 +1,3 @@
+import type { Transform } from "../core/types.js";
+export declare const transformRegistry: Record<string, Transform>;
+export declare const allTransformIds: string[];

package/dist/transforms/transform-registry.js

@@ -0,0 +1,15 @@
+import { addPrefixTransform } from "./add-prefix/add-prefix-transform.js";
+import { addSuffixTransform } from "./add-suffix/add-suffix-transform.js";
+import { expandBooleanLiteralsTransform } from "./expand-boolean-literals/expand-boolean-literals-transform.js";
+import { expandUndefinedLiteralsTransform } from "./expand-undefined-literals/expand-undefined-literals-transform.js";
+import { renameCatchParametersTransform } from "./rename-catch-parameters/rename-catch-parameters-transform.js";
+import { renameLoopIndexVariablesTransform } from "./rename-loop-index-variables/rename-loop-index-variables-transform.js";
+export const transformRegistry = {
+    [addPrefixTransform.id]: addPrefixTransform,
+    [addSuffixTransform.id]: addSuffixTransform,
+    [expandBooleanLiteralsTransform.id]: expandBooleanLiteralsTransform,
+    [expandUndefinedLiteralsTransform.id]: expandUndefinedLiteralsTransform,
+    [renameCatchParametersTransform.id]: renameCatchParametersTransform,
+    [renameLoopIndexVariablesTransform.id]: renameLoopIndexVariablesTransform,
+};
+export const allTransformIds = Object.keys(transformRegistry);

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "miniread",
+  "author": "Łukasz Jerciński",
+  "license": "MIT",
+  "version": "1.0.0",
+  "description": "Transform minified JavaScript/TypeScript into a more readable form using deterministic AST-based transforms.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Jercik/miniread.git"
+  },
+  "homepage": "https://github.com/Jercik/miniread#readme",
+  "bugs": {
+    "url": "https://github.com/Jercik/miniread/issues"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "miniread": "bin/miniread",
+    "miniread-evaluate": "bin/miniread-evaluate",
+    "miniread-sample": "bin/miniread-sample"
+  },
+  "files": [
+    "bin/",
+    "dist/",
+    "transform-manifest.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [],
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "dependencies": {
+    "@babel/generator": "^7.28.6",
+    "@babel/parser": "^7.28.6",
+    "@babel/traverse": "^7.28.6",
+    "@babel/types": "^7.28.6",
+    "@commander-js/extra-typings": "^14.0.0",
+    "commander": "^14.0.2",
+    "env-paths": "^3.0.0",
+    "p-queue": "^9.1.0",
+    "zod": "^4.3.5"
+  },
+  "devDependencies": {
+    "@total-typescript/ts-reset": "^0.6.1",
+    "@types/babel__generator": "^7.27.0",
+    "@types/babel__traverse": "^7.28.0",
+    "@types/node": "^25.0.9",
+    "@vitest/coverage-v8": "^4.0.17",
+    "eslint": "^9.39.2",
+    "eslint-config-axkit": "^1.1.0",
+    "fta-check": "^1.5.1",
+    "fta-cli": "^3.0.0",
+    "knip": "^5.82.1",
+    "prettier": "3.8.0",
+    "semantic-release": "^25.0.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.17"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.app.json",
+    "clean": "rm -rf dist *.tsbuildinfo",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "fta": "fta-check",
+    "knip": "knip",
+    "lint": "eslint",
+    "rebuild": "pnpm run clean && pnpm run build",
+    "miniread": "pnpm -s run rebuild && node bin/miniread",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest",
+    "miniread-evaluate": "pnpm -s run rebuild && node bin/miniread-evaluate",
+    "miniread-sample": "pnpm -s run rebuild && node bin/miniread-sample",
+    "typecheck": "tsc -b --noEmit"
+  }
+}

package/transform-manifest.json

@@ -0,0 +1,70 @@
+{
+  "transforms": [
+    {
+      "id": "add-prefix",
+      "description": "Adds 'renamed_' prefix to variable and function declarations",
+      "iteration": 0,
+      "scope": "file",
+      "parallelizable": true,
+      "diffReductionImpact": 0,
+      "enabledByDefault": false,
+      "notes": "Example transform for testing infrastructure"
+    },
+    {
+      "id": "add-suffix",
+      "description": "Adds '_end' suffix to variable and function declarations",
+      "iteration": 0,
+      "scope": "file",
+      "parallelizable": true,
+      "diffReductionImpact": 0,
+      "enabledByDefault": false,
+      "notes": "Example transform for testing infrastructure"
+    },
+    {
+      "id": "expand-boolean-literals",
+      "description": "Expands !0 to true and !1 to false",
+      "iteration": 1,
+      "scope": "file",
+      "parallelizable": true,
+      "diffReductionImpact": 0,
+      "enabledByDefault": true,
+      "notes": "Improves readability but does not reduce diffs (boolean literals are already deterministic)"
+    },
+    {
+      "id": "expand-undefined-literals",
+      "description": "Expands void 0 to undefined (when undefined is not shadowed)",
+      "iteration": 2,
+      "scope": "file",
+      "parallelizable": true,
+      "diffReductionImpact": 0,
+      "enabledByDefault": true,
+      "notes": "Auto-added by evaluation script."
+    },
+    {
+      "id": "rename-loop-index-variables",
+      "description": "Renames numeric for-loop counters to index/index2/... based on nesting depth",
+      "iteration": 3,
+      "scope": "file",
+      "parallelizable": true,
+      "diffReductionImpact": 0,
+      "enabledByDefault": true,
+      "notes": "Auto-added by evaluation script."
+    },
+    {
+      "id": "rename-catch-parameters",
+      "description": "Renames minified catch clause parameters to caughtError/caughtError2/...",
+      "iteration": 4,
+      "scope": "file",
+      "parallelizable": true,
+      "diffReductionImpact": 0,
+      "enabledByDefault": true,
+      "notes": "Auto-added by evaluation script."
+    }
+  ],
+  "presetStats": {
+    "recommended": {
+      "diffReductionImpact": 0,
+      "notes": "Auto-updated by evaluation when running with baseline none and the recommended preset."
+    }
+  }
+}