diff --git a/README.md b/README.md index 055c98c..bb5b4fd 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ npx @google/design.md lint DESIGN.md "message": "textColor (#ffffff) on backgroundColor (#1A1C1E) has contrast ratio 15.42:1 — passes WCAG AA." } ], - "summary": { "errors": 0, "warnings": 1, "info": 1 } + "summary": { "errors": 0, "warnings": 1, "infos": 1 } } ``` @@ -80,7 +80,15 @@ npx @google/design.md diff DESIGN.md DESIGN-v2.md { "tokens": { "colors": { "added": ["accent"], "removed": [], "modified": ["tertiary"] }, - "typography": { "added": [], "removed": [], "modified": [] } + "typography": { "added": [], "removed": [], "modified": [] }, + "rounded": { "added": [], "removed": [], "modified": [] }, + "spacing": { "added": [], "removed": [], "modified": [] }, + "components": { "added": [], "removed": [], "modified": [] } + }, + "findings": { + "before": { "errors": 0, "warnings": 1, "infos": 1 }, + "after": { "errors": 0, "warnings": 1, "infos": 1 }, + "delta": { "errors": 0, "warnings": 0 } }, "regression": false } @@ -306,7 +314,7 @@ npx @google/design.md spec --rules-only --format json ## Linting Rules -The linter runs nine rules against a parsed DESIGN.md. Each rule produces findings at a fixed severity level. +The linter runs ten rules against a parsed DESIGN.md. Each rule produces findings at a fixed severity level. | Rule | Severity | What it checks | |:-----|:---------|:---------------| @@ -319,6 +327,7 @@ The linter runs nine rules against a parsed DESIGN.md. Each rule produces findin | `missing-typography` | warning | Colors are defined but no typography tokens exist — agents will use default fonts | | `section-order` | warning | Sections appear out of the canonical order defined by the spec | | `unknown-key` | warning | A top-level YAML key looks like a typo of a known schema key (e.g. `colours:` → `colors:`); custom extension keys stay silent | +| `token-like-ignored` | warning | A top-level YAML key looks like a design-token map but is not a recognized schema key, so `export` will silently ignore it | ### Programmatic API