miniread 1.7.0 → 1.8.0

package/bin/miniread-snapshot

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+/**
+ * CLI entry point that dynamically imports the compiled TypeScript.
+ *
+ * Uses top-level await to ensure module evaluation errors are handled
+ * properly. Without await, errors during import would surface as unhandled
+ * rejections instead of clean CLI failures with appropriate exit codes.
+ */
+try {
+  await import("../dist/scripts/snapshot.js");
+} catch (error) {
+  console.error(
+    "Failed to start miniread-snapshot:",
+    error instanceof Error ? error.message : error,
+  );
+  process.exitCode = 1;
+}

package/dist/scripts/snapshot/create-snapshot-command.d.ts

@@ -0,0 +1,9 @@
+import { Command } from "@commander-js/extra-typings";
+export type SnapshotCliRawOptions = {
+    testcase: string;
+    transform: string;
+    expected: boolean;
+};
+export declare const createSnapshotCommand: (options: {
+    version: string;
+}) => Command;

package/dist/scripts/snapshot/create-snapshot-command.js

@@ -0,0 +1,32 @@
+import { Command } from "@commander-js/extra-typings";
+export const createSnapshotCommand = (options) => {
+    const program = new Command()
+        .name("miniread-snapshot")
+        .description("Generate test case snapshots for transform development workflow.")
+        .version(options.version)
+        .showHelpAfterError("(add --help for additional information)")
+        .showSuggestionAfterError()
+        .requiredOption("--testcase <name>", "Test case directory name (e.g., boolean-literals)")
+        .requiredOption("--transform <id>", "Transform ID to run (e.g., expand-boolean-literals)")
+        .option("--expected", "Write {transform}-expected.js, compare with actual, delete expected on success", false);
+    program.addHelpText("after", `
+Examples:
+  # Generate actual snapshot only (for updating existing snapshots)
+  pnpm run snapshot -- --testcase boolean-literals --transform expand-boolean-literals
+
+  # Full expected-file workflow (Design → Test phase)
+  pnpm run snapshot -- --testcase boolean-literals --transform expand-boolean-literals --expected
+    1. Writes {transform}-expected.js (copy of base.js for manual editing)
+    2. Writes {transform}.js (actual transform output)
+    3. Runs diff between expected and actual
+    4. Deletes expected.js on success (no diff)
+
+Workflow:
+  1. Create test-cases/{testcase}/base.js with your minified snippet
+  2. Run with --expected to generate the expected file template
+  3. Manually edit {transform}-expected.js to match your intent
+  4. Re-run with --expected to compare actual output
+  5. On success (no diff), expected file is auto-deleted
+`);
+    return program;
+};

package/dist/scripts/snapshot/run-snapshot-cli.d.ts

@@ -0,0 +1 @@
+export declare const runSnapshotCli: (argv: string[]) => Promise<number>;

package/dist/scripts/snapshot/run-snapshot-cli.js

@@ -0,0 +1,162 @@
+import * as fs from "node:fs/promises";
+import { createRequire } from "node:module";
+import path from "node:path";
+import * as prettier from "prettier";
+import packageJson from "../../../package.json" with { type: "json" };
+import { buildProjectGraph } from "../../core/project-graph.js";
+import { transformPresets } from "../../transforms/transform-presets.js";
+import { transformRegistry } from "../../transforms/transform-registry.js";
+import { createSnapshotCommand, } from "./create-snapshot-command.js";
+const require = createRequire(import.meta.url);
+// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+const generate = require("@babel/generator").default;
+const TEST_CASES_DIR = path.resolve(import.meta.dirname, "../../../test-cases");
+const formatCode = async (code) => prettier.format(code, { parser: "babel" });
+const runTransform = async (inputPath, transformId) => {
+    const content = await fs.readFile(inputPath, "utf8");
+    // Handle "recommended" as a special case that runs all recommended transforms
+    const transformIds = transformId === "recommended"
+        ? transformPresets.recommended
+        : [transformId];
+    const transforms = transformIds.map((id) => {
+        const transform = transformRegistry[id];
+        if (!transform) {
+            throw new Error(`Unknown transform: ${id}. Run 'miniread --list-transforms' to see available transforms.`);
+        }
+        return transform;
+    });
+    const projectGraph = buildProjectGraph([{ path: inputPath, content }]);
+    for (const transform of transforms) {
+        await transform.transform({
+            projectGraph,
+            currentFile: undefined,
+            options: {},
+        });
+    }
+    const fileInfo = projectGraph.files.get(inputPath);
+    if (!fileInfo) {
+        return content;
+    }
+    return generate(fileInfo.ast).code;
+};
+export const runSnapshotCli = async (argv) => {
+    const program = createSnapshotCommand({ version: packageJson.version });
+    program.parse(argv.filter((argument) => argument !== "--"));
+    const rawOptions = program.opts();
+    const { testcase, transform, expected } = rawOptions;
+    // Validate test case directory exists
+    const testCaseDirectory = path.join(TEST_CASES_DIR, testcase);
+    try {
+        const stats = await fs.stat(testCaseDirectory);
+        if (!stats.isDirectory()) {
+            console.error(`Error: ${testcase} is not a directory`);
+            return 1;
+        }
+    }
+    catch {
+        console.error(`Error: Test case directory not found: test-cases/${testcase}`);
+        console.error(`Create it first: mkdir -p test-cases/${testcase}`);
+        return 1;
+    }
+    // Validate base.js exists
+    const basePath = path.join(testCaseDirectory, "base.js");
+    try {
+        await fs.access(basePath);
+    }
+    catch {
+        console.error(`Error: base.js not found in test-cases/${testcase}/`);
+        console.error(`Create test-cases/${testcase}/base.js with your minified snippet first.`);
+        return 1;
+    }
+    const expectedPath = path.join(testCaseDirectory, `${transform}-expected.js`);
+    const actualPath = path.join(testCaseDirectory, `${transform}.js`);
+    // Run the transform and format
+    let actualOutput;
+    try {
+        const rawOutput = await runTransform(basePath, transform);
+        actualOutput = await formatCode(rawOutput);
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        console.error(`Error running transform: ${message}`);
+        return 1;
+    }
+    if (expected) {
+        // Expected-file workflow
+        // Step 1: Check if expected file exists, create from base.js if not
+        let expectedExists = false;
+        try {
+            await fs.access(expectedPath);
+            expectedExists = true;
+        }
+        catch {
+            // Expected file doesn't exist, create it from base.js
+            const baseContent = await fs.readFile(basePath, "utf8");
+            const formattedBase = await formatCode(baseContent);
+            await fs.writeFile(expectedPath, formattedBase);
+            console.log(`Created: test-cases/${testcase}/${transform}-expected.js`);
+            console.log("Edit this file to match your expected output, then re-run.");
+        }
+        // Step 2: Write actual output
+        await fs.writeFile(actualPath, actualOutput);
+        console.log(`Created: test-cases/${testcase}/${transform}.js`);
+        if (!expectedExists) {
+            // First run - just created expected file, user needs to edit it
+            return 0;
+        }
+        // Step 3: Compare expected vs actual
+        const expectedContent = await fs.readFile(expectedPath, "utf8");
+        if (expectedContent === actualOutput) {
+            // Success! Delete expected file
+            await fs.unlink(expectedPath);
+            console.log(`\nSuccess: Output matches expected.`);
+            console.log(`Deleted: test-cases/${testcase}/${transform}-expected.js`);
+            console.log(`\nSnapshot ready: test-cases/${testcase}/${transform}.js`);
+            return 0;
+        }
+        else {
+            // Diff - show the difference
+            console.log(`\nDiff: expected vs actual`);
+            console.log("---");
+            // Simple line-by-line diff output
+            const expectedLines = expectedContent.split("\n");
+            const actualLines = actualOutput.split("\n");
+            const maxLines = Math.max(expectedLines.length, actualLines.length);
+            let hasDiff = false;
+            for (let lineIndex = 0; lineIndex < maxLines; lineIndex++) {
+                const exp = expectedLines[lineIndex];
+                const act = actualLines[lineIndex];
+                if (exp !== act) {
+                    hasDiff = true;
+                    if (exp !== undefined && act === undefined) {
+                        console.log(`Line ${lineIndex + 1}:`);
+                        console.log(`  - ${exp}`);
+                    }
+                    else if (exp === undefined && act !== undefined) {
+                        console.log(`Line ${lineIndex + 1}:`);
+                        console.log(`  + ${act}`);
+                    }
+                    else {
+                        console.log(`Line ${lineIndex + 1}:`);
+                        console.log(`  - ${exp}`);
+                        console.log(`  + ${act}`);
+                    }
+                }
+            }
+            if (!hasDiff) {
+                // Shouldn't happen since we already checked equality, but just in case
+                console.log("(no visible differences)");
+            }
+            console.log("---");
+            console.log(`\nExpected file preserved: test-cases/${testcase}/${transform}-expected.js`);
+            console.log("Fix the implementation or update the expected file, then re-run.");
+            return 1;
+        }
+    }
+    else {
+        // Simple mode: just write actual output
+        await fs.writeFile(actualPath, actualOutput);
+        console.log(`Created: test-cases/${testcase}/${transform}.js`);
+        return 0;
+    }
+};

package/dist/scripts/snapshot.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/scripts/snapshot.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import { runSnapshotCli } from "./snapshot/run-snapshot-cli.js";
+try {
+    const exitCode = await runSnapshotCli(process.argv);
+    if (exitCode !== 0) {
+        process.exitCode = exitCode;
+    }
+}
+catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    console.error(`Error: ${message}`);
+    process.exitCode = 1;
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "miniread",
   "author": "Łukasz Jerciński",
   "license": "MIT",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Transform minified JavaScript/TypeScript into a more readable form using deterministic AST-based transforms.",
   "repository": {
     "type": "git",
@@ -24,7 +24,8 @@
   "bin": {
     "miniread": "bin/miniread",
     "miniread-evaluate": "bin/miniread-evaluate",
-    "miniread-sample": "bin/miniread-sample"
+    "miniread-sample": "bin/miniread-sample",
+    "miniread-snapshot": "bin/miniread-snapshot"
   },
   "files": [
     "bin/",
@@ -47,6 +48,7 @@
     "miniread": "pnpm -s run rebuild && node bin/miniread",
     "miniread-evaluate": "pnpm -s run rebuild && node bin/miniread-evaluate",
     "miniread-sample": "pnpm -s run rebuild && node bin/miniread-sample",
+    "snapshot": "pnpm -s run rebuild && node bin/miniread-snapshot",
     "rebuild": "pnpm run clean && pnpm run build",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",