@suss/checker-intent 0.3.1 → 0.4.0

package/README.md

@@ -1,16 +1,16 @@
 # @suss/checker-intent
 
-Pair team-authored intent against derived code and report where the code
-fails to satisfy what the team declared.
+Pairs team-authored intent against derived code and reports where the
+code fails to satisfy what the team declared.
 
 ## What this package is
 
-The intent half of suss's checking, separate from `@suss/checker` (the
-behavioral peer checker) by design. The inputs differ (`IntentSummary`
-(from `@suss/contract-intent`) on one side, `BehavioralSummary` on the
-other), and so does the output: an `IntentFinding` is one-sided coverage
-("the team declared X; does the code do it?"), not a symmetric
-provider↔consumer mismatch.
+This is the intent half of suss's checking, and it is deliberately
+separate from `@suss/checker` (the behavioral peer checker). The inputs
+differ: an `IntentSummary` (from `@suss/contract-intent`) on one side, a
+`BehavioralSummary` on the other. So does the output. An `IntentFinding`
+is one-sided coverage ("the team declared X; does the code do it?"),
+rather than a symmetric provider↔consumer mismatch.
 
 ```ts
 import { checkIntentAgreement } from "@suss/checker-intent";
@@ -18,8 +18,8 @@ import { checkIntentAgreement } from "@suss/checker-intent";
 const findings = checkIntentAgreement(intentSummaries, codeSummaries);
 ```
 
-For each boundary intent, it pairs against the code summaries sharing the
-same boundary key and emits:
+For each boundary intent, it pairs against the code summaries that share
+the same boundary key, and emits:
 
 - `unimplementedBoundary`: the intent declares a boundary no code produces.
 - `uncoveredOutcome`: a declared outcome (response / return / throw) the code never produces.
@@ -27,14 +27,15 @@ same boundary key and emits:
 - `undeclaredOutcome`: code produces a REST status the intent doesn't declare (info; intent under-specifies).
 
 v0 checks system intent (`kind: boundary`). PRD outcome intent
-(`kind: prd`), scenario and link coverage, is a separate pass.
+(`kind: prd`), which covers scenarios and links, is a separate pass.
 
-## Where it sits in suss
+## Where it fits in suss
 
-Depends on `@suss/intent-ir` (intent shapes + `IntentFinding`),
-`@suss/behavioral-ir` (code summaries), and `@suss/ir-core` for the
-shared comparison primitives (`boundaryKey`, `bodyShapesMatch`) it must
-agree on with the behavioral checker. It does **not** depend on
+This package depends on `@suss/intent-ir` (the intent shapes and
+`IntentFinding`), `@suss/behavioral-ir` (the code summaries), and
+`@suss/ir-core` for the shared comparison primitives (`boundaryKey`,
+`bodyShapesMatch`) that it has to agree on with the behavioral checker.
+It does **not** depend on
 `@suss/checker`. The full design is in
 [`docs/internal/proposals/intent-specs.md`](../../docs/internal/proposals/intent-specs.md).
 

package/dist/index.cjs

@@ -81,7 +81,7 @@ function checkBoundaryIntent(intent, codeByBoundary) {
           message: `Intent "${intent.name}" declares boundary ${key} with ${intent.outcomes.length} outcome(s); no code produces this boundary.`
         }
       ],
-      // The comparison ran — finding no implementation IS the result.
+      // The comparison ran: finding no implementation IS the result.
       checked: [
         {
           kind: "boundary",
@@ -195,7 +195,7 @@ function resolveScenarioLink(prd, scenarioTitle, label, ref, boundaryByName) {
     return {
       kind: "danglingScenarioLink",
       severity: "warning",
-      // The intent resolved even though the outcome didn't — key on its
+      // The intent resolved even though the outcome didn't, key on its
       // boundary so a narrow .sussignore rule can target this finding.
       boundary: (0, import_ir_core.boundaryKey)(target.boundary) ?? prdBoundaryLabel(prd),
       intent: { name: prd.title },

package/dist/index.d.cts

@@ -26,7 +26,7 @@ interface CheckedPrd {
     unlinked: number;
 }
 /**
- * A declared intent that was compared — either a boundary intent paired
+ * A declared intent that was compared, either a boundary intent paired
  * against code or a PRD whose scenario links were resolved. Discriminated
  * on `kind` so callers render both without a parallel structure; when a
  * third doc kind (workflow) ships it extends this union.
@@ -44,9 +44,9 @@ interface UncheckedIntent {
  * The full result of an intent-agreement pass. Mirrors the behavioural
  * checker's shape philosophy (`checkAll` → findings + pairs +
  * unmatched): findings are what to fix; checked / unchecked are the
- * coverage accounting — which declared intent was actually compared.
+ * coverage accounting: which declared intent was actually compared.
  * Callers render or gate on this without knowing which doc kinds the
- * checker compared — boundary intents and PRDs both land in `checked`
+ * checker compared: boundary intents and PRDs both land in `checked`
  * (a discriminated union). `unchecked` is reserved for intent that
  * couldn't be compared at all (an unkeyable boundary), never silently
  * dropped.
@@ -64,7 +64,7 @@ interface CheckIntentResult {
  * `unchecked`, never silently dropped.
  *
  * Findings against `source: "inferred"` intent are downgraded one severity
- * level — the intent describes what the code did when the inference ran, so
+ * level: the intent describes what the code did when the inference ran, so
  * a divergence is most likely a code change since, not an authoring error.
  * Curation (`"inferred, curated"`) restores full severity.
  */
@@ -76,7 +76,7 @@ declare function checkIntentAgreement(intents: IntentSummary[], code: Behavioral
  * as: `kind` → the intent finding kind; `boundary` → the finding's
  * boundary key (exact for `fn:` / `gql:` keys, path-normalized for
  * REST). A rule that specifies `consumer` or `provider` never matches
- * an intent finding — it has neither side.
+ * an intent finding: it has neither side.
  */
 declare function applyIntentSuppressions(findings: IntentFinding[], rules: SuppressionRule[], opts?: {
     keepHidden?: boolean;

package/dist/index.d.ts

@@ -26,7 +26,7 @@ interface CheckedPrd {
     unlinked: number;
 }
 /**
- * A declared intent that was compared — either a boundary intent paired
+ * A declared intent that was compared, either a boundary intent paired
  * against code or a PRD whose scenario links were resolved. Discriminated
  * on `kind` so callers render both without a parallel structure; when a
  * third doc kind (workflow) ships it extends this union.
@@ -44,9 +44,9 @@ interface UncheckedIntent {
  * The full result of an intent-agreement pass. Mirrors the behavioural
  * checker's shape philosophy (`checkAll` → findings + pairs +
  * unmatched): findings are what to fix; checked / unchecked are the
- * coverage accounting — which declared intent was actually compared.
+ * coverage accounting: which declared intent was actually compared.
  * Callers render or gate on this without knowing which doc kinds the
- * checker compared — boundary intents and PRDs both land in `checked`
+ * checker compared: boundary intents and PRDs both land in `checked`
  * (a discriminated union). `unchecked` is reserved for intent that
  * couldn't be compared at all (an unkeyable boundary), never silently
  * dropped.
@@ -64,7 +64,7 @@ interface CheckIntentResult {
  * `unchecked`, never silently dropped.
  *
  * Findings against `source: "inferred"` intent are downgraded one severity
- * level — the intent describes what the code did when the inference ran, so
+ * level: the intent describes what the code did when the inference ran, so
  * a divergence is most likely a code change since, not an authoring error.
  * Curation (`"inferred, curated"`) restores full severity.
  */
@@ -76,7 +76,7 @@ declare function checkIntentAgreement(intents: IntentSummary[], code: Behavioral
  * as: `kind` → the intent finding kind; `boundary` → the finding's
  * boundary key (exact for `fn:` / `gql:` keys, path-normalized for
  * REST). A rule that specifies `consumer` or `provider` never matches
- * an intent finding — it has neither side.
+ * an intent finding: it has neither side.
  */
 declare function applyIntentSuppressions(findings: IntentFinding[], rules: SuppressionRule[], opts?: {
     keepHidden?: boolean;

package/dist/index.js

@@ -61,7 +61,7 @@ function checkBoundaryIntent(intent, codeByBoundary) {
           message: `Intent "${intent.name}" declares boundary ${key} with ${intent.outcomes.length} outcome(s); no code produces this boundary.`
         }
       ],
-      // The comparison ran — finding no implementation IS the result.
+      // The comparison ran: finding no implementation IS the result.
       checked: [
         {
           kind: "boundary",
@@ -175,7 +175,7 @@ function resolveScenarioLink(prd, scenarioTitle, label, ref, boundaryByName) {
     return {
       kind: "danglingScenarioLink",
       severity: "warning",
-      // The intent resolved even though the outcome didn't — key on its
+      // The intent resolved even though the outcome didn't, key on its
       // boundary so a narrow .sussignore rule can target this finding.
       boundary: boundaryKey(target.boundary) ?? prdBoundaryLabel(prd),
       intent: { name: prd.title },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/checker-intent",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "type": "module",
   "description": "Pair team-authored intent (IntentSummary) against derived code (BehavioralSummary) and report where they diverge.",
   "keywords": [
@@ -47,9 +47,9 @@
     "zod": "^4.0.0"
   },
   "dependencies": {
-    "@suss/behavioral-ir": "0.3.1",
-    "@suss/intent-ir": "0.3.1",
-    "@suss/ir-core": "0.3.1"
+    "@suss/behavioral-ir": "0.4.0",
+    "@suss/intent-ir": "0.4.0",
+    "@suss/ir-core": "0.4.0"
   },
   "devDependencies": {
     "tsup": "*",