cpd 5.0.4 → 5.0.5

package/README.md

@@ -1,32 +1,32 @@
 # cpd — Rust Copy/Paste Detector
 
-Fast copy/paste detector for programming source code. Rust rewrite of [jscpd](https://github.com/kucherenko/jscpd) with 10–30× faster detection, git blame, and 225+ language formats.
+Fast copy/paste detector for programming source code. 24-37x faster than Node.js. Rust rewrite of [jscpd](https://github.com/kucherenko/jscpd), supports 223 language formats.
+
+Also available as an npm package: [`jscpd@5`](https://www.npmjs.com/package/jscpd) (installs both `jscpd` and `cpd` commands) or [`cpd`](https://www.npmjs.com/package/cpd) (installs `cpd` command only).
 
 ## Performance
 
-| Codebase | Files | jscpd v4 (Node.js) | cpd v5 (Rust) | Speedup |
-|----------|-------|--------------------|----------------|---------|
-| Multi-format fixtures | 353 | 1.59 s | 0.45 s | 3.5× |
-| Rust sources (homogeneous) | 46 | 0.87 s | 0.03 s | 29× |
+| Codebase | Files | Size | jscpd v4 (Node.js) | cpd v5 (Rust) | Speedup |
+|----------|-------|------|--------------------|----------------|---------|
+| Multi-format fixtures | 548 | 1.5 MB | 1.03 s | 0.03 s | 34.3× |
+| Svelte source | 9K | 164 MB | 15.80 s | 0.43 s | 36.9× |
+| CopilotKit | 17K | 902 MB | 82.89 s | 3.44 s | 24.1× |
+
+See [performance-comparison.md](../docs/performance-comparison.md) for full methodology and raw data.
 
 ## Install
 
 ### npm (recommended)
 
 ```bash
+# installs both jscpd and cpd commands
+npm install -g jscpd
+
+# installs only the cpd command
 npm install -g cpd
 ```
 
-Prebuilt binaries for 6 platforms — no Node.js runtime required:
-
-| Package | OS | Arch | libc |
-|---------|----|------|------|
-| `cpd-darwin-arm64` | macOS | arm64 | — |
-| `cpd-darwin-x64` | macOS | x64 | — |
-| `cpd-linux-arm64-gnu` | Linux | arm64 | glibc |
-| `cpd-linux-x64-gnu` | Linux | x64 | glibc |
-| `cpd-linux-x64-musl` | Linux | x64 | musl |
-| `cpd-windows-x64-msvc` | Windows | x64 | — |
+Prebuilt binaries for 6 platforms — no Node.js runtime required.
 
 ### crates.io
 
@@ -34,135 +34,45 @@ Prebuilt binaries for 6 platforms — no Node.js runtime required:
 cargo install jscpd
 ```
 
+Installs both `jscpd` and `cpd` binaries.
+
 ### From source
 
 ```bash
 git clone https://github.com/kucherenko/jscpd.git
 cd jscpd/rust
 cargo build --release
-# binary at target/release/cpd
+# binaries at target/release/jscpd and target/release/cpd
 ```
 
 ## Quick Start
 
 ```bash
-# Scan current directory (defaults: min-tokens 50, min-lines 5)
 cpd .
-
-# Scan specific paths
 cpd ./src ./lib
-
-# Git blame with side-by-side author comparison
 cpd . --blame --reporters console-full
-
-# Output to JSON + HTML
 cpd . --reporters json,html
-
-# Fail CI if duplication exceeds threshold
-cpd . --threshold 10 --exit-code
-
-# List all 225+ supported formats
+cpd . --threshold 10
 cpd --list
 ```
 
-## Options
-
-| Flag | Short | Default | Description |
-|------|-------|---------|-------------|
-| `--min-tokens` | `-k` | 50 | Minimum tokens to consider a duplicate |
-| `--min-lines` | `-l` | 5 | Minimum lines to consider a duplicate |
-| `--max-lines` | `-x` | — | Maximum lines per duplicate block |
-| `--mode` | `-m` | mild | Detection mode: `mild`, `weak`, `strict` |
-| `--skip-comments` | — | — | Alias for `--mode weak` |
-| `--format` | `-f` | all | Comma-separated formats to check |
-| `--ignore-pattern` | `-i` | — | Glob patterns to ignore |
-| `--reporters` | `-r` | console | comma-separated reporters |
-| `--output` | `-o` | report | Output directory for file reporters |
-| `--config` | `-c` | — | Path to config file (`.jscpd.json`) |
-| `--exit-code` | — | — | Exit non-zero if duplicates found |
-| `--threshold` | `-t` | — | Max duplication % before exit 1 |
-| `--blame` | `-b` | — | Enrich clones with git blame data |
-| `--no-gitignore` | — | — | Ignore `.gitignore` files |
-| `--follow-symlinks` | — | — | Follow symbolic links |
-| `--max-size` | `-z` | 512 KB | Skip files larger than N bytes |
-| `--workers` | — | auto | Number of worker threads |
-| `--no-colors` | — | — | Disable ANSI color output |
-| `--skip-local` | — | — | Skip clones within the same directory |
-| `--silent` | `-s` | — | Suppress console output |
-| `--no-tips` | — | — | Suppress tips and promotional messages |
-| `--list` | — | — | List all supported formats and exit |
-
-## Reporters
-
-13 built-in reporters:
-
-| Reporter | Output |
-|----------|--------|
-| `console` | Clone list + statistics table (default) |
-| `console-full` | Source snippets + optional blame comparison |
-| `json` | `report/cpd.json` |
-| `xml` | `report/cpd.xml` |
-| `csv` | `report/cpd.csv` |
-| `html` | `report/cpd.html` |
-| `markdown` | `report/cpd.md` |
-| `badge` | `report/cpd-badge.svg` |
-| `sarif` | `report/cpd.sarif.json` (GitHub Code Scanning) |
-| `ai` | Token-efficient output for LLM pipelines |
-| `xcode` | Xcode-compatible warnings |
-| `threshold` | Exit 1 if duplication % exceeds `--threshold` |
-| `silent` | No console output |
-
-Combine reporters: `--reporters console,json,html`
-
-## Git Blame
-
-```bash
-cpd . --blame --reporters console-full
-```
-
-Produces a side-by-side author comparison:
-
-```
-176 │ Andrii Kucherenko │ <= │ 196 │ Josh Soref │ ## TODO
-177 │ Andrii Kucherenko │ <= │ 197 │ Josh Soref │
-180 │ Andrii Kucherenko │ == │ 200 │ Andrii Kucherenko │ ## License
-```
+## Architecture
 
-`==` = same author (original). `<=` = different author (potential copy).
-
-## Config File
-
-Create `.jscpd.json` in your project root:
-
-```json
-{
-  "minTokens": 30,
-  "minLines": 3,
-  "format": ["javascript", "typescript", "python"],
-  "ignorePattern": ["node_modules", "dist", "*.min.js"],
-  "reporters": ["console", "json"],
-  "output": "report",
-  "threshold": 5,
-  "blame": false,
-  "noGitignore": false,
-  "noColors": false,
-  "silent": false
-}
 ```
-
-## Cross-Format Detection
-
-Vue SFC (`.vue`), Svelte (`.svelte`), Astro (`.astro`), and Markdown files are tokenized per-block, enabling duplicate detection across file types:
-
+jscpd/cpd (CLI binary)
+ ├── cpd-core      — Detection algorithm (Rabin-Karp rolling hash)
+ ├── cpd-tokenizer — Language tokenization (223 formats)
+ ├── cpd-finder    — File walking, orchestration, git blame
+ └── cpd-reporter  — Output formatting (13 reporters)
 ```
-Clone found (javascript)
- - app.vue:javascript [10:1 - 35:2] (25 lines, 180 tokens)
-   utils.js [40:1 - 65:2]
 
-Clone found (yaml)
- - docker-compose.yml:yaml [7:1 - 25:33] (18 lines, 36 tokens)
-   config.yml:yaml [7:1 - 25:37]
-```
+| Crate | Version | Purpose |
+|-------|---------|---------|
+| `cpd-core` | [0.1.3](https://crates.io/crates/cpd-core) | Detection algorithm, rolling hash, models |
+| `cpd-tokenizer` | [0.1.3](https://crates.io/crates/cpd-tokenizer) | Language tokenization (223 formats) |
+| `cpd-finder` | [0.1.4](https://crates.io/crates/cpd-finder) | File walking, orchestration, git blame |
+| `cpd-reporter` | [0.1.4](https://crates.io/crates/cpd-reporter) | Output formatting (13 reporters) |
+| `jscpd` | [5.0.4](https://crates.io/crates/jscpd) | CLI binary and entry point |
 
 ## Programmatic Usage (Rust)
 
@@ -180,54 +90,31 @@ println!("Found {} clones", result.clones.len());
 println!("Analyzed {} files", result.statistics.total.sources);
 ```
 
-## Architecture
+## Building
 
+Requires Rust 1.87+ (see `rust-toolchain.toml`).
+
+```bash
+cargo build --release
+cargo test
 ```
-jscpd (binary)
- ├── cpd-core      — Detection algorithm (Rabin-Karp rolling hash)
- ├── cpd-tokenizer — Language tokenization (225+ formats)
- ├── cpd-finder    — File walking, orchestration, git blame
- └── cpd-reporter  — Output formatting (13 reporters)
-```
 
-| Crate | crates.io | Purpose |
-|-------|-----------|---------|
-| `cpd-core` | [0.1.1](https://crates.io/crates/cpd-core) | Detection algorithm, rolling hash, models |
-| `cpd-tokenizer` | [0.1.1](https://crates.io/crates/cpd-tokenizer) | Language tokenization (225+ formats) |
-| `cpd-finder` | [0.1.2](https://crates.io/crates/cpd-finder) | File walking, orchestration, git blame |
-| `cpd-reporter` | [0.1.2](https://crates.io/crates/cpd-reporter) | Output formatting (13 reporters) |
-| `jscpd` | [5.0.2](https://crates.io/crates/jscpd) | CLI binary and entry point |
+## Documentation
+
+- **[docs/rust.md](../docs/rust.md)** — Full CLI reference, all options, reporters, config file, differences from v4
+- **[docs/typescript.md](../docs/typescript.md)** — TypeScript/Node.js engine (v4.x) documentation
+- **[docs/ai-ready.md](../docs/ai-ready.md)** — AI reporter, agent skills, MCP server
+- **[docs/api.md](../docs/api.md)** — Programming APIs (TypeScript and Rust)
 
 ## Known Differences from jscpd v4
 
 | Feature | jscpd v4 (Node.js) | cpd v5 (Rust) |
 |---------|--------------------|-----------------|
-| `--blame` in `console-full` | Per-line side-by-side author comparison | Same — `==` / `<=` markers |
-| `--store` (LevelDB) | Persistent store for large repos | Not supported. Use jscpd v4.x |
-| `--formatsExts` | Custom format-to-extension mapping | Not supported. Use `--format` |
-| Programming API | `jscpd()` Promise API, `detectClones()` | Rust crate API; no Node.js API |
-| Config file | `.jscpd.json` with camelCase keys | Same |
-| Cross-format detection | Vue, Svelte, Astro, Markdown | Same — per-block tokenization |
-| Token counts | May differ slightly | May differ by 1–2%; clone detection matches |
-| `--reporters` | All v4 reporters | All v4 reporters except `full` (use `console-full`) |
+| `--store` (LevelDB) | Persistent store for large repos | Not supported |
+| Programming API | `jscpd()` Promise, `detectClones()` | Rust crate API; no Node.js API |
+| `--reporters` | All v4 reporters | All except `full` (use `console-full`) |
 
-## Building
-
-### Prerequisites
-
-- Rust 1.87+ (see `rust-toolchain.toml`)
-
-### Build
-
-```bash
-cargo build --release
-```
-
-### Run Tests
-
-```bash
-cargo test
-```
+See [docs/rust.md](../docs/rust.md) for the full differences table.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cpd",
-  "version": "5.0.4",
+  "version": "5.0.5",
   "description": "Copy/paste detector — fast Rust-based CLI for code duplication detection",
   "bin": {
     "cpd": "./run-cpd.js"
@@ -10,12 +10,12 @@
     "platform-map.js"
   ],
   "optionalDependencies": {
-    "cpd-linux-x64-gnu": "5.0.4",
-    "cpd-linux-arm64-gnu": "5.0.4",
-    "cpd-linux-x64-musl": "5.0.4",
-    "cpd-darwin-arm64": "5.0.4",
-    "cpd-darwin-x64": "5.0.4",
-    "cpd-windows-x64-msvc": "5.0.4"
+    "cpd-linux-x64-gnu": "5.0.5",
+    "cpd-linux-arm64-gnu": "5.0.5",
+    "cpd-linux-x64-musl": "5.0.5",
+    "cpd-darwin-arm64": "5.0.5",
+    "cpd-darwin-x64": "5.0.5",
+    "cpd-windows-x64-msvc": "5.0.5"
   },
   "repository": {
     "type": "git",