codeflash 0.0.1 → 0.1.0

package/README.md

@@ -0,0 +1,104 @@
+# codeflash
+
+AI-powered code optimization for JavaScript and TypeScript.
+
+Codeflash automatically optimizes your code for better performance while maintaining correctness.
+
+## Installation
+
+```bash
+npm install -D codeflash
+# or
+yarn add -D codeflash
+# or
+pnpm add -D codeflash
+```
+
+The installation automatically sets up:
+1. **uv** - Python package manager (if not already installed)
+2. **codeflash** - Python CLI for code optimization
+3. **Jest runtime helpers** - Bundled test instrumentation (capture, serializer, comparator)
+
+## Quick Start
+
+```bash
+# Optimize a specific function
+npx codeflash optimize --file src/utils.ts --function fibonacci
+
+# Optimize all functions in a file
+npx codeflash optimize --file src/utils.ts
+
+# Get help
+npx codeflash --help
+```
+
+## Requirements
+
+- **Node.js** >= 18.0.0
+- **Jest** (for running tests)
+- Internet connection (for AI optimization)
+
+## How It Works
+
+1. **Analyze**: Codeflash analyzes your code and identifies optimization opportunities
+2. **Test**: Runs your existing tests to capture current behavior
+3. **Optimize**: Uses AI to generate optimized versions
+4. **Verify**: Runs tests again to ensure the optimization is correct
+5. **Benchmark**: Measures performance improvement
+
+## Configuration
+
+Create a `codeflash.yaml` in your project root:
+
+```yaml
+module_root: src
+tests_root: tests
+```
+
+## CI/CD
+
+In CI environments, the postinstall script is skipped by default. Run setup manually:
+
+```bash
+npx codeflash-setup
+```
+
+Or set `CODEFLASH_SKIP_POSTINSTALL=false` to enable automatic setup.
+
+## Troubleshooting
+
+### uv not found
+
+If you see "uv not found", run the setup script:
+
+```bash
+npx codeflash-setup
+```
+
+Or install uv manually:
+
+```bash
+# macOS/Linux
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Windows
+powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+### codeflash not in PATH
+
+After installation, you may need to restart your terminal or run:
+
+```bash
+source ~/.bashrc  # or ~/.zshrc
+```
+
+## Links
+
+- [Documentation](https://docs.codeflash.ai)
+- [GitHub](https://github.com/codeflash-ai/codeflash)
+- [Discord](https://discord.gg/codeflash)
+
+## License
+
+MIT

package/bin/codeflash-setup.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+/**
+ * Codeflash Setup Script
+ *
+ * Run this manually if the postinstall script was skipped (e.g., in CI)
+ * or if you need to reinstall the Python CLI.
+ *
+ * Usage:
+ *   npx codeflash-setup
+ */
+
+require('../scripts/postinstall.js');

package/bin/codeflash.js

@@ -0,0 +1,131 @@
+#!/usr/bin/env node
+
+/**
+ * Codeflash CLI Entry Point
+ *
+ * This script is the main entry point for the codeflash CLI when installed via npm.
+ * It delegates to the Python codeflash CLI installed via uv.
+ *
+ * Usage:
+ *   npx codeflash --help
+ *   npx codeflash optimize --file src/utils.ts
+ */
+
+const { spawn, spawnSync } = require('child_process');
+const os = require('os');
+const path = require('path');
+const fs = require('fs');
+
+/**
+ * Find the uv binary
+ */
+function findUv() {
+  const homeDir = os.homedir();
+  const platform = os.platform();
+
+  // Check the default uv installation location first
+  const uvPath = platform === 'win32'
+    ? path.join(homeDir, '.local', 'bin', 'uv.exe')
+    : path.join(homeDir, '.local', 'bin', 'uv');
+
+  if (fs.existsSync(uvPath)) {
+    return uvPath;
+  }
+
+  // Try to find uv in PATH by checking if it exists
+  try {
+    const uvInPath = spawnSync('uv', ['--version'], {
+      stdio: 'ignore',
+    });
+    if (uvInPath.status === 0) {
+      return 'uv';
+    }
+  } catch {
+    // uv not in PATH
+  }
+
+  return null;
+}
+
+/**
+ * Run the codeflash CLI via uv
+ */
+function runCodeflash(args) {
+  const uvBin = findUv();
+
+  if (!uvBin) {
+    console.error('\x1b[31mError:\x1b[0m uv not found.');
+    console.error('');
+    console.error('Please run the setup script:');
+    console.error('  npx codeflash-setup');
+    console.error('');
+    console.error('Or install uv manually:');
+    console.error('  curl -LsSf https://astral.sh/uv/install.sh | sh');
+    process.exit(1);
+  }
+
+  // Use uv tool run to execute codeflash
+  const child = spawn(uvBin, ['tool', 'run', 'codeflash', ...args], {
+    stdio: 'inherit',
+  });
+
+  child.on('error', (error) => {
+    console.error(`\x1b[31mError:\x1b[0m Failed to run codeflash: ${error.message}`);
+    process.exit(1);
+  });
+
+  child.on('exit', (code, signal) => {
+    if (signal) {
+      process.exit(1);
+    }
+    process.exit(code || 0);
+  });
+}
+
+/**
+ * Show setup instructions
+ */
+function showSetupHelp() {
+  console.log(`
+\x1b[36m╔════════════════════════════════════════════╗
+║     Codeflash CLI Setup Required           ║
+╚════════════════════════════════════════════╝\x1b[0m
+
+The codeflash Python CLI is not installed.
+
+\x1b[33mTo complete setup, run:\x1b[0m
+  npx codeflash-setup
+
+\x1b[33mOr install manually:\x1b[0m
+  curl -LsSf https://astral.sh/uv/install.sh | sh
+  uv tool install codeflash
+
+\x1b[36mDocumentation:\x1b[0m https://docs.codeflash.ai
+`);
+}
+
+// Main
+const args = process.argv.slice(2);
+
+// Special case: setup command
+if (args[0] === 'setup' || args[0] === '--setup') {
+  require('../scripts/postinstall.js');
+} else {
+  // Check if codeflash is installed
+  const uvBin = findUv();
+  if (uvBin) {
+    const check = spawnSync(uvBin, ['tool', 'run', 'codeflash', '--version'], {
+      stdio: 'ignore',
+    });
+
+    if (check.status !== 0 && args.length === 0) {
+      showSetupHelp();
+      process.exit(1);
+    }
+  } else if (args.length === 0) {
+    showSetupHelp();
+    process.exit(1);
+  }
+
+  runCodeflash(args);
+}

package/package.json

@@ -1,11 +1,76 @@
 {
   "name": "codeflash",
-  "version": "0.0.1",
-  "description": "",
-  "main": "index.js",
+  "version": "0.1.0",
+  "description": "Codeflash - AI-powered code optimization for JavaScript and TypeScript",
+  "main": "runtime/index.js",
+  "bin": {
+    "codeflash": "./bin/codeflash.js",
+    "codeflash-setup": "./bin/codeflash-setup.js"
+  },
+  "publishConfig": {
+  "access": "public"
+  },
+  "exports": {
+    ".": {
+      "require": "./runtime/index.js",
+      "import": "./runtime/index.js"
+    },
+    "./capture": {
+      "require": "./runtime/capture.js",
+      "import": "./runtime/capture.js"
+    },
+    "./serializer": {
+      "require": "./runtime/serializer.js",
+      "import": "./runtime/serializer.js"
+    },
+    "./comparator": {
+      "require": "./runtime/comparator.js",
+      "import": "./runtime/comparator.js"
+    }
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "postinstall": "node scripts/postinstall.js",
+    "pack": "npm pack",
+    "prepublishOnly": "echo 'Ready to publish'"
+  },
+  "files": [
+    "bin/",
+    "scripts/",
+    "runtime/"
+  ],
+  "keywords": [
+    "codeflash",
+    "optimization",
+    "performance",
+    "javascript",
+    "typescript",
+    "ai",
+    "cli",
+    "jest"
+  ],
+  "author": "Codeflash AI",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/codeflash-ai/codeflash.git",
+    "directory": "packages/cli"
+  },
+  "bugs": {
+    "url": "https://github.com/codeflash-ai/codeflash/issues"
+  },
+  "homepage": "https://codeflash.ai",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "peerDependencies": {
+    "jest": ">=27.0.0"
+  },
+  "peerDependenciesMeta": {
+    "jest": {
+      "optional": true
+    }
   },
-  "author": "",
-  "license": "ISC"
+  "optionalDependencies": {
+    "better-sqlite3": "^9.0.0"
+  }
 }