Enables the README stage at error

.quality.exs

@@ -4,8 +4,8 @@
 #
 #   mix quality                 - full gate: format, compile, credo --strict,
 #                                 dialyzer, dependency audit, docs, doc links,
-#                                 full suite with coverage. Required green
-#                                 before every commit.
+#                                 README shape, full suite with coverage.
+#                                 Required green before every commit.
 #
 #   mix quality --profile loop  - inner loop while implementing: skips dialyzer
 #                                 and coverage, runs only the tests covering
@@ -45,6 +45,15 @@
     enabled: :auto
   ],
 
+  # The README stage checks the README keeps the shape of an introduction and
+  # a map: what, why, install, one basic-usage snippet, and the links grouped
+  # by the reader's question. Findings fail the gate. The line ceiling comes
+  # from `readme_max_lines` in `.claude/diataxis.md`.
+  readme: [
+    enabled: :auto,
+    severity: :error
+  ],
+
   profiles: [
     loop: [
       stages: [:format, :compile, :credo, :test],

CLAUDE.md

@@ -361,7 +361,7 @@ required, this file wins.
 
 The full reference is **`deps/ex_quality/usage-rules.md`**, vendored with the
 dependency, so it is the version of the tool this repo actually runs
-(`{:ex_quality, "~> 0.15"}`). Read it when a stage fails in a way its own
+(`{:ex_quality, "~> 0.16"}`). Read it when a stage fails in a way its own
 output does not explain, or when you need the shape of the JSON report. Fetch
 it with `mix deps.get` if `deps/` is cold; do not go looking for the rules on
 the web instead.

README.md

@@ -78,7 +78,7 @@ process's state or in a database column until the next loan comes back.
   - [Nested data access](docs/guides/nested-data-access.md): dot and bracket notation over deep contexts.
   - [Location expressions](docs/guides/location-expressions.md): the targets an assignment may write, and how they resolve.
   - [The simple subset](docs/guides/simple-subset.md): a rule as field, operator and value rows, for a form-based editor.
-  - [AST reference](https://github.com/riddler/predicator-ex/blob/main/docs/reference/ast.md): the tree `Predicator.parse/2` returns, node by node.
+  - [AST reference](docs/reference/ast.md): the tree `Predicator.parse/2` returns, node by node.
   - [ISA reference](docs/isa.md): the instruction set's opcodes, stack effects, error semantics and versions.
   - [API reference](https://hexdocs.pm/predicator/api-reference.html): every public module and function.
   - [The changelog](CHANGELOG.md): what changed in each version.

mix.exs

@@ -12,7 +12,7 @@ defmodule Predicator.MixProject do
     {:ex_doc, "~> 0.40", only: :dev, runtime: false},
     {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
     {:excoveralls, "~> 0.18", only: :test},
-    {:ex_quality, "~> 0.15", only: :dev, runtime: false},
+    {:ex_quality, "~> 0.16", only: :dev, runtime: false},
     {:benchee, "~> 1.3", only: :dev, runtime: false}
   ]
 
@@ -84,6 +84,7 @@ defmodule Predicator.MixProject do
       files: ~w(
         lib/predicator* mix.exs README.md LICENSE CHANGELOG.md
         docs/reference/language.md
+        docs/reference/ast.md
         docs/isa.md
         docs/guides/nested-data-access.md
         docs/guides/custom-functions.md

mix.lock

@@ -8,7 +8,7 @@
   "earmark_parser": {:hex, :earmark_parser, "1.4.46", "67607a0532e810c6f630a515c548d0b24949643f168cc556303bee4cf96105c7", [:mix], [], "hexpm", "9c44636e8a1c68c62f526b2dcd85d941dbbcee7ab82cf64ba06ce28bef8e89f5"},
   "erlex": {:hex, :erlex, "0.2.7", "810e8725f96ab74d17aac676e748627a07bc87eb950d2b83acd29dc047a30595", [:mix], [], "hexpm", "3ed95f79d1a844c3f6bf0cea61e0d5612a42ce56da9c03f01df538685365efb0"},
   "ex_doc": {:hex, :ex_doc, "0.40.3", "4a972ffe64bc07dc605af487e98fc19b72a4185f55ca031b94c0552d6071c1d9", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "2756e357742fecd9749b489b85d67c9ce99c465f2e75728d9e6dc8d704b973de"},
-  "ex_quality": {:hex, :ex_quality, "0.15.1", "238c222406693e483ff56a56fc602146e297f30b4abae7cd5db49f76e402c8e6", [:mix], [{:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "1d59cd18f14f7849bcefc991717992a35b6bcc4c1bea5165198719db770cfdde"},
+  "ex_quality": {:hex, :ex_quality, "0.16.0", "1e3a0431d97cdd76d59e103194296f5e146c237cabfad5d3e51e5b88ce6eb868", [:mix], [{:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "51e7295c4e6c790a666638d88ba9ff20d668b83d0b508b19e4edcae79a4a0451"},
   "excoveralls": {:hex, :excoveralls, "0.18.5", "e229d0a65982613332ec30f07940038fe451a2e5b29bce2a5022165f0c9b157e", [:mix], [{:castore, "~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "523fe8a15603f86d64852aab2abe8ddbd78e68579c8525ae765facc5eae01562"},
   "file_system": {:hex, :file_system, "1.1.0", "08d232062284546c6c34426997dd7ef6ec9f8bbd090eb91780283c9016840e8f", [:mix], [], "hexpm", "bfcf81244f416871f2a2e15c1b515287faa5db9c6bcf290222206d120b3d43f6"},
   "jason": {:hex, :jason, "1.4.5", "2e3a008590b0b8d7388c20293e9dcc9cf3e5d642fd2a114e4cbbb52e595d940a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0 or ~> 3.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "b0c823996102bcd0239b3c2444eb00409b72f6a140c1950bc8b457d836b30684"},