john-slop/README.md

3.1 KiB

John Slop

version tests test coverage

John Slop is an early-stage, local-first linter for concrete signs of low-effort or insufficiently reviewed text and source code. It reports explainable heuristics for human review; it does not prove AI authorship or identify a model.

Today, the detector reads UTF-8 files, directories, ZIP archives, and common ZIP-based office documents. Eleven conservative, configurable rules cover copied assistant scaffolding, generic style residue, source-code placeholders, tutorial narration, and configured non-ASCII characters. Rules retain exact source spans, apply path/content scopes, and feed a bounded, explainable confidence score. The detector renders plain or graphical Miette diagnostics, concise records, or versioned JSON Lines. The formatter applies only configured Unicode-to-ASCII replacements, supports check/diff modes, and requires explicit opt-in for atomic file writes. The stdio LSP publishes those same replacement findings and versioned quick fixes in editors without writing files.

Quick start

Rust 1.98.1 or newer is required.

cargo run --bin john-slop -- path/to/document path/to/source-directory
cargo run --bin john-slop -- --output miette path/to/document
cargo run --bin john-slop-fmt -- path/to/document
cargo run --bin john-slop-fmt -- --check path/to/document
cargo run --bin john-slop-lsp

Use --fail-confidence 0..100 to make the detector exit with status 1 when a document reaches a chosen evidence threshold. Confidence measures configured signals, not the probability that AI wrote the content.

Formatter file mode prints transformed text without modifying the source. Use --write explicitly for atomic in-place replacement, or pipe editor buffers through john-slop-fmt over stdin/stdout.

Editors start john-slop-lsp over stdio. It tracks open snapshots with full document synchronization, reports configured ASCII replacements, and offers quick fixes whose result matches the formatter. See the editor guide for Helix and Vim setup.

Documentation

The ordered implementation plan lives in tasks.md, and contribution rules live in AGENTS.md.

John Slop is distributed under the MIT license.