diff --git a/CHANGELOG.md b/CHANGELOG.md index b6f7b68..233d342 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,8 @@ All notable changes to John Slop are recorded here. The format follows attached diagnostic bodies, and spacing between complete findings. - Expanded the expected-failure diagnostic showcase to include prose and source rules plus the complete embedded replacement-character set. +- Documented Cargo's required `--path .` syntax when installing all binaries + from a local source checkout. - Adopted the measured three-package Cargo workspace. Shared package metadata, dependency requirements, and lint policy now use workspace inheritance while the reusable core remains isolated from CLI, async, and LSP dependencies. diff --git a/README.md b/README.md index 77e9815..4b59907 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,22 @@ findings and versioned quick fixes in editors without writing files. Rust 1.98.1 or newer is required. +Install directly from the upstream Git repository: + ```sh cargo install --git https://git.dandaedre.com/idle-org/john_slop \ --locked --all-features +``` +When you already have a local checkout, Cargo requires its path explicitly: + +```sh +cargo install --path . --locked --all-features +``` + +For development without installing, run the binaries through Cargo: + +```sh cargo run --bin john-slop -- path/to/document path/to/source-directory cargo run --bin john-slop-fmt -- path/to/document cargo run --bin john-slop-fmt -- --check path/to/document diff --git a/docs/development.md b/docs/development.md index 0617152..7d550f2 100644 --- a/docs/development.md +++ b/docs/development.md @@ -29,6 +29,17 @@ manifest inheritance, and feature isolation. Before a release, assemble every publishable crate with `scripts/package-workspace.sh --no-verify`; see the [release procedure](releasing.md) for the registry verification boundary. +To smoke-test installation from the current source checkout, identify the local +package explicitly (recent Cargo versions no longer infer it from an omitted +package argument): + +```sh +cargo install --path . --locked --all-features +``` + +Use `--root ` when verifying this command without changing +the normal Cargo installation root. + The default `fancy-diagnostics` feature enables the detector's colored Miette renderer and default output mode. The default `lsp` feature exposes the compatibility facade's protocol module and builds the LSP binary. The diff --git a/tasks.md b/tasks.md index 9e71e5f..2c5754e 100644 --- a/tasks.md +++ b/tasks.md @@ -411,7 +411,7 @@ and Tarpaulin passed; coverage remains 92.23% (1,342/1,455 lines). ## Milestone 16 — Source-checkout installation -- [ ] Document Cargo's explicit `--path .` form for installation from a local +- [x] Document Cargo's explicit `--path .` form for installation from a local checkout, keep the remote Git installation form distinct, and smoke-test the local command in an isolated installation root. @@ -420,6 +420,10 @@ installing the upstream Git repository; the documented local command installs all three binaries with the locked, all-feature dependency graph on supported Rust; documentation checks remain clean. +Accepted on 2026-09-29 after the documented local command installed +`john-slop`, `john-slop-fmt`, and `john-slop-lsp` into an isolated root with the +locked all-feature graph. Formatting and all-feature rustdoc also passed. + ## Deferred by design - Statistical or model-based authorship classification.