@erclx/canon 5.44.0 → 5.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/claude/.claude-plugin/plugin.json +1 -1
- package/claude/skills/api-design/REQUIREMENT.md +15 -31
- package/claude/skills/auto-ship/REQUIREMENT.md +14 -25
- package/claude/skills/backlog-triage/REQUIREMENT.md +12 -23
- package/claude/skills/build-in-slices/REQUIREMENT.md +15 -25
- package/claude/skills/canon-cli/REQUIREMENT.md +15 -27
- package/claude/skills/canon-cli/SKILL.md +0 -1
- package/claude/skills/canon-feedback/REQUIREMENT.md +10 -18
- package/claude/skills/canon-feedback-triage/REQUIREMENT.md +10 -15
- package/claude/skills/canvas-board/REQUIREMENT.md +14 -28
- package/claude/skills/ci-workflow/REQUIREMENT.md +12 -21
- package/claude/skills/code-craft/REQUIREMENT.md +14 -28
- package/claude/skills/codebase-layout/REQUIREMENT.md +14 -31
- package/claude/skills/context-fold/REQUIREMENT.md +15 -39
- package/claude/skills/context-fold/references/context.md +3 -3
- package/claude/skills/create-rule/REQUIREMENT.md +10 -24
- package/claude/skills/create-rule/SKILL.md +3 -0
- package/claude/skills/create-skill/REQUIREMENT.md +10 -21
- package/claude/skills/decision-escalate/REQUIREMENT.md +12 -24
- package/claude/skills/deploy-app/REQUIREMENT.md +12 -22
- package/claude/skills/deprecation-migration/REQUIREMENT.md +14 -42
- package/claude/skills/design-identity/REQUIREMENT.md +14 -20
- package/claude/skills/design-taste/REQUIREMENT.md +16 -57
- package/claude/skills/docs-sync/REQUIREMENT.md +14 -23
- package/claude/skills/document-health/REQUIREMENT.md +15 -29
- package/claude/skills/document-health/SKILL.md +2 -2
- package/claude/skills/document-repair/REQUIREMENT.md +32 -0
- package/claude/skills/document-repair/SKILL.md +76 -0
- package/claude/skills/document-repair/references/batches.md +44 -0
- package/claude/skills/draft-and-pick/REQUIREMENT.md +4 -3
- package/claude/skills/draft-doc/REQUIREMENT.md +4 -3
- package/claude/skills/draft-figure/REQUIREMENT.md +4 -3
- package/claude/skills/draft-identity/REQUIREMENT.md +4 -3
- package/claude/skills/draft-ready/REQUIREMENT.md +4 -3
- package/claude/skills/draft-screencast/REQUIREMENT.md +4 -3
- package/claude/skills/draft-slides/REQUIREMENT.md +4 -3
- package/claude/skills/draw-figure/REQUIREMENT.md +15 -39
- package/claude/skills/git-branch/REQUIREMENT.md +12 -26
- package/claude/skills/git-commit/REQUIREMENT.md +11 -15
- package/claude/skills/git-followup/REQUIREMENT.md +11 -22
- package/claude/skills/git-issue/REQUIREMENT.md +9 -15
- package/claude/skills/git-pr/REQUIREMENT.md +13 -32
- package/claude/skills/git-pr/SKILL.md +10 -2
- package/claude/skills/git-pr/references/closing-issues.md +47 -0
- package/claude/skills/git-pr/references/pr.md +4 -0
- package/claude/skills/git-ship/REQUIREMENT.md +13 -26
- package/claude/skills/git-split/REQUIREMENT.md +10 -17
- package/claude/skills/git-stage/REQUIREMENT.md +12 -18
- package/claude/skills/git-worktree/REQUIREMENT.md +15 -19
- package/claude/skills/make-deck/REQUIREMENT.md +13 -21
- package/claude/skills/markdown-craft/REQUIREMENT.md +9 -3
- package/claude/skills/pick-by-eye/REQUIREMENT.md +17 -67
- package/claude/skills/plan-feature/REQUIREMENT.md +15 -24
- package/claude/skills/plan-groundwork/REQUIREMENT.md +12 -28
- package/claude/skills/plan-groundwork/SKILL.md +5 -2
- package/claude/skills/plan-groundwork/references/output.md +47 -1
- package/claude/skills/plan-intake/REQUIREMENT.md +11 -26
- package/claude/skills/plan-intake/references/intake.md +2 -2
- package/claude/skills/plan-intake-answer/REQUIREMENT.md +14 -29
- package/claude/skills/plan-intake-answer/SKILL.md +7 -1
- package/claude/skills/plan-ready/REQUIREMENT.md +17 -36
- package/claude/skills/pr-evidence/REQUIREMENT.md +11 -17
- package/claude/skills/read-frames/REQUIREMENT.md +3 -8
- package/claude/skills/record-screencast/REQUIREMENT.md +14 -17
- package/claude/skills/review-address/REQUIREMENT.md +14 -38
- package/claude/skills/review-craft/REQUIREMENT.md +14 -32
- package/claude/skills/review-pr/REQUIREMENT.md +15 -34
- package/claude/skills/review-ui/REQUIREMENT.md +14 -39
- package/claude/skills/role-orchestrator/REQUIREMENT.md +16 -99
- package/claude/skills/role-orchestrator/references/orchestrator-refill.md +5 -0
- package/claude/skills/role-orchestrator/references/orchestrator-review-dispatch.md +9 -0
- package/claude/skills/role-planner/REQUIREMENT.md +15 -73
- package/claude/skills/role-reviewer/REQUIREMENT.md +15 -65
- package/claude/skills/role-reviewer/SKILL.md +5 -1
- package/claude/skills/role-worker/REQUIREMENT.md +13 -41
- package/claude/skills/role-worker/SKILL.md +2 -0
- package/claude/skills/script-screencast/REQUIREMENT.md +10 -16
- package/claude/skills/search-craft/REQUIREMENT.md +12 -36
- package/claude/skills/search-craft/SKILL.md +1 -1
- package/claude/skills/search-craft/references/adopted.md +2 -2
- package/claude/skills/session-compact/REQUIREMENT.md +13 -23
- package/claude/skills/session-map/REQUIREMENT.md +13 -29
- package/claude/skills/session-relay/REQUIREMENT.md +14 -58
- package/claude/skills/session-relay/SKILL.md +6 -0
- package/claude/skills/session-resume/REQUIREMENT.md +13 -27
- package/claude/skills/session-worktree/REQUIREMENT.md +14 -43
- package/claude/skills/systematic-debugging/REQUIREMENT.md +13 -34
- package/claude/skills/target-check/REQUIREMENT.md +16 -23
- package/claude/skills/target-setup/REQUIREMENT.md +11 -34
- package/claude/skills/target-setup/SKILL.md +2 -2
- package/claude/skills/target-setup/references/detect.md +0 -1
- package/claude/skills/target-setup/references/verify.md +2 -2
- package/claude/skills/task-board/REQUIREMENT.md +13 -22
- package/claude/skills/task-board/SKILL.md +7 -0
- package/claude/skills/task-board/references/tasks.md +1 -1
- package/claude/skills/task-complete/REQUIREMENT.md +11 -24
- package/claude/skills/task-complete/references/archive.md +1 -0
- package/claude/skills/teach-workspace/REQUIREMENT.md +14 -45
- package/claude/skills/teach-workspace/references/promotion.md +5 -5
- package/claude/skills/test-craft/REQUIREMENT.md +15 -46
- package/claude/skills/test-first/REQUIREMENT.md +14 -20
- package/claude/skills/ui-checklist/REQUIREMENT.md +14 -29
- package/claude/skills/ux-audit/REQUIREMENT.md +3 -7
- package/claude/skills/ux-measure/REQUIREMENT.md +14 -28
- package/claude/skills/video-craft/REQUIREMENT.md +14 -27
- package/claude/skills/write-doc/REQUIREMENT.md +14 -24
- package/claude/skills/write-human/REQUIREMENT.md +15 -27
- package/claude/skills/youtube-transcripts/REQUIREMENT.md +9 -15
- package/docs/agents/context-audit.md +19 -12
- package/docs/agents/install-and-sync.md +2 -2
- package/docs/agents/markdown-audit.md +15 -10
- package/docs/agents/output-shape.md +1 -2
- package/docs/target/migrations.md +18 -0
- package/docs/target/projects.md +3 -2
- package/docs/target/scenarios.md +4 -1
- package/docs/workflow/skill-map-on-request.md +1 -1
- package/docs/workflow/skill-map.md +6 -5
- package/governance/detect.toml +4 -0
- package/governance/ledger/lang/go.md +61 -0
- package/governance/ledger/lang/php.md +50 -0
- package/governance/ledger/lang/python.md +68 -0
- package/governance/ledger/lang/typescript.md +64 -0
- package/governance/ledger/lib/database.md +65 -0
- package/governance/ledger/lib/e2e-reliability.md +57 -0
- package/governance/ledger/lib/pydantic.md +61 -0
- package/governance/ledger/lib/security-server.md +62 -0
- package/governance/ledger/lib/security-web.md +51 -0
- package/governance/ledger/lib/tanstack-query.md +57 -0
- package/governance/ledger/lib/test-scope.md +43 -0
- package/governance/ledger/lib/testing-go.md +57 -0
- package/governance/ledger/lib/testing-php.md +51 -0
- package/governance/ledger/lib/testing-py.md +67 -0
- package/governance/ledger/lib/testing-ts.md +63 -0
- package/governance/ledger/lib/zod.md +47 -0
- package/governance/ledger/tooling/ci-workflow.md +33 -0
- package/governance/ledger/tooling/code-comments.md +48 -0
- package/governance/ledger/tooling/config-comments.md +27 -0
- package/governance/ledger/tooling/dependencies.md +38 -0
- package/governance/ledger/ui/a11y.md +55 -0
- package/governance/ledger/ui/copy.md +49 -0
- package/governance/ledger/ui/design-reference.md +42 -0
- package/governance/ledger/ui/design-taste.md +19 -0
- package/governance/ledger/ui/forms.md +71 -0
- package/governance/ledger/ui/interface-casing.md +47 -0
- package/governance/ledger/ui/keyboard.md +68 -0
- package/governance/ledger/ui/link-behavior.md +29 -0
- package/governance/ledger/ui/motion.md +33 -0
- package/governance/ledger/ui/surface-capture.md +69 -0
- package/governance/ledger/ui/ux-completeness.md +79 -0
- package/governance/renames.toml +0 -2
- package/governance/rules/claude/output.md +5 -1
- package/governance/rules/code/routing.md +5 -1
- package/governance/rules/lang/go.md +7 -16
- package/governance/rules/lang/php.md +3 -3
- package/governance/rules/lang/python.md +9 -18
- package/governance/rules/lang/typescript.md +9 -19
- package/governance/rules/lib/database.md +5 -5
- package/governance/rules/lib/e2e-reliability.md +4 -6
- package/governance/rules/lib/pydantic.md +14 -16
- package/governance/rules/lib/security-server.md +4 -4
- package/governance/rules/lib/security-web.md +6 -10
- package/governance/rules/lib/tanstack-query.md +10 -12
- package/governance/rules/lib/test-scope.md +4 -4
- package/governance/rules/lib/testing-go.md +1 -2
- package/governance/rules/lib/testing-php.md +4 -5
- package/governance/rules/lib/testing-py.md +11 -19
- package/governance/rules/lib/testing-ts.md +7 -16
- package/governance/rules/lib/zod.md +6 -8
- package/governance/rules/tooling/code-comments.md +2 -4
- package/governance/rules/tooling/config-comments.md +1 -4
- package/governance/rules/tooling/dependencies.md +1 -1
- package/governance/rules/ui/a11y.md +16 -45
- package/governance/rules/ui/copy.md +6 -9
- package/governance/rules/ui/forms.md +13 -19
- package/governance/rules/ui/interface-casing.md +5 -7
- package/governance/rules/ui/keyboard.md +38 -0
- package/governance/rules/ui/link-behavior.md +3 -3
- package/governance/rules/ui/motion.md +3 -3
- package/governance/rules/ui/surface-capture.md +15 -27
- package/governance/rules/ui/ux-completeness.md +16 -39
- package/governance/stacks/base.toml +0 -1
- package/package.json +1 -1
- package/scripts/core/install-check.sh +1 -1
- package/src/claude/cases/workflow.ts +12 -0
- package/src/cli/help.ts +0 -1
- package/src/cli.ts +0 -2
- package/src/commands/context.ts +57 -3
- package/src/commands/gov.ts +4 -0
- package/src/commands/init.ts +2 -2
- package/src/commands/labels.ts +83 -3
- package/src/commands/markdown.ts +188 -21
- package/src/commands/sessions.ts +36 -3
- package/src/commands/tasks.ts +180 -0
- package/src/commands/tooling.ts +18 -5
- package/src/commands/worktrees.ts +2 -0
- package/src/context/coverage.ts +210 -0
- package/src/context/gate.ts +12 -3
- package/src/design/components.ts +1 -1
- package/src/gate/stages.ts +1 -1
- package/src/gov/audit.ts +22 -2
- package/src/init/plan.ts +1 -8
- package/src/init/steps.ts +44 -7
- package/src/intake/items.ts +14 -0
- package/src/inventory/subjects.ts +1 -1
- package/src/labels/closing.ts +46 -0
- package/src/markdown/gated.ts +250 -0
- package/src/markdown/scope.ts +119 -2
- package/src/migrate/rename.ts +6 -0
- package/src/migrate/scratch-evidence.ts +12 -4
- package/src/records/backup.ts +3 -3
- package/src/records/validate.ts +3 -3
- package/src/roots/record.ts +17 -8
- package/src/sessions/claim.ts +7 -0
- package/src/sessions/live.ts +53 -6
- package/src/sessions/registry.ts +11 -0
- package/src/sessions/resolve.ts +32 -5
- package/src/tasks/closes.ts +136 -0
- package/src/tasks/record.ts +1 -1
- package/src/tooling/inject.ts +26 -7
- package/src/tooling/package.ts +32 -0
- package/src/tooling/read.ts +46 -3
- package/src/tooling/scan.ts +8 -2
- package/src/worktrees/reclaim.ts +16 -1
- package/tooling/astro/reference.md +64 -93
- package/tooling/base/configs/.github/workflows/phase-label-gate.yml +1 -1
- package/tooling/base/configs/scripts/verify.ts +2 -2
- package/tooling/base/reference.md +1 -9
- package/tooling/base/seeds/canon/context/{ci.md → development/ci.md} +1 -1
- package/tooling/base/seeds/canon/context/development/index.md +11 -0
- package/tooling/base/seeds/canon/context/{development.md → development/setup.md} +8 -12
- package/tooling/base/seeds/canon/context/index.md +1 -2
- package/tooling/claude/manifest.toml +1 -5
- package/tooling/claude/reference.md +36 -59
- package/tooling/claude/seeds/.claude/hooks/board-validate.sh +1 -1
- package/tooling/claude/seeds/.claude/hooks/index-reminder.sh +2 -7
- package/tooling/claude/seeds/.claude/hooks/pr-create-log.sh +2 -7
- package/tooling/claude/seeds/.claude/hooks/scratch-guard.sh +3 -10
- package/tooling/claude/seeds/.claude/hooks/search-reminder.sh +2 -7
- package/tooling/claude/seeds/.claude/hooks/standards-audit.sh +2 -4
- package/tooling/claude/seeds/CLAUDE.md +2 -2
- package/tooling/nextjs/reference.md +0 -6
- package/tooling/php/reference.md +0 -4
- package/tooling/web/configs/.github/workflows/verify.yml +28 -0
- package/tooling/web/configs/.oxlintrc.json +7 -0
- package/tooling/web/configs/e2e/capture-types.ts +35 -0
- package/tooling/web/configs/e2e/screenshot.ts +23 -72
- package/tooling/web/manifest.toml +1 -1
- package/tooling/web/reference.md +77 -124
- package/tooling/web/seeds/e2e/capture/cases.ts +47 -0
- package/governance/rules/canon/task-scope.md +0 -12
- package/src/commands/wiki.ts +0 -100
- package/src/wiki/init.ts +0 -85
|
@@ -8,31 +8,29 @@ paths:
|
|
|
8
8
|
|
|
9
9
|
## Models
|
|
10
10
|
|
|
11
|
-
- Use `pydantic.BaseModel` over `dataclass` at I/O and API boundaries.
|
|
12
|
-
-
|
|
13
|
-
- Set `extra="forbid"` on
|
|
14
|
-
-
|
|
11
|
+
- Use `pydantic.BaseModel` over a standard library `dataclass` at I/O and API boundaries, since a `dataclass` validates nothing.
|
|
12
|
+
- On Pydantic 2, configure a model with `model_config = ConfigDict(...)`, never the deprecated nested `Config` class.
|
|
13
|
+
- Set `extra="forbid"` on a model receiving external input, since the default ignores an unknown key silently.
|
|
14
|
+
- Declare a constraint with `Field(...)`, such as `gt=0`, so validation enforces it rather than a docstring.
|
|
15
15
|
|
|
16
16
|
## Validation
|
|
17
17
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
- Use `@model_validator(mode="after")` for cross-field invariants.
|
|
18
|
+
- Validate an untrusted dict with `Model.model_validate(data)`, and a JSON string with `Model.model_validate_json(s)` rather than `json.loads` first.
|
|
19
|
+
- On Pydantic 2, write `@field_validator` and `@model_validator`, never the deprecated `@validator` or `@root_validator`.
|
|
20
|
+
- Check a cross-field invariant in `@model_validator(mode="after")`.
|
|
22
21
|
|
|
23
22
|
## Types
|
|
24
23
|
|
|
25
|
-
- Use `
|
|
26
|
-
- Use
|
|
27
|
-
-
|
|
24
|
+
- Use `SecretStr` for a credential, so its value stays out of logs and tracebacks.
|
|
25
|
+
- Use a constrained type such as `PositiveInt` or `EmailStr` over a hand-rolled regex.
|
|
26
|
+
- Share a constrained type as `Annotated[T, Field(...)]`.
|
|
27
|
+
- Never type a field `Any`, which allows any value including `None`. Use `JsonValue` or a union of concrete types.
|
|
28
28
|
|
|
29
29
|
## Settings
|
|
30
30
|
|
|
31
|
-
-
|
|
32
|
-
- Load environment through a single `Settings` model. Do not read `os.environ` directly elsewhere.
|
|
31
|
+
- Load environment through one `pydantic_settings.BaseSettings` model. Never read `os.environ` directly elsewhere.
|
|
33
32
|
|
|
34
33
|
## Serialization
|
|
35
34
|
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
- Use `by_alias=True` when serializing to external schemas with non-Python field names.
|
|
35
|
+
- On Pydantic 2, serialize with `model_dump(mode="json")` or `model_dump_json()`, never the deprecated `.dict()` or `.json()`.
|
|
36
|
+
- Pass `by_alias=True` when serializing to an external schema, since a dump ignores aliases by default.
|
|
@@ -19,7 +19,7 @@ paths:
|
|
|
19
19
|
|
|
20
20
|
## Credentials
|
|
21
21
|
|
|
22
|
-
- Hash passwords with
|
|
22
|
+
- Hash passwords with Argon2id, or scrypt or bcrypt where it is missing, and a per-password salt. Never store a reversible password.
|
|
23
23
|
- Compare tokens, signatures, and password hashes with a constant-time function.
|
|
24
24
|
- Expire and revoke sessions and refresh tokens on the server. Do not rely on client-side deletion.
|
|
25
25
|
|
|
@@ -27,7 +27,7 @@ paths:
|
|
|
27
27
|
|
|
28
28
|
- Read every secret from the environment or a secret manager at runtime.
|
|
29
29
|
- Never commit a secret, connection string, or private key to the repository.
|
|
30
|
-
- Never return a secret, connection string, or internal hostname in a response body.
|
|
30
|
+
- Never return a secret, connection string, stack trace, or internal hostname in a response body.
|
|
31
31
|
|
|
32
32
|
## Abuse limits
|
|
33
33
|
|
|
@@ -37,5 +37,5 @@ paths:
|
|
|
37
37
|
|
|
38
38
|
## Transport
|
|
39
39
|
|
|
40
|
-
- Serve every route over TLS
|
|
41
|
-
-
|
|
40
|
+
- Serve every route over TLS. Fail a plaintext API request rather than redirecting it.
|
|
41
|
+
- List CORS origins explicitly whenever credentials are allowed, since a wildcard is refused then. Never reflect the request origin.
|
|
@@ -9,24 +9,20 @@ paths:
|
|
|
9
9
|
|
|
10
10
|
# Web security standards
|
|
11
11
|
|
|
12
|
-
## Link safety
|
|
13
|
-
|
|
14
|
-
- Add `rel="noopener noreferrer"` to all external links with `target="_blank"`.
|
|
15
|
-
|
|
16
12
|
## Content sanitization
|
|
17
13
|
|
|
18
|
-
- Sanitize
|
|
19
|
-
-
|
|
14
|
+
- Sanitize HTML with DOMPurify before passing it to `dangerouslySetInnerHTML`, `innerHTML`, or `set:html`. Never render it raw.
|
|
15
|
+
- Allow only `http:` and `https:` in a user-supplied URL before rendering it in `href` or `src`.
|
|
20
16
|
|
|
21
17
|
## Input validation
|
|
22
18
|
|
|
23
|
-
-
|
|
19
|
+
- Parse URL parameters and query strings through a schema before use.
|
|
24
20
|
|
|
25
21
|
## Storage and tokens
|
|
26
22
|
|
|
27
|
-
-
|
|
28
|
-
-
|
|
23
|
+
- Never store a session token, password, or personal data in `localStorage` or `sessionStorage`, which any script on the page can read.
|
|
24
|
+
- Keep an authentication token in an `HttpOnly` cookie, out of reach of JavaScript.
|
|
29
25
|
|
|
30
26
|
## Third-party scripts
|
|
31
27
|
|
|
32
|
-
-
|
|
28
|
+
- Pin a third-party script to a version and load it with an `integrity` hash.
|
|
@@ -9,24 +9,22 @@ paths:
|
|
|
9
9
|
|
|
10
10
|
## Query conventions
|
|
11
11
|
|
|
12
|
-
- Define query
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
12
|
+
- Define a query's key and function together with `queryOptions()`, and reuse that object at every call site.
|
|
13
|
+
- Include every variable the query function reads in its query key.
|
|
14
|
+
- Set `staleTime` per query from how often its data changes, since the default treats cached data as stale at once.
|
|
15
|
+
- Throw from a query function on a response that is not `ok`, since `fetch` does not reject on an HTTP error.
|
|
16
16
|
|
|
17
17
|
## Mutations
|
|
18
18
|
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
- Handle `onError` at the mutation site with user-facing feedback.
|
|
19
|
+
- Write data through `useMutation`, never by calling the API from an event handler and patching the cache.
|
|
20
|
+
- Invalidate the related query keys in `onSuccess` and return that promise. Reserve `setQueryData` for an optimistic update.
|
|
21
|
+
- Handle `onError` at the mutation site with feedback the user sees.
|
|
23
22
|
|
|
24
23
|
## Cache management
|
|
25
24
|
|
|
26
|
-
-
|
|
27
|
-
- Prefetch predictable navigations with `queryClient.prefetchQuery` at route boundaries.
|
|
25
|
+
- Prefetch a predictable navigation's data in its route loader.
|
|
28
26
|
|
|
29
27
|
## Separation of concerns
|
|
30
28
|
|
|
31
|
-
- Keep query
|
|
32
|
-
- Use the query `enabled` option for conditional
|
|
29
|
+
- Keep a query function a pure data fetcher with no UI logic or side effects, since a background refetch runs it again.
|
|
30
|
+
- Use the query `enabled` option for a conditional or dependent fetch, never `useEffect`.
|
|
@@ -9,9 +9,9 @@ paths:
|
|
|
9
9
|
## Selecting a run
|
|
10
10
|
|
|
11
11
|
- Narrow an end-to-end run by spec path or by test name. Never narrow it by engine.
|
|
12
|
-
- Run one named test while iterating on a behavior
|
|
13
|
-
- Run one surface while iterating on that surface
|
|
14
|
-
- Run `
|
|
12
|
+
- Run `playwright test -g '<name>'` for one named test while iterating on a behavior.
|
|
13
|
+
- Run `playwright test e2e/<area>.spec.ts` for one surface while iterating on that surface.
|
|
14
|
+
- Run `playwright test --only-changed` to select the specs a branch changed.
|
|
15
15
|
- Run the whole suite before pushing.
|
|
16
16
|
- Pass `--project` in a local run only to reproduce a failure that engine has already reported. The CI matrix passes it on every job, one engine per leg, which is the gate rather than a narrowed run.
|
|
17
17
|
- Do not add a script that pins a default run to one engine.
|
|
@@ -19,6 +19,6 @@ paths:
|
|
|
19
19
|
## Instruments
|
|
20
20
|
|
|
21
21
|
- Answer a question about the running page with a script against the dev server rather than with the suite.
|
|
22
|
-
- Do not enable `fullyParallel` in
|
|
22
|
+
- Do not enable `fullyParallel` in the Playwright config.
|
|
23
23
|
- Follow `.claude/rules/canon/ui/surface-capture.md` for capture scope.
|
|
24
24
|
- Follow `.claude/rules/canon/lib/e2e-reliability.md` for waits and guards.
|
|
@@ -13,7 +13,6 @@ paths:
|
|
|
13
13
|
## Framework
|
|
14
14
|
|
|
15
15
|
- Use the standard `testing` package. Do not add an assertion library for what `t.Errorf` and `t.Fatalf` already state.
|
|
16
|
-
- Place a test beside the code it tests, in a `_test.go` file of the same package.
|
|
17
16
|
- Use an external `<pkg>_test` package when a test should see only the exported API.
|
|
18
17
|
|
|
19
18
|
## Table-driven cases
|
|
@@ -24,7 +23,7 @@ paths:
|
|
|
24
23
|
## Helpers and setup
|
|
25
24
|
|
|
26
25
|
- Call `t.Helper()` first in every test helper.
|
|
27
|
-
- Use `t.Cleanup` over `defer` for teardown a helper registers.
|
|
26
|
+
- Use `t.Cleanup` over `defer` for teardown a helper registers, since a `defer` runs when the helper returns.
|
|
28
27
|
- Use `t.TempDir` and `t.Setenv` over hand-rolled temp directories or environment stashes.
|
|
29
28
|
- Use `net/http/httptest` over a real listener.
|
|
30
29
|
|
|
@@ -15,16 +15,15 @@ paths:
|
|
|
15
15
|
|
|
16
16
|
- Use PHPUnit for all tests.
|
|
17
17
|
- Declare each test class `final` and extend `PHPUnit\Framework\TestCase`.
|
|
18
|
-
- Place tests under `tests/`, mirroring the `src/` namespace layout, in files named `*Test.php`.
|
|
19
18
|
|
|
20
19
|
## Attributes
|
|
21
20
|
|
|
22
|
-
-
|
|
23
|
-
- Use a static data provider method for table-driven cases over per-case test methods.
|
|
21
|
+
- On PHPUnit 10 or later, use attributes (`#[Test]`, `#[DataProvider]`, `#[CoversClass]`) over docblock annotations, which PHPUnit 12 no longer reads.
|
|
22
|
+
- Use a `public static` data provider method for table-driven cases over per-case test methods.
|
|
24
23
|
|
|
25
24
|
## Assertions and doubles
|
|
26
25
|
|
|
27
|
-
- Use `assertSame` over `assertEquals
|
|
28
|
-
-
|
|
26
|
+
- Use `assertSame` over `assertEquals`, which compares with `==`.
|
|
27
|
+
- Call `expectException` before the throwing call, over `try` and `catch`, for an expected exception.
|
|
29
28
|
- Use `createStub` where no interaction is asserted. Reserve `createMock` for asserting a call.
|
|
30
29
|
- Do not make real network calls. Use a fake or a stubbed client.
|
|
@@ -10,35 +10,27 @@ paths:
|
|
|
10
10
|
|
|
11
11
|
## Framework
|
|
12
12
|
|
|
13
|
-
-
|
|
14
|
-
- Place tests under `tests/`, mirroring the `src/` package layout.
|
|
15
|
-
- Name files `test_*.py` and test functions `test_*`.
|
|
13
|
+
- Write tests as plain `pytest` functions, never `unittest.TestCase` subclasses, which lose fixtures and parametrization.
|
|
16
14
|
|
|
17
15
|
## Fixtures
|
|
18
16
|
|
|
19
|
-
-
|
|
20
|
-
- Place shared
|
|
21
|
-
-
|
|
22
|
-
- Use `tmp_path` and `monkeypatch` over hand-rolled temp directories or
|
|
17
|
+
- Write setup and teardown as a `@pytest.fixture` that yields, over setup and teardown methods.
|
|
18
|
+
- Place a shared fixture in the `conftest.py` of the narrowest directory whose tests need it.
|
|
19
|
+
- Widen a fixture's `scope=` past the `function` default only for state no test mutates.
|
|
20
|
+
- Use `tmp_path` and `monkeypatch` over hand-rolled temp directories or environment stashes, since both undo themselves.
|
|
23
21
|
|
|
24
22
|
## Parametrize
|
|
25
23
|
|
|
26
24
|
- Use `@pytest.mark.parametrize` for table-driven cases over per-case test functions.
|
|
27
|
-
- Use `ids=` to label parametrized cases when their repr is unclear.
|
|
28
25
|
|
|
29
26
|
## Async
|
|
30
27
|
|
|
31
|
-
- Mark async
|
|
32
|
-
-
|
|
28
|
+
- Mark each async test `@pytest.mark.asyncio`, or set `asyncio_mode = "auto"`, since strict mode runs only marked tests.
|
|
29
|
+
- Run on the event loop `pytest-asyncio` provides. Never call `asyncio.run()` or create a loop inside a test.
|
|
33
30
|
|
|
34
31
|
## Assertions and mocks
|
|
35
32
|
|
|
36
|
-
- Use plain `assert
|
|
37
|
-
- Use `pytest.raises(...)` over `try
|
|
38
|
-
-
|
|
39
|
-
- Do not make real network calls. Use `responses`, `
|
|
40
|
-
|
|
41
|
-
## Conventions
|
|
42
|
-
|
|
43
|
-
- Arrange, act, assert per test, with one logical assertion group.
|
|
44
|
-
- Use descriptive `test_*` names that read as the assertion. Do not prefix with `should_`.
|
|
33
|
+
- Use plain `assert`, which pytest rewrites to report the values, over `self.assertEqual`.
|
|
34
|
+
- Use `pytest.raises(...)` over `try` and `except` for an expected exception.
|
|
35
|
+
- Patch with `monkeypatch.setattr` or `unittest.mock.patch`, never by assigning a module attribute by hand.
|
|
36
|
+
- Do not make real network calls. Use `responses`, `pytest-httpx`, or a fake.
|
|
@@ -12,29 +12,20 @@ paths:
|
|
|
12
12
|
## Unit and integration
|
|
13
13
|
|
|
14
14
|
- Use Vitest for unit and integration tests.
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
- Select elements by accessibility attributes first (`getByRole`, `getByLabelText`).
|
|
15
|
+
- Simulate interaction with `userEvent` over `fireEvent`, since it refuses what a browser would, such as a click on a hidden element.
|
|
16
|
+
- Mock the network with MSW. Never mock `fetch` or axios by hand, and never let a unit test make a real call.
|
|
17
|
+
- Query by role or label first, such as `getByRole` and `getByLabelText`, and by test ID only when neither matches.
|
|
19
18
|
|
|
20
19
|
## End-to-end
|
|
21
20
|
|
|
22
21
|
- Use Playwright for end-to-end tests.
|
|
23
|
-
- Place
|
|
24
|
-
- Never place Playwright tests inside `src/`.
|
|
25
|
-
- Scope the three rules above to tests the Playwright runner executes. A Vitest test importing a browser driver to exercise project code stays beside its module, where Vitest looks for it.
|
|
26
|
-
- Keep specs apart from their fixtures, page objects, and helpers inside `e2e/`. Load the `canon:codebase-layout` skill for the folder shape.
|
|
22
|
+
- Place every test the Playwright runner executes under `e2e/`, never `src/`. A Vitest test that drives a browser stays beside its module.
|
|
27
23
|
|
|
28
24
|
## Timers and async
|
|
29
25
|
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
- Restore real timers with `vi.useRealTimers()` in a matching `afterEach`.
|
|
26
|
+
- Pass `advanceTimers: vi.advanceTimersByTime` to `userEvent.setup()` whenever fake timers are on.
|
|
27
|
+
- Restore real timers with `vi.useRealTimers()` in `afterEach`, after `vi.runOnlyPendingTimers()`.
|
|
33
28
|
|
|
34
29
|
## Conventions
|
|
35
30
|
|
|
36
|
-
-
|
|
37
|
-
- Use `.spec.ts` / `.spec.tsx` for integration tests and for Playwright tests under `e2e/`.
|
|
38
|
-
- Do not make real network calls in unit tests.
|
|
39
|
-
- `describe()` labels use the exact identifier of the subject under test in its natural casing.
|
|
40
|
-
- `it()` descriptions use "should" + sentence case.
|
|
31
|
+
- Name a unit test `.test.ts` or `.test.tsx`, and an integration or Playwright test `.spec.ts` or `.spec.tsx`.
|
|
@@ -9,17 +9,15 @@ paths:
|
|
|
9
9
|
|
|
10
10
|
## Type inference
|
|
11
11
|
|
|
12
|
-
-
|
|
13
|
-
- Do not manually declare interfaces that duplicate Zod schemas.
|
|
14
|
-
- Do not export the runtime Schema if only the inferred Type is required by consumers.
|
|
12
|
+
- Derive a schema's type with `z.infer<typeof Schema>`, never a hand-written interface that duplicates the schema.
|
|
15
13
|
|
|
16
14
|
## Boundary validation
|
|
17
15
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
16
|
+
- Parse untrusted input with `z.strictObject()` so an unknown key fails, never with a method the Zod 4 changelog marks legacy.
|
|
17
|
+
- Narrow a schema with `.pick()` or `.omit()`, never by passing unknown keys through with `z.looseObject()`.
|
|
18
|
+
- Call `.parse()` where a failure should throw, and `.safeParse()` where the caller recovers, such as a form.
|
|
19
|
+
- Restrict `z.coerce` to string input at an I/O boundary such as URL params, since it converts with `String()` or `Boolean()`.
|
|
21
20
|
|
|
22
21
|
## Schema safety
|
|
23
22
|
|
|
24
|
-
- Use `z.unknown()` for
|
|
25
|
-
- Prefer `.strict()` at boundaries or explicit `.pick()`/`.omit()` over `.passthrough()`.
|
|
23
|
+
- Use `z.unknown()` for an input of unknown shape, never `z.any()`, which infers `any` and switches off checking downstream.
|
|
@@ -16,14 +16,12 @@ paths:
|
|
|
16
16
|
- Write a comment only when it records a fact the reader cannot recover from the code: an external contract, a rejected alternative, or the reason a surprising line is correct.
|
|
17
17
|
- Do not restate in prose what the line beside it already says.
|
|
18
18
|
- Do not comment a self-contained function whose signature and body already carry its behavior.
|
|
19
|
-
-
|
|
20
|
-
- Do not add or delete a comment to move a file toward a density figure.
|
|
19
|
+
- Do not add or delete a comment to move a file toward a density figure, since density follows how much of its behavior is decided outside it.
|
|
21
20
|
|
|
22
21
|
## What a comment may claim
|
|
23
22
|
|
|
24
|
-
-
|
|
23
|
+
- Keep each comment true of the code as written, and update or delete one a change invalidates in that same change.
|
|
25
24
|
- Describe a function's contract and its constraints, never its steps line by line.
|
|
26
|
-
- Update or delete an invalidated comment in the same change that invalidates it.
|
|
27
25
|
- Do not name a person, a ticket, or a date in place of the fact itself.
|
|
28
26
|
|
|
29
27
|
## What never goes in a comment
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: Keep comments
|
|
2
|
+
description: Keep comments in dotfiles, config, and workflow files to what a key does or accepts
|
|
3
3
|
paths:
|
|
4
4
|
- '**/.env*'
|
|
5
5
|
- '**/.gitignore'
|
|
@@ -16,7 +16,4 @@ paths:
|
|
|
16
16
|
|
|
17
17
|
## Comments
|
|
18
18
|
|
|
19
|
-
- Keep each comment to one short line. Do not wrap a single key in a multi-line explanation.
|
|
20
|
-
- Prefer a one-word category label over a sentence for a group header.
|
|
21
|
-
- Match the comment density of the surrounding file. Do not add a verbose comment next to terse ones.
|
|
22
19
|
- Comment what a key does or its allowed values. Do not restate the key name.
|
|
@@ -15,7 +15,7 @@ paths:
|
|
|
15
15
|
## Declaration
|
|
16
16
|
|
|
17
17
|
- Declare a package in the project manifest before importing it anywhere in the source.
|
|
18
|
-
- Add a package with the
|
|
18
|
+
- Add a package with the command that writes the manifest and the lockfile together, such as `bun add` or `uv add`. Re-lock in the same change after any hand edit to the manifest.
|
|
19
19
|
- Commit the lockfile with the manifest change in the same commit.
|
|
20
20
|
- Declare a package used only by tests, builds, or tooling as a development dependency.
|
|
21
21
|
- Never import a package that arrives only as a transitive dependency of another package.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
description:
|
|
2
|
+
description: Semantics, text alternatives, contrast, and reflow for rendered UI
|
|
3
3
|
paths:
|
|
4
4
|
- '**/*.tsx'
|
|
5
5
|
- '**/*.jsx'
|
|
@@ -8,56 +8,27 @@ paths:
|
|
|
8
8
|
- '**/*.css'
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
# Accessibility
|
|
11
|
+
# Accessibility standards
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## Semantics
|
|
14
14
|
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
15
|
+
- Use a native `<button>` or `<a>` over a `<div>` or `<span>` carrying a click handler, since the native element brings its role, focus, and keyboard activation.
|
|
16
|
+
- Spell an attribute the way the file's syntax spells it, being `onclick` and `tabindex` in HTML and Astro markup and `onClick` and `tabIndex` in JSX.
|
|
17
|
+
- Give a custom control the role its pattern names, such as `combobox` or `listbox`, and keep `aria-expanded`, `aria-selected`, and `aria-checked` in step with what it shows.
|
|
18
|
+
- Give an interactive element with no visible text label a name through `aria-label` or `aria-labelledby`.
|
|
18
19
|
|
|
19
|
-
##
|
|
20
|
+
## Text alternatives
|
|
20
21
|
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
- Space: activates buttons and checkboxes, toggles selection in listboxes.
|
|
24
|
-
- Arrow keys: navigate within composite widgets. Do not let them exit the widget.
|
|
25
|
-
- Escape: closes any overlay, popover, dialog, or dropdown. Cancels in-progress edits.
|
|
26
|
-
- Do not introduce non-standard key bindings for common actions.
|
|
27
|
-
- Give every author-defined drag a single-pointer alternative and a keyboard path, such as move buttons or arrow-key reordering (WCAG 2.2 Dragging Movements, 2.5.7).
|
|
22
|
+
- Give every `<img>` an `alt`, and use `alt=""` for a decorative image.
|
|
23
|
+
- Describe what an image means, or the action an icon control takes, never its appearance. Do not prefix it with "Image of" or "Photo of".
|
|
28
24
|
|
|
29
|
-
##
|
|
25
|
+
## Contrast and color
|
|
30
26
|
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
|
|
34
|
-
## Composite widgets
|
|
35
|
-
|
|
36
|
-
- Roving tabindex for interactive collections: one item in the tab sequence at a time.
|
|
37
|
-
- Combobox: arrow keys navigate options, Enter selects, Escape closes, typing filters.
|
|
38
|
-
|
|
39
|
-
## Focus management
|
|
40
|
-
|
|
41
|
-
- Move focus into any overlay, popover, or dialog on open. Return focus to the trigger on close.
|
|
42
|
-
- Never move focus on hover. Only on keyboard input or explicit pointer activation.
|
|
43
|
-
- Do not let a sticky header, footer, or overlay fully cover the focused control. Scroll it into view clear of them (WCAG 2.2 Focus Not Obscured, 2.4.11).
|
|
44
|
-
|
|
45
|
-
## ARIA semantics
|
|
46
|
-
|
|
47
|
-
- Use semantic HTML over custom elements: `<button>` over a `<div>` carrying a click handler, `<a>` over a `<span>` carrying one.
|
|
48
|
-
- A `<div>` with a click handler requires a role, a tab index, and keyboard handlers. Use `<button>` instead.
|
|
49
|
-
- Spell an attribute the way the file's syntax spells it: `onclick` and `tabindex` in HTML and Astro markup, `onClick` and `tabIndex` in JSX.
|
|
50
|
-
- Set role on custom controls: `role="combobox"`, `role="listbox"`, `role="menu"`, `role="option"`.
|
|
51
|
-
- Synchronize state attributes with visual state: `aria-expanded`, `aria-selected`, `aria-checked`, `aria-disabled`.
|
|
52
|
-
- Add `aria-label` or `aria-labelledby` to interactive elements with no visible text label.
|
|
53
|
-
- Always provide `alt` on `<img>`. Use `alt=""` for decorative images.
|
|
54
|
-
- Describe the content or function of the image, not its appearance. Do not prefix with "Image of" or "Photo of".
|
|
55
|
-
- Alt text for functional images (icons, buttons) should describe the action, not the graphic.
|
|
56
|
-
- Give the visual boundary of a control and every graphic that carries meaning at least 3:1 contrast against adjacent colors (WCAG Non-text Contrast, 1.4.11).
|
|
57
|
-
- Never make color the only carrier of a state, error, or distinction. Pair it with text, an icon, or a pattern (WCAG Use of Color, 1.4.1).
|
|
27
|
+
- Give a control's visual boundary and every graphic that carries meaning at least 3:1 contrast against adjacent colors (WCAG 1.4.11).
|
|
28
|
+
- Never make color the only carrier of a state, error, or distinction. Pair it with text, an icon, or a pattern (WCAG 1.4.1).
|
|
58
29
|
|
|
59
30
|
## Reflow
|
|
60
31
|
|
|
61
|
-
- Let content reflow at
|
|
62
|
-
- Treat 320 as
|
|
63
|
-
- Hold the same 320 floor for the content region beside persistent chrome a person can resize.
|
|
32
|
+
- Let content reflow at 320 CSS pixels wide with no loss and no two-dimensional scrolling, except a data table, map, or diagram (WCAG 1.4.10).
|
|
33
|
+
- Treat 320 as a 1280 pixel window at 400 percent zoom rather than a device width, so a layout breaking there breaks for a person who zooms.
|
|
34
|
+
- Hold the same 320 floor for the content region beside persistent chrome a person can resize. This extends the criterion, which measures the viewport alone.
|
|
@@ -11,21 +11,18 @@ paths:
|
|
|
11
11
|
|
|
12
12
|
## Punctuation
|
|
13
13
|
|
|
14
|
-
-
|
|
15
|
-
-
|
|
14
|
+
- Write no em dash (`—`) or semicolon in rendered copy. Use a comma or a period, or restructure the sentence.
|
|
15
|
+
- Add no trailing punctuation to a button label or a short action string.
|
|
16
16
|
|
|
17
17
|
## Button copy
|
|
18
18
|
|
|
19
|
-
-
|
|
20
|
-
- Avoid padded phrasing: `Save` over `Save changes`, `Delete` over `Click to delete`.
|
|
19
|
+
- Label a button with the verb of the action it performs, such as `Save` or `Delete`, never with filler such as `Click to delete`.
|
|
21
20
|
|
|
22
21
|
## Error messages
|
|
23
22
|
|
|
24
|
-
-
|
|
25
|
-
- Keep
|
|
26
|
-
- One sentence maximum.
|
|
23
|
+
- Tell the person how to fix the error, such as `Enter an email address` over `Email is invalid`.
|
|
24
|
+
- Keep an error message to one short sentence in plain language, with no technical jargon or error codes.
|
|
27
25
|
|
|
28
26
|
## Placeholder text
|
|
29
27
|
|
|
30
|
-
-
|
|
31
|
-
- Reserve instructions for labels or helper text below the input.
|
|
28
|
+
- Never use placeholder text as a label, a hint, or an example. Put a format example such as `name@example.com` in hint text under the label.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: Form validation timing,
|
|
2
|
+
description: Form validation timing, submission, error placement, and derived state for rendered forms
|
|
3
3
|
paths:
|
|
4
4
|
- '**/*.tsx'
|
|
5
5
|
- '**/*.jsx'
|
|
@@ -11,35 +11,29 @@ paths:
|
|
|
11
11
|
|
|
12
12
|
## Validation timing
|
|
13
13
|
|
|
14
|
-
- Validate
|
|
15
|
-
-
|
|
16
|
-
- Apply the same validation timing to all fields in a form. Do not mix blur-only and change-only validation within one form.
|
|
17
|
-
- Do not show an error on a field the user has never touched.
|
|
14
|
+
- Validate when the person submits or continues, never when focus leaves a field. Realtime feedback the feature exists for, such as a character count, is the exception.
|
|
15
|
+
- Re-validate a field on every change once it shows an error, so the error clears as soon as the input is valid.
|
|
18
16
|
|
|
19
|
-
##
|
|
17
|
+
## Submission
|
|
20
18
|
|
|
21
|
-
-
|
|
22
|
-
- Treat whitespace-only values as empty for required fields.
|
|
19
|
+
- Refuse a submit while a required field is empty, whitespace-only, or invalid, and show each error. Keep the submit button enabled rather than disabling it.
|
|
23
20
|
|
|
24
21
|
## Error placement
|
|
25
22
|
|
|
26
|
-
- Show
|
|
27
|
-
-
|
|
28
|
-
|
|
29
|
-
## Submission errors
|
|
30
|
-
|
|
31
|
-
- When a failed submission carries several errors, move focus to a summary that links to each failing field. Keep the inline error beside each field.
|
|
23
|
+
- Show each error next to the field that caused it, never under an unrelated field.
|
|
24
|
+
- Show a cross-field conflict under the field the person edited, not under the field it conflicts with.
|
|
25
|
+
- Move focus to an error summary linking to each failing field when a submission fails, and keep the inline error beside each field.
|
|
32
26
|
|
|
33
27
|
## Authentication and re-entry
|
|
34
28
|
|
|
35
|
-
- Let a password manager fill sign-in fields and accept a pasted value.
|
|
36
|
-
-
|
|
29
|
+
- Let a password manager fill sign-in fields and accept a pasted value. Never block paste or autofill on a password or code field (WCAG 3.3.8).
|
|
30
|
+
- Never ask again for information the person gave earlier in the same flow. Prefill it or offer it for selection (WCAG 3.3.7).
|
|
37
31
|
|
|
38
32
|
## Input sanitization
|
|
39
33
|
|
|
40
|
-
- Trim leading and trailing whitespace from text
|
|
41
|
-
-
|
|
34
|
+
- Trim leading and trailing whitespace from a text input on submit, never on every keystroke.
|
|
35
|
+
- Say near a case-sensitive field that it is case-sensitive, rather than silently treating `Foo` and `foo` as different values.
|
|
42
36
|
|
|
43
37
|
## Derived display state
|
|
44
38
|
|
|
45
|
-
- Reset status
|
|
39
|
+
- Reset a status indicator, count, or derived value to neutral when its source input changes.
|
|
@@ -13,19 +13,17 @@ paths:
|
|
|
13
13
|
|
|
14
14
|
## Sentence case
|
|
15
15
|
|
|
16
|
-
- Use sentence case for
|
|
17
|
-
-
|
|
18
|
-
- Treat title case on every heading as a template tell, since it reads as a default rather than a choice.
|
|
16
|
+
- Use sentence case for rendered headings, labels, nav items, tab titles, and dialog titles, since title case on every heading reads as a template default.
|
|
17
|
+
- Keep the original casing of a proper noun or product name, such as `GitHub`, `macOS`, or `TypeScript`.
|
|
19
18
|
|
|
20
19
|
## Uppercase labels
|
|
21
20
|
|
|
22
|
-
- Keep small uppercase labels above headings to
|
|
23
|
-
- Treat the count as a judgment, since a glob cannot check it.
|
|
21
|
+
- Keep small uppercase labels above headings to `ceil(sections / 3)`, the first screen counting as one. Delete the extra labels, since position already names a section.
|
|
24
22
|
|
|
25
23
|
## Where it applies
|
|
26
24
|
|
|
27
|
-
-
|
|
25
|
+
- Apply the same casing to interface copy kept outside the globs, such as a locale file, which this rule never fires on.
|
|
28
26
|
|
|
29
27
|
## Overriding
|
|
30
28
|
|
|
31
|
-
- Depart from sentence case where the case needs it, such as an acronym, a brand mark, or a set-in-caps identity the design chose on purpose.
|
|
29
|
+
- Depart from sentence case only where the case needs it, such as an acronym, a brand mark, or a set-in-caps identity the design chose on purpose.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Focus styles, keyboard operation, focus management, and pointer targets for rendered UI
|
|
3
|
+
paths:
|
|
4
|
+
- '**/*.tsx'
|
|
5
|
+
- '**/*.jsx'
|
|
6
|
+
- '**/*.astro'
|
|
7
|
+
- '**/*.html'
|
|
8
|
+
- '**/*.css'
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Keyboard and focus standards
|
|
12
|
+
|
|
13
|
+
## Focus styles
|
|
14
|
+
|
|
15
|
+
- Style focus through the project's one focus ring rather than a per-component focus style.
|
|
16
|
+
- Never set `outline: none` or `outline-none` without a replacement focus indicator in the same rule.
|
|
17
|
+
- Give the focus ring 3:1 contrast against its background in every theme the project ships.
|
|
18
|
+
|
|
19
|
+
## Keyboard operation
|
|
20
|
+
|
|
21
|
+
- Close a dialog, popover, menu, or inline confirmation on Escape, and cancel an in-progress edit the same way.
|
|
22
|
+
- Bind no single printable character as a shortcut unless a person can turn it off or remap it, or it fires only while its control has focus (WCAG 2.1.4).
|
|
23
|
+
- Give every author-defined drag a single-pointer alternative and a keyboard path, such as move buttons or arrow-key reordering (WCAG 2.5.7).
|
|
24
|
+
|
|
25
|
+
## Composite widgets
|
|
26
|
+
|
|
27
|
+
- Keep one item of a composite widget in the tab sequence, and move between its items with the arrow keys through roving `tabindex` or `aria-activedescendant`.
|
|
28
|
+
- Open a combobox popup on Down Arrow, accept the focused option on Enter, and close the popup on Escape without changing the value.
|
|
29
|
+
|
|
30
|
+
## Focus management
|
|
31
|
+
|
|
32
|
+
- Move focus into a dialog when it opens, and return it to the element that opened it when it closes.
|
|
33
|
+
- Never let a sticky header, footer, or overlay fully cover the focused control. Scroll it clear of them (WCAG 2.4.11).
|
|
34
|
+
|
|
35
|
+
## Pointer targets
|
|
36
|
+
|
|
37
|
+
- Size a web pointer target at least 24 by 24 CSS pixels, or space it so a 24 pixel circle centered on it touches no other target (WCAG 2.5.8).
|
|
38
|
+
- Size a native touch target at the platform figure, 44 points on iOS and 48 dp on Android, and never swap the web and native figures.
|