john-slop/examples
Dandaedre 2f12c4e186
docs: publish LSP usage guides
2026-09-29 17:14:04 +02:00
..
fixtures test: add shared adapter fixture corpus 2026-09-29 16:32:38 +02:00
README.md docs: publish LSP usage guides 2026-09-29 17:14:04 +02:00
analyze_path.rs docs: add runnable library examples 2026-09-29 16:30:56 +02:00
analyze_text.rs docs: add runnable library examples 2026-09-29 16:30:56 +02:00
plan_replacements.rs docs: publish LSP usage guides 2026-09-29 17:14:04 +02:00

README.md

Runnable Rust examples

These Cargo examples exercise the same library boundaries used by the three John Slop binaries:

cargo run --example analyze_text
cargo run --example analyze_path -- examples/fixtures
cargo run --example plan_replacements
  • analyze_text analyzes an in-memory prose snapshot and prints its explainable findings.
  • analyze_path streams a file, directory, or supported ZIP container. Its optional path defaults to examples/fixtures.
  • plan_replacements prints the exact UTF-8 byte edits shared by the formatter and LSP quick fixes.

These examples use embedded defaults so their behavior does not depend on a developer's user configuration. Applications that want normal configuration layering should call john_slop::load_config() instead.

Shared fixture corpus

fixtures/manifest.toml describes small inputs shared by detector CLI, formatter, and LSP testing. Several directories deliberately contain an example.txt, covering clean prose, copied assistant residue, stock style, and Unicode punctuation. A Rust source example covers source-only rules. Each input has a checked-in expected formatted result.

Exercise the currently implemented boundaries with:

cargo run --bin john-slop -- --output concise examples/fixtures/assistant/example.txt
cargo run --bin john-slop-fmt -- examples/fixtures/typography/example.txt
cargo run --bin john-slop-fmt -- --check examples/fixtures/clean/example.txt
cargo run --example analyze_path -- examples/fixtures
cargo test --test example_fixtures
cargo test --test lsp

The formatter integration test executes every case and compares stdout with its expected ASCII file. The manifest also names lsp as a consumer, and the in-process protocol suite proves that applying LSP edits produces the same bytes as the formatter.