rigortype 0.2.9 → 0.3.1

data/docs/handbook/08-understanding-errors.md

@@ -1,9 +1,16 @@
 # Understanding errors
 
-This chapter is the catalogue of diagnostics Rigor ships, the
-families they belong to, and how to suppress one when it is
-wrong (or move its severity around). It is the page to land on
-when a diagnostic surprises you, in either direction.
+A diagnostic is Rigor telling you something it proved about
+your code. This chapter is about *reading* one: what its parts
+mean, what each rule family is really claiming, why one fires
+when you did not expect it, why one stays silent when you did,
+and how to work a freshly-adopted project down to a clean run.
+
+The reference lives one door over. The full rule catalogue,
+each rule's evidence tier, the severity-profile table, and the
+exact syntax of every suppression form are in
+[Diagnostics](../manual/04-diagnostics.md) in the manual; this
+chapter links there rather than restating it.
 
 ## Anatomy of a diagnostic
 
@@ -33,250 +40,106 @@ fires, when it doesn't, the suppression token, the authored
 severity, and the per-profile severity. `rigor explain` with
 no argument prints the index of every shipped rule.
 
-### Confidence and reference fields
-
-Two extra fields ride along on every built-in diagnostic, for
-agents and dashboards consuming `rigor check --format json`
-(and on each rule in `rigor explain --format json`):
-
-- **`evidence_tier`** — `high` / `medium` / `low`: Rigor's own
-  confidence that the firing is a true positive, derived from
-  the rule's gates, not its severity. `high` means a concrete,
-  statically-known type with no metaprogramming escape (e.g.
-  `call.undefined-method`); `medium` rests on a flow / inference
-  proof with a documented false-positive envelope (e.g.
-  `flow.always-truthy-condition`); `low` is a resolution- or
-  coverage-gap signal that often means missing context rather
-  than a bug (e.g. `call.unresolved-toplevel`). The tier never
-  feeds severity — that stays the `severity_profile:` decision.
-  Informational helpers (`dump.type`) carry no tier.
-- **`documentation_url`** — a stable link to the rule's entry in
-  the published diagnostics catalogue.
-
-Both are presentation metadata. They never change whether a
-diagnostic fires.
-
-## The rule catalogue
-
-Five families, each with one or more rules:
-
-### `call.*` — call-site rules
-
-Fire when a method call's shape is wrong.
-
-| Rule | Fires when | Default severity |
-| --- | --- | --- |
-| `call.undefined-method` | The receiver class is statically known and the method is not defined on it (RBS or in-source). | error |
-| `call.wrong-arity` | The number of positional arguments does not satisfy any overload's arity. | error |
-| `call.argument-type-mismatch` | An argument's type provably does not satisfy the parameter contract (RBS or `RBS::Extended` `param:`). | error |
-| `call.possible-nil-receiver` | The receiver type is `T \| nil` and the method is not defined on `NilClass`. | error (warning under `lenient`) |
-| `call.unresolved-toplevel` | An implicit-self call at the top level (outside any `def` / `class` / `module`) resolves against no same-file `def`, `pre_eval:` monkey-patch, or `Kernel` / `Object` method — surfacing typos in standalone scripts. | warning under `balanced`, error under `strict`, suppressed under `lenient` |
-
-`call.*` rules are the highest-volume diagnostics on
-real-world code. They are also the most refined — every one
-fires only when Rigor can prove the underlying fact.
-
-### `flow.*` — flow-analysis rules
-
-Fire when the control flow itself is unsound.
-
-| Rule | Fires when | Default severity |
-| --- | --- | --- |
-| `flow.always-raises` | Every reachable evaluation of an expression raises (e.g. `n / 0` where `n: Integer`). | error |
-| `flow.unreachable-branch` | An `if` / `unless` / ternary's predicate is a syntactic literal AND the corresponding dead branch is non-empty. | warning |
-| `flow.always-truthy-condition` | The predicate of an `if` / `unless` / ternary is provably truthy (or falsey) by inferred type, with surgical skips inside loop bodies and on defensive predicate calls. | warning |
-| `flow.unreachable-clause` | A `case <local>; when <Class>` (or bare-class `case`/`in`) clause whose subject narrowing proves it can never match — disjoint from the subject's type, or already exhausted by an earlier clause. | info under `balanced`, warning under `strict`, info under `lenient` |
-| `flow.dead-assignment` | A plain local-variable write whose target name is never read in the same `def` body. | warning |
-
-`flow.unreachable-branch`, `flow.always-truthy-condition`, and
-`flow.unreachable-clause` are the **reachability family** — each
-proves a branch or `case` clause is dead. `unreachable-clause`
-is the newest member: it watches `case <local>; when <Class>`
-(and bare-class `case`/`in`) and fires when an earlier clause
-already covered a member's type or the clause is disjoint from
-the subject. It ships at `:info` under `balanced` (one notch
-below its siblings) while its corpus false-positive gate
-finishes; bump it with `severity_overrides:` if you want it
-louder.
-
-### `def.*` — method-definition rules
-
-Fire when the body of a method violates its declared
-contract.
-
-| Rule | Fires when | Default severity |
-| --- | --- | --- |
-| `def.return-type-mismatch` | The body's last expression's inferred type cannot satisfy the RBS-declared return type. Honors `%a{rigor:v1:return: <refinement>}` overrides. | warning under `balanced` profile, error under `strict` |
-| `def.ivar-write-mismatch` | A later `@var = ...` write's concrete class disagrees with the first write's class in the same class body (NilClass-to-clear is allowlisted). | warning under `balanced` profile, error under `strict` |
-| `def.method-visibility-mismatch` | An explicit-receiver call targets a `Nominal[X]` whose discovered method is `:private` in the surrounding class body. | error |
-| `def.override-visibility-reduced` | An override reduces the visibility it inherits from a project-defined ancestor (public → protected/private, protected → private), breaking a caller that holds the supertype. | warning under `balanced`, error under `strict`, suppressed under `lenient` |
-| `def.override-return-widened` | An override's declared return widens the inherited return (covariance). Fires only on a proven violation when both sides carry an authored RBS signature. | warning under `balanced`, error under `strict`, suppressed under `lenient` |
-| `def.override-param-narrowed` | An override narrows an inherited parameter type (contravariance), comparing matching positional parameters. Requires an authored single-overload RBS signature on both sides. | warning under `balanced`, error under `strict`, suppressed under `lenient` |
-
-The three `def.override-*` rules are the Liskov Substitution
-Principle signature rule applied across a project-defined
-class/module hierarchy (superclass chain + included/prepended
-modules, resolved cross-file). They are the conceptual subject of
+### Confidence — reading the evidence tier
+
+Every built-in diagnostic carries an `evidence_tier` —
+`high` / `medium` / `low` — which is Rigor's own confidence
+that the firing is a *true positive*, derived from the rule's
+gates rather than from its severity. It is worth internalising
+as a reading habit rather than a config knob: a `high` firing
+(`call.undefined-method` on a concrete receiver) is almost
+always a real bug and can be acted on directly, while a `low`
+one (`call.unresolved-toplevel`) usually means the analyzer is
+missing context — an unanalyzed file, a monkey-patch it never
+saw — and reads better as "look at this" than "fix this". The
+tier never feeds severity, and never changes whether a
+diagnostic fires; it only routes your attention.
+
+The per-rule tiers, and the `documentation_url` field that
+rides alongside them in `--format json`, are in
+[manual — Evidence tier](../manual/04-diagnostics.md#evidence-tier).
+
+## The five families
+
+Every rule ID reads `family.rule`, and the family tells you
+what kind of proof failed. The catalogue — every rule, what it
+fires on, its evidence tier — is in
+[manual — Diagnostics](../manual/04-diagnostics.md#catalogue).
+What follows is what each family is *about*.
+
+**`call.*` — the call site's shape is wrong.** An undefined
+method, an arity no signature accepts, an argument whose type
+provably violates the parameter contract, a receiver that
+might be `nil`. These are the highest-volume diagnostics on
+real-world code, and also the most refined: every one of them
+fires only when Rigor can prove the underlying fact about a
+statically-known receiver, which is why a `call.*` firing is
+usually worth reading first.
+
+**`flow.*` — the control flow itself is unsound.** Something
+provably raises on every path, a branch is dead, a `case`
+clause can never match, a local is written and never read, a
+Hash literal repeats a key. `flow.unreachable-branch`,
+`flow.always-truthy-condition` and `flow.unreachable-clause`
+form the **reachability family** — each proves that a piece of
+code cannot run. `unreachable-clause` is the newest member and
+deliberately quieter than its siblings (`:info` under
+`balanced`) while its corpus false-positive gate finishes;
+bump it with `severity_overrides:` if you want it louder.
+
+**`def.*` — a definition violates the contract it declares.**
+A body whose return drifts from the declared RBS return, an
+instance variable written with two disagreeing types, an
+explicit-receiver call into a private method. The three
+`def.override-*` rules are the Liskov Substitution Principle's
+signature rule applied across a project-defined hierarchy
+(superclass chain plus included and prepended modules, resolved
+cross-file): returns may narrow, parameters may widen,
+visibility may not shrink. They are the conceptual subject of
 [appendix: Liskov substitution](appendix-liskov.md).
 
-### `assert.*` — runtime assertion rules
-
-| Rule | Fires when | Default severity |
-| --- | --- | --- |
-| `assert.type-mismatch` | An `assert_type("expected", value)` call's actual inferred type does not match the expected string. | error |
-
-### `dump.*` — debug helpers
-
-| Rule | Fires when | Default severity |
-| --- | --- | --- |
-| `dump.type` | `dump_type(value)` was called — emits an info diagnostic naming the inferred type. | info |
-
-`dump_type` is your introspection probe during debugging:
-sprinkle it through suspicious code, run `rigor check`, read
-the inferred types from the diagnostic stream.
-
-## Severity profiles
-
-Rigor ships three named severity profiles that re-stamp the
-shipped severities:
-
-| Profile | Behaviour |
-| --- | --- |
-| `lenient` | Only proven rules stay `error` (`call.undefined-method`, `wrong-arity`, `assert.type-mismatch`); uncertain rules drop to `warning`, and several to `off`. For incremental adoption on legacy code. |
-| `balanced` (default) | Most rules → `error`; uncertain rules → `warning`; `dump.type` → `info`. The shipped behaviour. |
-| `strict` | Nearly every rule → `error`. The exceptions: `call.self-undefined-method` stays `off` (opt-in only), and `flow.unreachable-clause` is `warning` (pending its false-positive gate). Suitable for new projects with no legacy noise. |
-
-Set in `.rigor.yml`:
-
-```yaml
-severity_profile: strict
-```
-
-## Per-rule overrides
-
-Override a single rule's severity:
-
-```yaml
-severity_overrides:
-  call.argument-type-mismatch: warning
-  def.return-type-mismatch: off
-```
-
-`off` drops the diagnostic from the result entirely — useful
-when you want a profile-wide setting for most rules but
-silence one specifically.
-
-Family wildcards work in overrides too:
-
-```yaml
-severity_overrides:
-  call: warning   # demote every call.* rule
-  dump: off       # drop every dump.* rule
-```
-
-Per-rule entries beat family-wildcard entries:
-
-```yaml
-severity_overrides:
-  call: warning                    # every call.* → warning
-  call.undefined-method: error     # except undefined-method, still error
-```
-
-YAML reserves the bareword `off`. If the stripped severity
-seems not to apply, quote it: `"off"`. Same for `on`.
-
-## In-source suppression
-
-```ruby
-"hello".no_such_method  # rigor:disable call.undefined-method
-```
-
-The comment must be on the same line as the diagnostic. Use
-the qualified rule, the family wildcard, or `all`:
-
-```ruby
-"hello".no_such_method   # rigor:disable call
-"hello".no_such_method   # rigor:disable all
-```
-
-For multiline blocks, suppress at every line — Rigor does
-not yet ship a `disable-block` syntax.
-
-### File-scope suppression
-
-When you need to silence a rule everywhere in a file —
-typically a generated file, a fixture, or a vendored snippet
-that triggers a known false positive — drop a single
-`# rigor:disable-file` comment anywhere in the file:
-
-```ruby
-# rigor:disable-file call.undefined-method
-
-# This whole file is generated; the analyzer's call surface
-# is mismatched with the runtime layer for these stubs.
-```
-
-Convention is to put the comment near the top, but Rigor
-scans every comment in the file so any placement works. The
-same token forms apply: qualified rule, family wildcard, or
-`all`. The line-scope `# rigor:disable` form continues to
-work — the two compose, and any project-wide
-`disable: [...]` in `.rigor.yml` also still applies.
-
-## Project-wide suppression
-
-```yaml
-# .rigor.yml
-disable:
-  - call.possible-nil-receiver
-```
-
-Drops the rule project-wide. Heavier hammer than
-`severity_overrides: { call.possible-nil-receiver: off }` —
-both work; the choice is stylistic.
-
-## Baseline diffing for CI
-
-When you adopt Rigor on an existing codebase, you usually
-inherit a long tail of legitimate-but-pre-existing diagnostics
-that nobody is going to fix today. The pragmatic move is to
-**snapshot the current state as a baseline** and then have CI
-fail only on *new* diagnostics introduced by a PR:
-
-```sh
-# Once: capture the current diagnostic surface.
-rigor check --format=json > rigor.baseline.json
-git add rigor.baseline.json
-git commit
-
-# Per PR: compare against the committed baseline.
-rigor diff rigor.baseline.json
-```
-
-`rigor diff` prints `+ NEW` rows for each diagnostic that
-wasn't in the baseline and `- FIXED` rows for each that has
-been resolved since. The exit code is `1` when any new
-diagnostic appears and `0` otherwise — so adding a new
-violation fails CI, but the legacy diagnostics recorded in
-the baseline don't.
-
-When you fix a row in the baseline, regenerate it with the
-same `rigor check --format=json > rigor.baseline.json` so
-the project tightens monotonically over time. The
-`--format=json` form of `rigor diff` itself is also
-available for editor / dashboard integrations.
-
-`rigor diff` is the lightweight, ad-hoc form — a JSON file you
-diff by hand in a CI script. Most projects instead adopt the
-**managed baseline**: `rigor baseline generate` writes a
-`.rigor-baseline.yml`, you point at it with the `baseline:`
-config key, and from then on `rigor check` itself exits clean
-on recorded diagnostics and surfaces only new ones — no
-separate diff step. That is the path the
-[`rigor-project-init` skill](../manual/14-rails-quickstart.md)
-sets up for you; see [Baselines](../manual/06-baseline.md) for
-the full workflow ([ADR-22](../adr/22-baseline-and-project-onboarding.md)
-for the design).
+**`assert.*` and `dump.*` — the introspection helpers.**
+`assert.type-mismatch` fires when an `assert_type("expected",
+value)` call disagrees with the inferred type, so a snippet in
+this handbook is a test of the engine as much as an
+illustration. `dump.type` is not a problem report at all — it
+is your probe during debugging: sprinkle `dump_type(value)`
+through suspicious code, run `rigor check`, and read the
+inferred types straight out of the diagnostic stream.
+
+## Turning a diagnostic down
+
+Rigor gives you five layers, and picking the right one is
+mostly a question of *how much* you want to say:
+
+1. **`severity_profile:`** — the project's overall stance.
+   `lenient` for a legacy codebase you are easing Rigor into,
+   `balanced` for everyday work, `strict` for a project with
+   no legacy noise.
+2. **`severity_overrides:`** — one rule (or one family) at a
+   different severity from the rest of the profile. The right
+   layer when a rule is *useful but not blocking* for you.
+3. **`disable:`** — the rule is off project-wide. Heavier than
+   an override to `off`; both work, and the choice is mostly
+   stylistic.
+4. **`# rigor:disable` / `# rigor:disable-file`** — this line,
+   or this file. The right layer when the analyzer is wrong
+   *here* and right everywhere else. Prefer it to a
+   project-wide switch: it keeps the exception visible next to
+   the code that needed it, and it is the thing you later
+   promote into an `RBS::Extended` directive.
+5. **A [baseline](../manual/06-baseline.md)** — the whole
+   existing backlog, recorded rather than hidden, so new
+   diagnostics still surface. This is the layer to reach for
+   on adoption day, and the one to reach for *instead of*
+   `disable:` when the rule is genuinely finding things you
+   have simply not fixed yet.
+
+The exact syntax of all five — profile table, override
+precedence, the three suppression forms, the baseline file and
+its `rigor baseline` commands — is in
+[manual — Diagnostics](../manual/04-diagnostics.md#severity-profiles)
+and [manual — Baselines](../manual/06-baseline.md).
 
 ## Why a diagnostic might NOT fire when you expected one
 
@@ -356,6 +219,11 @@ The pragmatic loop on a project that just adopted Rigor:
    `# rigor:disable` lines into `RBS::Extended` directives
    so the analyzer learns the real contract.
 
+On a codebase too large for step 2 in one sitting, record the
+existing diagnostics as a
+[baseline](../manual/06-baseline.md) first and run the loop
+against what CI newly surfaces.
+
 A clean `rigor check` run is the goal; a green CI badge says
 "every diagnostic that fires is one we accept."
 

data/docs/handbook/09-plugins.md

@@ -9,9 +9,10 @@ It does **not** teach plugin *authoring*. That lives in
 [`examples/`](../../examples/README.md) — six tutorial
 walkthroughs, each spotlighting one extension surface.
 Ready-to-install gems for real frameworks live in
-[`plugins/`](../../plugins/README.md). Read on to decide
-whether you need a plugin; go to `examples/` once you want to
-write one, or `plugins/` to install an existing one.
+[`plugins/`](../../plugins/README.md), and activating one is
+[manual — Using plugins](../manual/07-plugins.md). Read on to
+decide whether you need a plugin; go to `examples/` once you
+want to write one.
 
 ## When you reach for a plugin
 
@@ -51,151 +52,60 @@ compares the six worked examples on architectural axes
 engine-collaboration via `Scope#type_of`, cross-plugin facts,
 return-type contributions, …) and recommends a reading order.
 
-## What a plugin can do today
+## Two authoring paths
 
 > Still here? Most readers should jump to
 > [Should you write one?](#should-you-write-one) first — the
 > answer is usually "no, RBS and `RBS::Extended` get you
-> there." The surfaces below are for when it is "yes."
-
-The v0.1.0+ plugin contract — pinned at
-[`docs/internal-spec/plugin.md`](../internal-spec/plugin.md)
-and laid out across a handful of slice specs in the same
-directory — gives a plugin five primary surfaces:
-
-1. **`#diagnostics_for_file(path:, scope:, root:)`** — the
-   per-file emission hook. Walk the parsed AST, return an
-   array of `Rigor::Analysis::Diagnostic` rows. The runner
-   stamps each with `source_family: "plugin.<your-id>"`.
-2. **`dynamic_return(receivers:, methods:, file_methods:)` /
-   `narrowing_facts(methods:)`** — the per-call-site return-type
-   and flow-narrowing contribution surface (ADR-37 Slice 2).
-   A `dynamic_return` block names the inferred return type at a
-   matching call site; the analyzer's dispatcher merges the
-   contribution and uses it as if it were RBS-declared. A
-   `narrowing_facts` block contributes branch-narrowing facts.
-   (`narrowing_facts` was renamed from `type_specifier` in ADR-80;
-   `type_specifier` remains as a deprecating alias removed in 0.3.0,
-   so use `narrowing_facts` in new plugins.)
-   (These replaced the removed `flow_contribution_for` hook —
-   ADR-52 WD3; a plugin that still defines it raises at load.)
-3. **`Plugin::IoBoundary#read_file`** / **`#open_url`** —
-   sandboxed file and (since v0.1.2) HTTPS reads under the
-   active `TrustPolicy`. Use this when the plugin needs to
-   read project files (route tables, schemas, locale files)
-   or fetch a stable URL.
-4. **`Plugin::Base.producer` + `#cache_for`** — plugin-side
-   cache producers. Use these for parses / lookups expensive
-   enough to want cross-run caching. Auto-invalidates on
-   the digest of every file (and content hash of every URL)
-   the IoBoundary read while building the result.
-5. **`Plugin::FactStore` + `#prepare(services)`** — the
-   cross-plugin fact-publication surface (v0.1.1 Track 2,
-   ADR-9). Plugins publish facts in `prepare`; downstream
-   plugins consume them through `services.fact_store` so
-   producer-side parsing (e.g., `config/routes.rb`) can be
-   reused by every consumer (controller-side validators,
-   factory-side validators, …).
-
-Several worked examples (`rigor-lisp-eval`, `rigor-pattern`,
-`rigor-units`, `rigor-activerecord`) contribute a narrowed
-return type via `dynamic_return` rather than only emitting
-diagnostics, so chained calls on plugin-typed values resolve
-through the analyzer's normal dispatch rather than the
-RBS-level `untyped` envelope. See the per-plugin README for
-which surface each one demonstrates.
-
-## Macro / DSL expansion substrate (ADR-16)
-
-A second authoring path was added on top of the hand-rolled
-walker contract above: the **macro expansion substrate**
-(ADR-16). For metaprogramming-heavy DSLs — Rails-style
-`has_one_attached`, dry-struct's `attribute`, Devise's
-`devise :strategy`, Sinatra's `get '/foo' do ... end` — the
-substrate lets a plugin author **declare** the call shape
-instead of walking the AST by hand. The plugin's body becomes
-a single manifest entry; the substrate handles literal-symbol
-extraction, name interpolation, registry lookup, and per-method
-synthesis.
-
-Four tier shapes are recognised. The
-[per-library survey](../notes/20260515-macro-expansion-library-survey.md)
-identifies which libraries fit each tier and which fall
-outside the substrate's scope.
-
-| Tier | Shape | Manifest declaration | Worked example |
-| --- | --- | --- | --- |
-| **A — block-as-method** | DSL call's block runs as an instance method on the receiver class (`Sinatra::Base#generate_method`) | `block_as_methods: [Macro::BlockAsMethod.new(receiver_constraint:, method_names:)]` | [`rigor-sinatra`](../../plugins/rigor-sinatra/) |
-| **B — trait-inlining registry** | Class-level call enumerates symbols → bundled registry maps each to a module → substrate explodes the module's RBS methods onto the calling class | `trait_registries: [Macro::TraitRegistry.new(receiver_constraint:, method_name:, modules_by_symbol:, always_included:)]` | [`rigor-devise`](../../plugins/rigor-devise/) |
-| **C — heredoc template** | Class-level call interpolates a literal symbol into a method-name template; substrate emits synthetic readers | `heredoc_templates: [Macro::HeredocTemplate.new(receiver_constraint:, method_name:, symbol_arg_position:, emit:)]` | [`rigor-dry-struct`](../../plugins/rigor-dry-struct/) |
-
-The three Tier-A/B/C plugins above are each ~60–110 LoC of
-**purely declarative** Ruby — no walker, no
-`diagnostics_for_file`, no plugin-side state. The substrate's
-pre-pass + dispatcher integration do the work.
-
-### Concern re-targeting
-
-`ActiveSupport::Concern.included do ... end` is a *deferred
-class_eval*: any DSL calls inside the block fire on whoever
-includes the concern, not on the concern module itself. The
-substrate's scanner handles this re-targeting automatically.
-For source like:
-
-```ruby
-module Auditable
-  extend ActiveSupport::Concern
-  included do
-    attribute :audited_at, Types::Time
-  end
-end
-
-class Address < Dry::Struct
-  include Auditable
-  attribute :city, Types::String
-end
-```
-
-`Address` gets BOTH `city` (direct) AND `audited_at` (re-targeted
-from `Auditable`) as synthetic readers. The same pattern works
-for Tier B traits (Devise modules included via Concerns).
-
-### Floor / ceiling
-
-Per ADR-16 § WD13, the **floor** is that synthetic methods emit
-by NAME so cross-file dispatch resolves (no more
-`call.undefined-method`). The common cases also recover precise
-return types: **Tier B** redispatches on the origin module's
-authored RBS (a Devise `valid_password?` resolves to `bool`,
-not `Dynamic[T]`), and **Tier C** resolves a plain class-name
-return to its `Nominal`. What still degrades to `Dynamic[T]` is
-the parameterised / utility-type-shaped Tier C return
-(`Array[String]`, `Pick<T, K>`); routing those through the
-[ADR-13](../adr/13-typenode-resolver-plugin.md) resolver chain
-is the **ceiling**, demand-driven. The substrate never
-*fabricates* precision per ADR-5 robustness.
-
-### Choosing between the substrate and a hand-rolled walker
-
-| If the DSL is… | Use the substrate | Use a hand-rolled walker |
-| --- | --- | --- |
-| `class-level call with literal symbol args + framework class_eval'd heredoc` | ✓ Tier C | — |
-| `class-level call with literal symbol args + registry-driven module include` | ✓ Tier B | — |
-| `class-level call with do…end block running as an instance method` | ✓ Tier A | — |
-| `external Ruby files instance_eval'd under a declared self` | ✓ Tier D (contract only as of v0.1.x) | — |
-| `domain DSL whose return type depends on argument shape` | — | `dynamic_return` ([`rigor-lisp-eval`](../../examples/rigor-lisp-eval/)) |
-| `cross-file validation (collect declarations, then validate uses)` | — | Two-pass walker ([`rigor-statesman`](../../plugins/rigor-statesman/)) |
-| `parsing an external project file (routes, schema, locale)` | — | `IoBoundary` + cache producer ([`rigor-routes`](../../examples/rigor-routes/)) |
-| `schema-graph recorder (GraphQL-Ruby-style)` | — | Schema-resolution pass (no plugin authored yet) |
-
-The substrate and the hand-rolled walker contract coexist —
-a plugin can mix `manifest`-declared substrate entries with a
-`diagnostics_for_file` walker. The
-[`skills/rigor-plugin-author/SKILL.md`](../../skills/rigor-plugin-author/SKILL.md)
-SKILL captures the decision flow in detail; the survey at
-[`docs/notes/20260515-macro-expansion-library-survey.md`](../notes/20260515-macro-expansion-library-survey.md)
-records which Ruby libraries the substrate covers and which
-fall outside.
+> there." What follows is for when it is "yes."
+
+The decision that shapes everything else is *which* of the two
+authoring paths your DSL falls into.
+
+**Declare it.** If the DSL is a class-level call with literal
+symbol arguments — a Rails-style `has_one_attached`, a
+dry-struct `attribute`, a Devise `devise :strategy`, a Sinatra
+`get "/foo" do … end` — the **macro-expansion substrate**
+([ADR-16](../adr/16-macro-expansion.md)) already knows that
+shape. You write a manifest entry describing the call, and the
+substrate does the literal-symbol extraction, the name
+interpolation and the per-method synthesis. The three bundled
+plugins on this path are 60–110 lines of declarative Ruby with
+no AST walking at all. The substrate also understands
+`ActiveSupport::Concern`'s deferred `included do … end` block,
+so a DSL call written inside a concern lands on the class that
+includes it rather than on the concern.
+
+**Walk it.** If the type depends on something the shape of the
+call cannot tell you — argument *values* (`Lisp.eval` above), a
+declaration made elsewhere in the project, or the contents of
+an external file such as a route table or a schema dump — you
+write a walker instead, and the plugin contract gives you the
+hooks for it: a per-file emission pass, per-call-site
+return-type and flow-narrowing contributions, sandboxed file
+and HTTPS reads under a trust policy, cached producers for
+expensive parses, and a cross-plugin fact store so one plugin's
+parse feeds another plugin's checks.
+
+The two paths coexist — one plugin can declare substrate
+entries *and* walk files — and where you go next depends on
+which of them you need:
+
+- [`examples/README.md`](../../examples/README.md) — the six
+  walkthroughs, each spotlighting one contract surface, with a
+  map of which example demonstrates which one.
+- [`docs/internal-spec/plugin.md`](../internal-spec/plugin.md)
+  — the binding plugin contract: manifest, hooks, services,
+  registry, load order. Its siblings
+  [`plugin-trust.md`](../internal-spec/plugin-trust.md) and
+  [`plugin-cache-producers.md`](../internal-spec/plugin-cache-producers.md)
+  cover the I/O and caching surfaces.
+- [`docs/internal-spec/macro-substrate.md`](../internal-spec/macro-substrate.md)
+  — the substrate's tiers, the manifest field each one
+  declares, and how much return-type precision each recovers.
+- [The macro-expansion library survey](../notes/20260515-macro-expansion-library-survey.md)
+  — which real Ruby libraries fit which tier, and which fall
+  outside the substrate entirely.
 
 ## Should you write one?
 

data/docs/handbook/11-sig-gen.md

@@ -93,7 +93,7 @@ states:
 | `equivalent` | The inferred return is not a strict subtype of the declared one — identical, wider, or unrelated — so there is nothing to tighten. Silently skipped. |
 | `skipped` | Disqualified for one of the reasons below. |
 
-The three `sig.skipped.*` reasons are:
+The `sig.skipped.*` reasons are:
 
 - `sig.skipped.complex-shape` — the method has optional, rest,
   keyword, block, or forwarding parameters. The MVP's
@@ -105,6 +105,16 @@ The three `sig.skipped.*` reasons are:
 - `sig.skipped.user-authored` — `--overwrite` was not set
   and the method's existing RBS declaration would have to
   be replaced.
+- `sig.skipped.unrenderable-rbs` — the signature Rigor
+  rendered for this method does not parse as RBS. This one
+  is a **bug in Rigor**, not a property of your code: every
+  generated line is parsed before it is emitted, and a line
+  `rbs` rejects is dropped rather than written, because an
+  unparseable `.rbs` is quarantined *whole* by `rigor check`
+  — one bad line would take every other type in the file
+  down with it. The rest of the signatures are unaffected;
+  the skipped method is reported on stderr, and it is worth
+  reporting to us.
 
 The three `sig.generated.*` identifiers
 (`sig.generated.new-file` / `new-method` / `tighter-return`)