@boperators/cli 0.1.4 → 0.2.1

package/README.md

@@ -65,6 +65,17 @@ Exit code is 1 on violations (suitable for CI / prepublish scripts). Use `--warn
 | `--project <path>` | `tsconfig.json` | Path to tsconfig.json to use |
 | `--warn` | `false` | Emit warnings instead of exiting with an error on violations |
 
+## Comparison with Other Approaches
+
+| Approach | When it runs | Use case |
+|----------|-------------|----------|
+| **`@boperators/cli`** | Before compilation | Batch transform to disk, then compile normally |
+| **`@boperators/plugin-tsc`** | During compilation | Seamless `tsc` integration, no intermediate files |
+| **`@boperators/webpack-loader`** | During bundling | Webpack projects, integrates into existing build pipeline |
+| **`@boperators/plugin-vite`** | During bundling | Vite projects, integrates into Rollup-based pipeline |
+| **`@boperators/plugin-esbuild`** | During bundling | ESBuild projects, fast bundler integration |
+| **`@boperators/plugin-bun`** | At runtime | Bun-only, transforms on module load |
+
 ## License
 
 MIT

package/dist/index.js

@@ -4,40 +4,11 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { Command } from "@commander-js/extra-typings";
 import { ErrorManager, loadConfig, OverloadInjector, OverloadStore, Project as TsMorphProject, validateExports, } from "boperators";
+import { computeCommonSourceDirectory, resolveTsConfig } from "./utils.js";
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const packageJsonPath = path.join(__dirname, "..", "package.json");
 const packageJson = fs.readFileSync(packageJsonPath, "utf-8");
 const { version } = JSON.parse(packageJson);
-/** Resolve tsconfig path relative to cwd if not absolute. */
-function resolveTsConfig(project) {
-    const p = path.isAbsolute(project)
-        ? project
-        : path.join(process.cwd(), project);
-    if (!fs.existsSync(p)) {
-        throw new Error(`Unable to find tsconfig file at "${p}".`);
-    }
-    return p;
-}
-/**
- * Compute the common ancestor directory of a set of file paths — this matches
- * what TypeScript does when `rootDir` is not specified in tsconfig.
- */
-function computeCommonSourceDirectory(filePaths, fallback) {
-    if (filePaths.length === 0)
-        return fallback;
-    const dirs = filePaths.map((p) => path.dirname(p.replaceAll("\\", "/")));
-    const segments = dirs.map((d) => d.split("/"));
-    const first = segments[0];
-    let commonLength = first.length;
-    for (const seg of segments.slice(1)) {
-        let i = 0;
-        while (i < commonLength && i < seg.length && first[i] === seg[i]) {
-            i++;
-        }
-        commonLength = i;
-    }
-    return first.slice(0, commonLength).join("/") || "/";
-}
 const program = new Command()
     .name("boperate")
     .description("Parse operator overloads and inject them into TypeScript files.")
@@ -118,7 +89,7 @@ program
             if (!fs.existsSync(outDir)) {
                 fs.mkdirSync(outDir, { recursive: true });
             }
-            fs.writeFileSync(outPath, JSON.stringify(result.sourceMap.edits, null, 2));
+            fs.writeFileSync(outPath, JSON.stringify(result.edits, null, 2));
         });
     }
 });

package/dist/utils.d.ts

@@ -0,0 +1,7 @@
+/** Resolve tsconfig path relative to cwd if not absolute. */
+export declare function resolveTsConfig(project: string): string;
+/**
+ * Compute the common ancestor directory of a set of file paths — this matches
+ * what TypeScript does when `rootDir` is not specified in tsconfig.
+ */
+export declare function computeCommonSourceDirectory(filePaths: string[], fallback: string): string;

package/dist/utils.js

@@ -0,0 +1,32 @@
+import fs from "node:fs";
+import path from "node:path";
+/** Resolve tsconfig path relative to cwd if not absolute. */
+export function resolveTsConfig(project) {
+    const p = path.isAbsolute(project)
+        ? project
+        : path.join(process.cwd(), project);
+    if (!fs.existsSync(p)) {
+        throw new Error(`Unable to find tsconfig file at "${p}".`);
+    }
+    return p;
+}
+/**
+ * Compute the common ancestor directory of a set of file paths — this matches
+ * what TypeScript does when `rootDir` is not specified in tsconfig.
+ */
+export function computeCommonSourceDirectory(filePaths, fallback) {
+    if (filePaths.length === 0)
+        return fallback;
+    const dirs = filePaths.map((p) => path.dirname(p.replaceAll("\\", "/")));
+    const segments = dirs.map((d) => d.split("/"));
+    const first = segments[0];
+    let commonLength = first.length;
+    for (const seg of segments.slice(1)) {
+        let i = 0;
+        while (i < commonLength && i < seg.length && first[i] === seg[i]) {
+            i++;
+        }
+        commonLength = i;
+    }
+    return first.slice(0, commonLength).join("/") || "/";
+}

package/package.json

@@ -1,13 +1,16 @@
 {
 	"name": "@boperators/cli",
-	"version": "0.1.4",
+	"version": "0.2.1",
 	"license": "MIT",
 	"description": "CLI tool for boperators - transforms TypeScript files with operator overloads.",
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/DiefBell/boperators",
+		"url": "git+https://github.com/DiefBell/boperators.git",
 		"directory": "cli"
 	},
+	"bugs": {
+		"url": "https://github.com/DiefBell/boperators/issues"
+	},
 	"homepage": "https://github.com/DiefBell/boperators/tree/main/cli",
 	"type": "module",
 	"bin": {
@@ -26,6 +29,7 @@
 	"scripts": {
 		"build": "tsc",
 		"watch": "tsc -w",
+		"test": "bun test",
 		"prepublish": "bun run build"
 	},
 	"files": [
@@ -39,7 +43,7 @@
 		"@commander-js/extra-typings": "^13.0.0"
 	},
 	"peerDependencies": {
-		"boperators": "0.1.4",
+		"boperators": "0.2.1",
 		"typescript": ">=5.0.0 <5.10.0"
 	},
 	"devDependencies": {