Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Trim the ratchets section of CLAUDE.md (#85498)

Chris Truterec144950c666
diff --git a/CLAUDE.md b/CLAUDE.md
index eebe10b2e6d..215a473852a 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -129,39 +129,19 @@ is added.
After changing Clojure suppressions or module-boundary escape hatches, run `./bin/mage kondo-ratchets`.
Fix the underlying issue when possible; suppressions are a last resort and need a nearby explanation.
-Inline-ignore budgets (`:ignore-counts`) are split by prod/test so one side's suppressions can never mask
-or look equivalent to the other's: `.clj-kondo/ratchets.edn` covers production code, and
-`.clj-kondo/ratchets-test.edn` covers anything under a `test` directory. `:config-counts`
-(`.clj-kondo/config.edn` suppressions) stays combined in `.clj-kondo/ratchets.edn` regardless -- see that
-file's own header for why. `.clj-kondo/config/modules/ratchets.edn` (module-boundary escape hatches) is a
-separate, unsplit concern.
+Inline-ignore budgets live in `.clj-kondo/ratchets.edn` for production code and `.clj-kondo/ratchets-test.edn`
+for anything under a `test` directory. Module-boundary escape hatches live in
+`.clj-kondo/config/modules/ratchets.edn`.
Explain budget increases in the PR. Do not record reductions in feature PRs: post-merge automation opens
a `Tighten ratchets` PR for them. Use `./bin/mage kondo-ratchets-shrink --seed :linter` only when adding an
inline-ignore budget. If any ratchet file conflicts, run `./bin/merge-kondo-ratchets`.
-`.clj-kondo/config/modules/cycle-clusters.edn` names each cyclic cluster (strongly connected component) of the module
-require graph by an anchor module: the cluster holding the anchor carries the name, and its members are computed,
-so a named cluster can grow and shrink without an edit. The big one is `galactic-center`. Names follow a space
-theme; the `name-module-cycle` skill helps pick one.
-
-The test `metabase.core.module-cycles-test` fails until every cluster holds exactly one anchor. When you split a
-cluster, name the new half: the failure proposes a name and anchor to add. When two named clusters merge, find
-another way; the failure shows the requires joining them. When an anchor leaves every cycle, anchor its name on
-another member if the cluster survives, or remove the line.
-
-Ignores for `:discouraged-var` and `:discouraged-namespace` are budgeted per symbol, not per linter, in both
-files. Use `--seed :discouraged-var/clojure.core/println` to seed one symbol's budget, or a bare
-`--seed :discouraged-var` (or `:discouraged-namespace`) to seed every symbol configured under that linter.
-To learn which symbol an ignore covers, `./bin/mage kondo-ratchets` runs `clojure -M:kondo` over the files
-carrying one, so it needs the Clojure CLI as well as Babashka.
-
-`./bin/mage kondo-ratchets-history` reports which commits shrank, grew and introduced budgets, from the history of the
-ratchet files. It takes `--days N` (7 by default), `--all`, or a commit to start after, and `--html FILE` writes a page
-of every week and month. A shrink is credited to the commits that removed the suppressions, not to the automation that
-lowered the number. It warns about any raise larger than the suppressions its commit added. Settle one with `--pardon`,
-`--confirm` or `--recount`, each taking a commit or PR number and a `--why`; the verdicts are kept in
-`mage/resources/kondo-ratchets-verdicts.edn`.
+`metabase.core.module-cycles-test` checks that each cyclic cluster of the module require graph has exactly one
+name in `.clj-kondo/config/modules/cycle-clusters.edn`. When it fails, its message says what to change.
+
+`./bin/mage kondo-ratchets` needs the Clojure CLI as well as Babashka. Each ratchet task's `--help` lists its
+options, and `./bin/mage kondo-ratchets-history` reports which commits shrank and grew the budgets.
## Tool Preferences