@boperators/cli 0.1.0

package/README.md

@@ -0,0 +1,68 @@
+# @boperators/cli
+
+CLI tool for [boperators](https://www.npmjs.com/package/boperators) - transforms TypeScript files with operator overloads.
+
+## Installation
+
+```sh
+npm install -D boperators @boperators/cli
+```
+
+## Usage
+
+The CLI provides two subcommands via `boperate` (or the `bop` alias).
+
+### `boperate compile`
+
+Injects operator overloads into your TypeScript files and emits JavaScript using your `tsconfig.json` settings.
+
+```sh
+# Compile to JavaScript (output goes to tsconfig's outDir)
+boperate compile
+
+# Use a specific tsconfig
+boperate compile --project ./tsconfig.custom.json
+
+# Also save the transformed TypeScript (e.g. to feed into another build tool)
+boperate compile --ts-out ./transformed
+
+# Only produce transformed TypeScript, skip JavaScript output
+boperate compile --ts-out ./transformed --no-emit
+
+# Also write source map files
+boperate compile --ts-out ./transformed --maps-out ./maps
+```
+
+The CLI reads your `tsconfig.json` to determine which files to process and where to emit output. It parses overload definitions from all files (including dependencies), but only transforms and emits files within your project directory.
+
+| Option | Alias | Default | Description |
+|--------|-------|---------|-------------|
+| `--ts-out <dir>` | `-t` | | Save the transformed TypeScript files to this directory (useful for further build tooling) |
+| `--maps-out <dir>` | `-m` | | Output directory for source map files (`.map.ts`) |
+| `--project <path>` | `-p` | `tsconfig.json` | Path to tsconfig.json to use |
+| `--no-emit` | | | Skip JavaScript output |
+| `--error-on-warning` | | `false` | Treat conflicting overload warnings as errors |
+
+### `boperate validate`
+
+Validates that all classes with operator overloads are properly exported. Intended for library authors to run before publishing.
+
+```sh
+# Level 1 — check every overload class is exported from its source file
+boperate validate
+
+# Level 2 — also verify each class is reachable via your package entry point
+boperate validate --entry src/index.ts
+```
+
+Exit code is 1 on violations (suitable for CI / prepublish scripts). Use `--warn` to emit warnings instead of errors.
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--entry <path>` | | Source entry point for deep reachability check (e.g. `src/index.ts`) |
+| `--project <path>` | `tsconfig.json` | Path to tsconfig.json to use |
+| `--warn` | `false` | Emit warnings instead of exiting with an error on violations |
+
+## License
+
+MIT

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,177 @@
+#!/usr/bin/env node
+import fs from "node:fs";
+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";
+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.")
+    .version(version);
+// ---------- compile ----------
+program
+    .command("compile")
+    .description("Inject operator overloads into TypeScript files and emit JavaScript.")
+    .option("-t, --ts-out <dir>", "Output directory for the transformed TypeScript files (useful if you want to run another build tool over them afterwards).")
+    .option("-p, --project <path>", "Path to tsconfig.json to use.", "tsconfig.json")
+    .option("-m, --maps-out <dir>", "Output directory for source map files (.map.ts).")
+    .option("--no-emit", "Skip JavaScript output. Useful when combined with --ts-out to only produce transformed TypeScript.")
+    .option("--error-on-warning", "Instead of showing a warning, error on conflicting overloads.", false)
+    .action((options) => {
+    const tsConfigFilePath = resolveTsConfig(options.project);
+    const config = loadConfig({
+        searchDir: path.dirname(tsConfigFilePath),
+        overrides: { errorOnWarning: options.errorOnWarning },
+    });
+    const project = new TsMorphProject({ tsConfigFilePath });
+    const errorManager = new ErrorManager(config);
+    const overloadStore = new OverloadStore(project, errorManager, config.logger);
+    const overloadInjector = new OverloadInjector(project, overloadStore, config.logger);
+    const allFiles = project.getSourceFiles();
+    // Only transform and write files within the user's project directory
+    // ts-morph normalizes paths to forward slashes, so we must match that
+    const projectDir = `${path.dirname(tsConfigFilePath).replaceAll("\\", "/")}/`;
+    const projectFiles = allFiles.filter((file) => file.getFilePath().startsWith(projectDir));
+    // Parse ALL files for overload definitions (including library dependencies)
+    allFiles.forEach((file) => {
+        overloadStore.addOverloadsFromFile(file);
+    });
+    errorManager.throwIfErrorsElseLogWarnings();
+    // Only transform files belonging to the user's project
+    const transformResults = projectFiles.map((file) => overloadInjector.overloadFile(file));
+    errorManager.throwIfErrorsElseLogWarnings();
+    // Emit JavaScript to the tsconfig outDir by default
+    if (options.emit) {
+        project.emit();
+    }
+    if (options.tsOut) {
+        const tsOutDir = path.isAbsolute(options.tsOut)
+            ? options.tsOut
+            : path.join(process.cwd(), options.tsOut);
+        if (!fs.existsSync(tsOutDir)) {
+            fs.mkdirSync(tsOutDir, { recursive: true });
+        }
+        const compilerOptions = project.getCompilerOptions();
+        const rootDir = compilerOptions.rootDir
+            ? path.resolve(path.dirname(tsConfigFilePath), compilerOptions.rootDir)
+            : computeCommonSourceDirectory(projectFiles.map((f) => f.getFilePath()), path.dirname(tsConfigFilePath));
+        transformResults.forEach((result) => {
+            const relativePath = path.relative(rootDir, result.sourceFile.getFilePath());
+            const outPath = path.join(tsOutDir, relativePath);
+            const outDir = path.dirname(outPath);
+            if (!fs.existsSync(outDir)) {
+                fs.mkdirSync(outDir, { recursive: true });
+            }
+            fs.writeFileSync(outPath, result.text);
+        });
+    }
+    if (options.mapsOut) {
+        const mapsOutDir = path.isAbsolute(options.mapsOut)
+            ? options.mapsOut
+            : path.join(process.cwd(), options.mapsOut);
+        if (!fs.existsSync(mapsOutDir)) {
+            fs.mkdirSync(mapsOutDir, { recursive: true });
+        }
+        const compilerOptions = project.getCompilerOptions();
+        const rootDir = compilerOptions.rootDir
+            ? path.resolve(path.dirname(tsConfigFilePath), compilerOptions.rootDir)
+            : computeCommonSourceDirectory(projectFiles.map((f) => f.getFilePath()), path.dirname(tsConfigFilePath));
+        transformResults.forEach((result) => {
+            const relativePath = path.relative(rootDir, result.sourceFile.getFilePath());
+            const mapFileName = relativePath.replace(/\.ts$/, ".map.ts");
+            const outPath = path.join(mapsOutDir, mapFileName);
+            const outDir = path.dirname(outPath);
+            if (!fs.existsSync(outDir)) {
+                fs.mkdirSync(outDir, { recursive: true });
+            }
+            fs.writeFileSync(outPath, JSON.stringify(result.sourceMap.edits, null, 2));
+        });
+    }
+});
+// ---------- validate ----------
+program
+    .command("validate")
+    .description("Validate that all classes with operator overloads are properly exported. " +
+    "Intended for library authors to run before publishing.")
+    .option("-p, --project <path>", "Path to tsconfig.json to use.", "tsconfig.json")
+    .option("--entry <path>", "Source entry point for deep reachability check (e.g. src/index.ts). " +
+    "When provided, validates that every overload class is transitively " +
+    "reachable via the entry file's export graph.")
+    .option("--warn", "Emit warnings instead of exiting with an error on violations.", false)
+    .action((options) => {
+    const tsConfigFilePath = resolveTsConfig(options.project);
+    const projectDir = path.dirname(tsConfigFilePath);
+    const config = loadConfig({ searchDir: projectDir });
+    const project = new TsMorphProject({ tsConfigFilePath });
+    const errorManager = new ErrorManager(config);
+    const overloadStore = new OverloadStore(project, errorManager, config.logger);
+    // Scan all files for overload definitions
+    project.getSourceFiles().forEach((file) => {
+        overloadStore.addOverloadsFromFile(file);
+    });
+    const entryPoint = options.entry
+        ? path.isAbsolute(options.entry)
+            ? options.entry
+            : path.join(process.cwd(), options.entry)
+        : undefined;
+    const result = validateExports({
+        project,
+        overloadStore,
+        projectDir,
+        entryPoint,
+    });
+    if (result.violations.length === 0) {
+        console.log("[boperators] All overload classes are properly exported.");
+        process.exit(0);
+    }
+    for (const violation of result.violations) {
+        const relPath = path.relative(projectDir, violation.classFilePath);
+        const message = violation.reason === "not-exported-from-file"
+            ? `${violation.className} (${relPath}): not exported from its source file — add 'export' to the class declaration`
+            : `${violation.className} (${relPath}): not reachable from entry point — ensure it is re-exported from ${options.entry}`;
+        if (options.warn) {
+            console.warn(`[boperators] WARNING: ${message}`);
+        }
+        else {
+            console.error(`[boperators] ERROR: ${message}`);
+        }
+    }
+    if (!options.warn) {
+        process.exit(1);
+    }
+});
+program.parse(process.argv);

package/license.txt

@@ -0,0 +1,8 @@
+Copyright 2025 Dief Bell
+
+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/package.json

@@ -0,0 +1,47 @@
+{
+	"name": "@boperators/cli",
+	"version": "0.1.0",
+	"license": "MIT",
+	"description": "CLI tool for boperators - transforms TypeScript files with operator overloads.",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/DiefBell/boperators",
+		"directory": "cli"
+	},
+	"homepage": "https://github.com/DiefBell/boperators/tree/main/cli",
+	"type": "module",
+	"bin": {
+		"bop": "dist/index.js",
+		"boperate": "dist/index.js"
+	},
+	"keywords": [
+		"boperators",
+		"typescript",
+		"operator",
+		"overload",
+		"operator-overloading",
+		"cli",
+		"transform"
+	],
+	"scripts": {
+		"build": "tsc",
+		"watch": "tsc -w",
+		"prepublish": "bun run build"
+	},
+	"files": [
+		"package.json",
+		"README.md",
+		"license.txt",
+		"dist"
+	],
+	"dependencies": {
+		"@commander-js/extra-typings": "^13.0.0"
+	},
+	"peerDependencies": {
+		"boperators": "0.1.0",
+		"typescript": ">=5.0.0 <5.10.0"
+	},
+	"devDependencies": {
+		"boperators": "file:../package"
+	}
+}