PdfCraft: An open-source PDF reader and editor written by scratch in pure Rust
Enforce workspace Clippy standards and document lint policy
Dylan M. Taylord95ff3898d6c
diff --git a/CLAUDE.md b/CLAUDE.mdindex f51a96d56..a37cec4ca 100644--- a/CLAUDE.md+++ b/CLAUDE.md@@ -39,6 +39,7 @@ PdfCraft is a clean-room, open-source, Rust-native PDF application targeting Ado- **Rebasing is a review step, not a mechanical one.** Read every hunk you resolve, and the auto-merged hunks in the files you touched too — `main` moves fast enough that a file can change by hundreds of lines under a branch.- **External PRs are held to safety, security and completeness before style.** Provenance first (no Adobe-derived asset, no committed font, no copied GPL/AGPL code, behaviour from the spec and not from reading another implementation), then no new panic path or `unsafe`, then `--root` confinement on every path including ones reached by nested dispatch, opt-in-only MCP and control channel, no new outbound network, then a headless `automation` tool, tests at the right zoom and an honest `parity/` entry. Provenance is the part a contributor cannot be expected to know, and the only part that cannot be undone after merge.- **Quality gates** before every commit: `cargo fmt --check`, clippy with `-D warnings`, the tests, `cargo xtask layers`, `cargo xtask assets`, and the wasm check once `xtask ci` exists (M0).+ - New workspace crates must include `[lints] workspace = true` in `Cargo.toml` to inherit `[workspace.lints]`. Production crate roots must declare the required crate-level lint attributes before modules or other crate items; crate-level `//!` documentation may precede them.- **Scope builds and tests to the crates you touched** — `cargo clippy -p <crate> -j 2 --all-targets` and `cargo test -p <crate> -j 2`, under a `timeout`. A full `--workspace` build has locked up a development machine's CPU; it is CI's job and CI runs it on every PR. Run the workspace sweep locally only when you have a reason to and the machine is free.- **Check for existing work before starting a fix or feature.** Search the issues and PRs, open and closed, with `gh issue list -R storytold/pdfcraft --state all --search "<terms>"` and the same with `gh pr list` (try a few phrasings), and check whether a merged fix is already on `main` (`git merge-base --is-ancestor <commit> origin/main`). If one is, the report is likely from an older build: say so rather than fixing it again. If an open PR covers it, review or build on that PR instead of opening a competing one. If an issue exists, reference it in the PR (`Fixes #123`).- **Commits and PRs:** `main` is the only integration branch and is **never pushed to directly**. Branch from an up-to-date `main` as `<type>/<slug>` (`feat/`, `fix/`, `docs/`, `chore/`, `refactor/`), one task id per commit (e.g. `M1.4: xref stream reader`), commit only green states, and open a PR into `main` using `.github/pull_request_template.md`. Merge only when CI is green.diff --git a/Cargo.toml b/Cargo.tomlindex 99f9fa251..24313021b 100644--- a/Cargo.toml+++ b/Cargo.toml@@ -91,6 +91,9 @@ web-time = "1.1"unsafe_code = "forbid"[workspace.lints.clippy]+cognitive_complexity = "deny"+too_many_arguments = "deny"+wildcard_imports = "deny"dbg_macro = "warn"todo = "warn"diff --git a/clippy.toml b/clippy.tomlindex e908d1358..31e54da30 100644--- a/clippy.toml+++ b/clippy.toml@@ -13,6 +13,7 @@ disallowed-methods = [{ path = "egui::Ui::radio_value", reason = "use radio_value from crates/ui-egui/src/widgets.rs, which is outlined and filled" },{ path = "egui::RadioButton::new", reason = "use radio from crates/ui-egui/src/widgets.rs, which is outlined and filled" },]+cognitive-complexity-threshold = 30disallowed-types = [{ path = "egui::ComboBox", reason = "use craft_ui::ComboBox: egui's combo box menu can't grow back while open (egui#5225)" },diff --git a/xtask/Cargo.toml b/xtask/Cargo.tomlindex 7a33bad87..028282e07 100644--- a/xtask/Cargo.toml+++ b/xtask/Cargo.toml@@ -5,6 +5,9 @@ edition = "2024"publish = falselicense.workspace = true+[lints]+workspace = true+[dependencies]pdfcraft-oracle = { workspace = true }pdfcraft-cos = { workspace = true }