john-slop/README.md

42 lines
1.6 KiB
Markdown

# John Slop
John Slop is an early-stage, local-first heuristic linter for concrete signals
of low-effort or insufficiently reviewed text and source code. It is intended to
highlight evidence for human review, not to prove that content was written by AI
or assign an authorship probability.
## Current prototype
The repository currently contains proof-of-concept code that:
- reads UTF-8 text from a file or recursively from a directory;
- reads text entries from ZIP-based files, including `.zip`, `.docx`, `.xlsx`,
and `.pptx`;
- rejects missing paths and invalid UTF-8 with a diagnostic error;
- detects a configured-in-code set of hyphen-like Unicode characters; and
- demonstrates source-labelled terminal diagnostics with `miette`.
The implementation is being restructured into a reusable library plus detector,
formatter, and LSP binaries. See [tasks.md](tasks.md) for the ordered backlog and
[AGENTS.md](AGENTS.md) for the design and contribution rules.
## Development
Run the current test and quality suite with:
```sh
cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test --all-targets --all-features
cargo doc --no-deps
```
Behavior is intentionally captured with regression tests before the refactor so
that later changes are deliberate and reviewable.
## Background reading
- [Wikipedia: Signs of AI writing](https://en.wikipedia.org/wiki/Wikipedia%3ASigns_of_AI_writing)
- [Wikipedia: WikiProject AI Cleanup](https://en.wikipedia.org/wiki/Wikipedia:WikiProject_AI_Cleanup)
- [The Verge: Wikipedia editors are battling AI slop](https://www.theverge.com/report/756810/wikipedia-ai-slop-policies-community-speedy-deletion)