@erclx/canon 5.42.0 → 5.44.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.
Files changed (195) hide show
  1. package/claude/.claude-plugin/plugin.json +1 -1
  2. package/claude/skills/auto-ship/SKILL.md +3 -3
  3. package/claude/skills/backlog-triage/references/apply.md +6 -6
  4. package/claude/skills/canon-cli/SKILL.md +4 -4
  5. package/claude/skills/canvas-board/REQUIREMENT.md +1 -1
  6. package/claude/skills/canvas-board/SKILL.md +1 -1
  7. package/claude/skills/ci-workflow/REQUIREMENT.md +2 -1
  8. package/claude/skills/ci-workflow/SKILL.md +12 -2
  9. package/claude/skills/ci-workflow/references/workflows.md +12 -9
  10. package/claude/skills/context-fold/references/context.md +1 -1
  11. package/claude/skills/create-rule/SKILL.md +1 -0
  12. package/claude/skills/create-skill/REQUIREMENT.md +1 -1
  13. package/claude/skills/create-skill/SKILL.md +2 -2
  14. package/claude/skills/create-skill/references/skill-requirement.md +68 -9
  15. package/claude/skills/create-skill/references/skill.md +1 -1
  16. package/claude/skills/decision-escalate/SKILL.md +1 -2
  17. package/claude/skills/design-identity/REQUIREMENT.md +40 -0
  18. package/claude/skills/design-identity/SKILL.md +138 -0
  19. package/claude/skills/{draft-identity → design-identity}/references/card-route.md +2 -2
  20. package/claude/skills/design-taste/REQUIREMENT.md +4 -4
  21. package/claude/skills/design-taste/SKILL.md +2 -2
  22. package/claude/skills/design-taste/references/kinds.md +1 -1
  23. package/claude/skills/design-taste/references/preflight.md +1 -1
  24. package/claude/skills/document-health/references/axes.md +2 -1
  25. package/claude/skills/draft-and-pick/REQUIREMENT.md +8 -69
  26. package/claude/skills/draft-and-pick/SKILL.md +3 -153
  27. package/claude/skills/draft-doc/REQUIREMENT.md +9 -30
  28. package/claude/skills/draft-doc/SKILL.md +4 -76
  29. package/claude/skills/draft-figure/REQUIREMENT.md +8 -42
  30. package/claude/skills/draft-figure/SKILL.md +3 -77
  31. package/claude/skills/draft-identity/REQUIREMENT.md +8 -23
  32. package/claude/skills/draft-identity/SKILL.md +3 -130
  33. package/claude/skills/draft-ready/REQUIREMENT.md +8 -37
  34. package/claude/skills/draft-ready/SKILL.md +3 -128
  35. package/claude/skills/draft-screencast/REQUIREMENT.md +8 -23
  36. package/claude/skills/draft-screencast/SKILL.md +3 -62
  37. package/claude/skills/draft-slides/REQUIREMENT.md +8 -27
  38. package/claude/skills/draft-slides/SKILL.md +3 -72
  39. package/claude/skills/draw-figure/REQUIREMENT.md +59 -0
  40. package/claude/skills/draw-figure/SKILL.md +85 -0
  41. package/claude/skills/{draft-figure → draw-figure}/references/architecture-set.md +2 -2
  42. package/claude/skills/{draft-figure → draw-figure}/references/hand-drawn.md +2 -2
  43. package/claude/skills/{draft-figure → draw-figure}/references/mermaid-path.md +2 -2
  44. package/claude/skills/{draft-figure → draw-figure}/references/mermaid.md +1 -1
  45. package/claude/skills/git-commit/references/commit.md +1 -5
  46. package/claude/skills/git-pr/references/pr.md +1 -0
  47. package/claude/skills/make-deck/REQUIREMENT.md +44 -0
  48. package/claude/skills/make-deck/SKILL.md +80 -0
  49. package/claude/skills/markdown-craft/REQUIREMENT.md +1 -1
  50. package/claude/skills/markdown-craft/SKILL.md +2 -2
  51. package/claude/skills/pick-by-eye/REQUIREMENT.md +86 -0
  52. package/claude/skills/pick-by-eye/SKILL.md +161 -0
  53. package/claude/skills/plan-feature/SKILL.md +3 -2
  54. package/claude/skills/plan-feature/references/plan.md +25 -11
  55. package/claude/skills/plan-groundwork/SKILL.md +1 -1
  56. package/claude/skills/plan-intake/SKILL.md +1 -1
  57. package/claude/skills/plan-ready/REQUIREMENT.md +54 -0
  58. package/claude/skills/plan-ready/SKILL.md +136 -0
  59. package/claude/skills/{draft-ready → plan-ready}/references/assembly.md +1 -1
  60. package/claude/skills/{draft-ready → plan-ready}/references/ready.md +1 -1
  61. package/claude/skills/pr-evidence/references/evidence.md +1 -1
  62. package/claude/skills/record-screencast/REQUIREMENT.md +3 -3
  63. package/claude/skills/record-screencast/SKILL.md +2 -2
  64. package/claude/skills/role-orchestrator/REQUIREMENT.md +1 -1
  65. package/claude/skills/role-orchestrator/SKILL.md +2 -0
  66. package/claude/skills/role-orchestrator/references/orchestrator-dispatch.md +5 -2
  67. package/claude/skills/role-orchestrator/references/orchestrator-output.md +4 -0
  68. package/claude/skills/role-orchestrator/references/orchestrator-parked.md +2 -2
  69. package/claude/skills/role-orchestrator/references/orchestrator-refill.md +18 -13
  70. package/claude/skills/role-planner/REQUIREMENT.md +1 -1
  71. package/claude/skills/role-planner/SKILL.md +5 -4
  72. package/claude/skills/role-worker/REQUIREMENT.md +2 -0
  73. package/claude/skills/role-worker/SKILL.md +35 -2
  74. package/claude/skills/script-screencast/REQUIREMENT.md +40 -0
  75. package/claude/skills/script-screencast/SKILL.md +70 -0
  76. package/claude/skills/{draft-screencast → script-screencast}/references/beats-template.md +2 -2
  77. package/claude/skills/search-craft/REQUIREMENT.md +4 -4
  78. package/claude/skills/search-craft/SKILL.md +2 -2
  79. package/claude/skills/target-setup/SKILL.md +1 -0
  80. package/claude/skills/task-board/SKILL.md +11 -9
  81. package/claude/skills/task-board/references/board.md +15 -12
  82. package/claude/skills/teach-workspace/SKILL.md +1 -1
  83. package/claude/skills/teach-workspace/references/lesson-craft.md +2 -2
  84. package/claude/skills/ui-checklist/SKILL.md +2 -0
  85. package/claude/skills/write-doc/REQUIREMENT.md +46 -0
  86. package/claude/skills/write-doc/SKILL.md +83 -0
  87. package/claude/skills/{draft-doc → write-doc}/references/context.md +2 -2
  88. package/claude/skills/{draft-doc → write-doc}/references/docs.md +2 -2
  89. package/claude/skills/{draft-doc → write-doc}/references/readme.md +2 -2
  90. package/claude/skills/{draft-doc → write-doc}/references/wiki-kind.md +4 -4
  91. package/claude/skills/{draft-doc → write-doc}/references/wiki.md +1 -1
  92. package/docs/agents/audits.md +1 -0
  93. package/docs/agents/markdown-audit.md +4 -2
  94. package/docs/agents/migrate.md +13 -10
  95. package/docs/target/migrations.md +28 -4
  96. package/docs/target/projects.md +1 -1
  97. package/docs/workflow/parallel-features.md +3 -2
  98. package/docs/workflow/skill-map-on-request.md +18 -12
  99. package/docs/workflow/skill-map.md +13 -12
  100. package/docs/workflow/visual-design-workflow.md +2 -2
  101. package/governance/detect.toml +4 -0
  102. package/governance/ledger/framework/astro.md +73 -0
  103. package/governance/ledger/framework/fastapi.md +76 -0
  104. package/governance/ledger/framework/nextjs.md +86 -0
  105. package/governance/ledger/framework/react.md +83 -0
  106. package/governance/ledger/framework/shadcn.md +60 -0
  107. package/governance/ledger/framework/tailwind.md +55 -0
  108. package/governance/rules/canon/context.md +2 -1
  109. package/governance/rules/canon/plan.md +3 -5
  110. package/governance/rules/canon/scratch.md +3 -1
  111. package/governance/rules/canon/task-scope.md +2 -1
  112. package/governance/rules/canon/tasks.md +2 -1
  113. package/governance/rules/canon/worktrees.md +5 -2
  114. package/governance/rules/claude/output.md +7 -4
  115. package/governance/rules/claude/skill.md +6 -4
  116. package/governance/rules/framework/astro.md +12 -14
  117. package/governance/rules/framework/fastapi.md +20 -24
  118. package/governance/rules/framework/nextjs.md +19 -27
  119. package/governance/rules/framework/react.md +22 -33
  120. package/governance/rules/framework/shadcn.md +11 -15
  121. package/governance/rules/framework/tailwind.md +12 -14
  122. package/governance/rules/tooling/ci-workflow.md +6 -39
  123. package/governance/rules/ui/design-reference.md +37 -0
  124. package/governance/rules/writing/markdown.md +3 -2
  125. package/package.json +6 -6
  126. package/src/audits/catalog.ts +42 -0
  127. package/src/claude/cases/authoring.ts +15 -3
  128. package/src/claude/cases/misc.ts +12 -0
  129. package/src/claude/cases/workflow.ts +19 -1
  130. package/src/claude/settings.ts +8 -4
  131. package/src/claude/skills-audit.ts +113 -1
  132. package/src/commands/claude.ts +45 -12
  133. package/src/commands/demo.ts +1 -1
  134. package/src/commands/gov.ts +198 -0
  135. package/src/commands/markdown.ts +1 -1
  136. package/src/commands/migrate.ts +125 -2
  137. package/src/commands/pr.ts +34 -83
  138. package/src/commands/tasks.ts +383 -2
  139. package/src/commands/tooling.ts +3 -3
  140. package/src/commands/worktrees.ts +49 -0
  141. package/src/context/audit.ts +1 -1
  142. package/src/demo/beats.ts +1 -1
  143. package/src/gate/stages.ts +15 -0
  144. package/src/gov/audit.ts +441 -0
  145. package/src/listeners/belongs.ts +21 -0
  146. package/src/listeners/machine.ts +93 -0
  147. package/src/listeners/parse.ts +41 -0
  148. package/src/markdown/scope.ts +45 -35
  149. package/src/migrate/record-layout.ts +1 -1
  150. package/src/migrate/session-defaults.ts +138 -0
  151. package/src/migrate/skill-names.ts +68 -21
  152. package/src/pr/frames.ts +14 -3
  153. package/src/pr/local.ts +4 -69
  154. package/src/records/validate.ts +31 -0
  155. package/src/sync/check.ts +15 -0
  156. package/src/tasks/board.ts +854 -0
  157. package/src/tasks/record.ts +20 -1
  158. package/src/tasks/validate.ts +206 -9
  159. package/src/tooling/stamp.ts +56 -12
  160. package/src/worktrees/stop.ts +92 -0
  161. package/tooling/astro/configs/card-src/pages/og-card.astro +1 -1
  162. package/tooling/astro/reference.md +2 -2
  163. package/tooling/base/configs/.github/workflows/phase-label-gate.yml +6 -2
  164. package/tooling/base/configs/commitlint.config.js +0 -20
  165. package/tooling/base/reference.md +1 -1
  166. package/tooling/base/seeds/.github/workflows/verify.yml +4 -1
  167. package/tooling/claude/reference.md +13 -7
  168. package/tooling/claude/seeds/.claude/hooks/board-validate.sh +65 -0
  169. package/tooling/claude/seeds/.claude/settings.json +8 -0
  170. package/tooling/claude/user/settings.template.json +0 -4
  171. package/tooling/cloudflare/configs/.github/workflows/deploy.yml +5 -5
  172. package/tooling/public/configs/.github/dependabot.yml +12 -0
  173. package/tooling/public/configs/.github/workflows/release-please.yml +30 -0
  174. package/tooling/public/manifest.toml +8 -0
  175. package/tooling/public/reference.md +53 -0
  176. package/tooling/public/seeds/.github/ISSUE_TEMPLATE/bug.yml +48 -0
  177. package/tooling/public/seeds/.github/ISSUE_TEMPLATE/config.yml +5 -0
  178. package/tooling/public/seeds/.github/ISSUE_TEMPLATE/feature.yml +16 -0
  179. package/tooling/public/seeds/.release-please-manifest.json +3 -0
  180. package/tooling/public/seeds/CONTRIBUTING.md +50 -0
  181. package/tooling/public/seeds/LICENSE +21 -0
  182. package/tooling/public/seeds/SECURITY.md +13 -0
  183. package/tooling/public/seeds/release-please-config.json +12 -0
  184. package/tooling/shell/configs/.github/workflows/shell.yml +4 -1
  185. package/tooling/web/configs/.github/workflows/readme-screenshot.yml +6 -3
  186. package/tooling/web/configs/.github/workflows/verify.yml +15 -12
  187. /package/claude/skills/{draft-figure → draw-figure}/references/figures.md +0 -0
  188. /package/claude/skills/{draft-slides → make-deck}/references/deck.md +0 -0
  189. /package/claude/skills/{draft-and-pick → pick-by-eye}/references/live-arms.md +0 -0
  190. /package/claude/skills/{draft-doc → write-doc}/references/readme/agent-facing.md +0 -0
  191. /package/claude/skills/{draft-doc → write-doc}/references/readme/application.md +0 -0
  192. /package/claude/skills/{draft-doc → write-doc}/references/readme/cli.md +0 -0
  193. /package/claude/skills/{draft-doc → write-doc}/references/readme/library.md +0 -0
  194. /package/claude/skills/{draft-doc → write-doc}/references/readme/plugin.md +0 -0
  195. /package/claude/skills/{draft-doc → write-doc}/references/requirements.md +0 -0
@@ -0,0 +1,65 @@
1
+ #!/usr/bin/env bash
2
+
3
+ # Reports what `canon tasks validate` finds after an edit to the task board's
4
+ # ordering file, so a hand edit that broke a table or drifted a derived cell is
5
+ # named in the turn that made it.
6
+ #
7
+ # It reports and never blocks. The board verbs do not yet cover every move a
8
+ # controller makes by hand, so a block here would stop work the verbs cannot
9
+ # yet do. A `Bash` write fires no `PostToolUse` hook for a file, so a heredoc
10
+ # write stays unchecked until the next validate run.
11
+
12
+ # Claude Code sends a payload and closes stdin. A bare read with nothing feeding
13
+ # it blocks forever and holds the session open, so the read is bounded. `read`
14
+ # rather than `timeout cat`, which macOS does not ship.
15
+ IFS= read -r -d '' -t 2 input
16
+ [ -n "$input" ] || {
17
+ printf '%s reads a Claude Code hook payload on stdin and cannot be run by hand.\n' "${0##*/}" >&2
18
+ exit 1
19
+ }
20
+
21
+ tool=$(printf '%s' "$input" | jq -r '.tool_name // empty')
22
+ case "$tool" in
23
+ Write | Edit | MultiEdit) ;;
24
+ *) exit 0 ;;
25
+ esac
26
+
27
+ file_path=$(printf '%s' "$input" | jq -r '.tool_input.file_path // empty')
28
+
29
+ # Both record roots, since a project the move has reached keeps its records
30
+ # under `.canon/`. The root comes from the path rather than the session, since
31
+ # the board resolves at the main worktree root and a linked worktree's session
32
+ # edits it from outside its own project directory.
33
+ case "$file_path" in
34
+ */.canon/tasks/priority.md) base=.canon ;;
35
+ */.claude/tasks/priority.md) base=.claude ;;
36
+ *) exit 0 ;;
37
+ esac
38
+ root="${file_path%/"$base"/tasks/priority.md}"
39
+ [ -n "$root" ] || exit 0
40
+
41
+ report() {
42
+ jq -nc --arg msg "$1" \
43
+ '{hookSpecificOutput:{hookEventName:"PostToolUse",additionalContext:$msg}}'
44
+ exit 0
45
+ }
46
+
47
+ if ! command -v canon >/dev/null 2>&1; then
48
+ report "canon is not on PATH, so the board edit was not validated. Run canon tasks validate by hand."
49
+ fi
50
+
51
+ # Exit 2 carries findings, so the status is read off the record rather than
52
+ # the exit code.
53
+ record=$(canon tasks validate --json --root "$root" 2>/dev/null)
54
+ ok=$(printf '%s' "$record" | jq -r '.ok // empty' 2>/dev/null)
55
+
56
+ if [ "$ok" = false ]; then
57
+ report "canon tasks validate refused the board after this edit: $(printf '%s' "$record" | jq -r '.message // .reason')"
58
+ fi
59
+ [ "$ok" = true ] || report "canon tasks validate wrote no record after this edit, so the board was not validated."
60
+
61
+ findings=$(printf '%s' "$record" | jq -r '.findings[] | "- \(.kind): \(.subject) \(.message)"' | head -10)
62
+ [ -n "$findings" ] || exit 0
63
+
64
+ report "The board edit left findings. Rewrite the rows through canon tasks place, promote, move, or block, which derive every cell but Waiting on.
65
+ $findings"
@@ -1,4 +1,8 @@
1
1
  {
2
+ "autoMemoryEnabled": false,
3
+ "permissions": {
4
+ "deny": ["Agent", "Task"]
5
+ },
2
6
  "hooks": {
3
7
  "PreToolUse": [
4
8
  {
@@ -50,6 +54,10 @@
50
54
  "type": "command",
51
55
  "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/records-index.sh"
52
56
  },
57
+ {
58
+ "type": "command",
59
+ "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/board-validate.sh"
60
+ },
53
61
  {
54
62
  "type": "command",
55
63
  "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/path-form.sh"
@@ -1,8 +1,4 @@
1
1
  {
2
- "attribution": {
3
- "commit": "",
4
- "pr": ""
5
- },
6
2
  "permissions": {
7
3
  "allow": ["Bash(bun run *)"],
8
4
  "deny": ["Read(**/.env)", "Read(**/.env.*)"]
@@ -36,7 +36,7 @@ jobs:
36
36
  runs-on: ubuntu-latest
37
37
  steps:
38
38
  - name: Checkout
39
- uses: actions/checkout@v4
39
+ uses: actions/checkout@v7
40
40
 
41
41
  - name: Setup Bun
42
42
  uses: oven-sh/setup-bun@v2
@@ -50,7 +50,7 @@ jobs:
50
50
  run: bun run build
51
51
 
52
52
  - name: Upload artifact
53
- uses: actions/upload-artifact@v4
53
+ uses: actions/upload-artifact@v7
54
54
  with:
55
55
  name: dist
56
56
  path: dist
@@ -84,7 +84,7 @@ jobs:
84
84
  # as dead weight breaks the deploy on every push.
85
85
  - name: Checkout
86
86
  if: steps.secrets-check.outputs.skip == 'false'
87
- uses: actions/checkout@v4
87
+ uses: actions/checkout@v7
88
88
 
89
89
  - name: Setup Bun
90
90
  if: steps.secrets-check.outputs.skip == 'false'
@@ -94,7 +94,7 @@ jobs:
94
94
 
95
95
  - name: Download artifact
96
96
  if: steps.secrets-check.outputs.skip == 'false'
97
- uses: actions/download-artifact@v4
97
+ uses: actions/download-artifact@v8
98
98
  with:
99
99
  name: dist
100
100
  path: dist
@@ -104,7 +104,7 @@ jobs:
104
104
  - name: Publish
105
105
  id: publish
106
106
  if: steps.secrets-check.outputs.skip == 'false'
107
- uses: cloudflare/wrangler-action@v3
107
+ uses: cloudflare/wrangler-action@v4
108
108
  with:
109
109
  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
110
110
  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
@@ -0,0 +1,12 @@
1
+ # canon-no-seed: an add-on stack's config with no root counterpart by design.
2
+ version: 2
3
+ updates:
4
+ - package-ecosystem: github-actions
5
+ directory: /
6
+ schedule:
7
+ interval: weekly
8
+ commit-message:
9
+ prefix: ci
10
+ groups:
11
+ actions:
12
+ update-types: [minor, patch]
@@ -0,0 +1,30 @@
1
+ name: Release
2
+ # canon-no-seed: an add-on stack's workflow with no root counterpart by design, since the toolkit cuts its own releases through its own workflow.
3
+
4
+ on:
5
+ push:
6
+ branches:
7
+ - main
8
+
9
+ permissions:
10
+ contents: read
11
+
12
+ jobs:
13
+ release-please:
14
+ name: 🏷️ Release Please
15
+ runs-on: ubuntu-latest
16
+ permissions:
17
+ contents: write
18
+ pull-requests: write
19
+ # Queues rather than cancels, since a cancel can land after the release exists and before its outputs do
20
+ concurrency:
21
+ group: release-please
22
+ cancel-in-progress: false
23
+ steps:
24
+ - name: Release Please
25
+ uses: googleapis/release-please-action@v5
26
+ with:
27
+ # A personal token lets CI run on the release pull request, which the default token's bot author does not
28
+ token: ${{ secrets.RELEASE_PLEASE_TOKEN || github.token }}
29
+ config-file: release-please-config.json
30
+ manifest-file: .release-please-manifest.json
@@ -0,0 +1,8 @@
1
+ [stack]
2
+ name = "public"
3
+ extends = ""
4
+ runtime = "bun"
5
+ scaffold = ""
6
+
7
+ [sync]
8
+ source = "configs"
@@ -0,0 +1,53 @@
1
+ # Tooling public reference
2
+
3
+ ## Overview
4
+
5
+ The public stack is an add-on that ships the open-source files a public repository carries. It extends nothing and syncs beside any other stack at the same root with `canon tooling sync public . --write`.
6
+
7
+ ## Seeds
8
+
9
+ A seed is copied only when its path is absent, so a project's filled `LICENSE`, `SECURITY.md`, or `CONTRIBUTING.md` is never overwritten. Fill each `<placeholder>` after the first sync.
10
+
11
+ ### Policy files
12
+
13
+ These three name the project's owner and terms.
14
+
15
+ - Use MIT for `LICENSE`, which needs a year and a holder. Swap the text by hand for a different license.
16
+ - Point `SECURITY.md` and the issue chooser at GitHub private vulnerability reporting only, with no email.
17
+ - Switch private reporting on under the repository's Settings, Code security.
18
+ - Ship no `CODE_OF_CONDUCT.md`. Add one when outside contributors arrive.
19
+
20
+ ### Issue forms
21
+
22
+ `bug.yml`, `feature.yml`, and `config.yml` turn blank issues off.
23
+
24
+ - Add fields specific to the project, such as its CLI's version command, by hand.
25
+
26
+ ### Release files
27
+
28
+ These two start release-please at version zero.
29
+
30
+ - Start `release-please-config.json` on the `simple` release type, with `initial-version` `0.0.1` and `bump-minor-pre-major` on.
31
+ - Switch the type and add `extra-files` for a package that carries its version in a manifest.
32
+ - Start `.release-please-manifest.json` at `0.0.0`.
33
+
34
+ ## Release workflow
35
+
36
+ `release-please.yml` is a config, so each sync overwrites it and a fix reaches every public repository.
37
+
38
+ - Run it on every push to `main`. It keeps one release pull request open and tags the release when that pull request merges.
39
+ - Publish nothing. A project that publishes a package adds its own workflow keyed on the release, and never edits this one.
40
+ - Open the release pull request with `RELEASE_PLEASE_TOKEN` when the secret exists, and fall back to the default token otherwise.
41
+ - Set the secret to a personal token so CI runs on the release pull request, since the default token's author does not start it.
42
+ - Keep the token read-only at the top, with `contents: write` and `pull-requests: write` on the one job.
43
+
44
+ ## Dependabot
45
+
46
+ `dependabot.yml` is how an existing repository keeps its seeded workflows' action majors current, since a seed never updates after install.
47
+
48
+ - Update `github-actions` weekly with an `ci` commit prefix.
49
+ - Group minor and patch updates into one pull request per run, and leave majors ungrouped so each arrives alone.
50
+
51
+ ## Beside another stack
52
+
53
+ Run `canon tooling sync public . --write` on a repository that already carries a stack. The install stamp keeps the core chain and lists the add-on after it.
@@ -0,0 +1,48 @@
1
+ name: Bug report
2
+ description: Something does not work as expected
3
+ labels: [bug]
4
+ body:
5
+ - type: textarea
6
+ id: what-happened
7
+ attributes:
8
+ label: What happened
9
+ description: What you did, what you expected, and what happened instead.
10
+ validations:
11
+ required: true
12
+ - type: textarea
13
+ id: steps
14
+ attributes:
15
+ label: Steps to reproduce
16
+ placeholder: |
17
+ 1. Run `<command>`
18
+ 2. ...
19
+ validations:
20
+ required: true
21
+ - type: textarea
22
+ id: reproduction
23
+ attributes:
24
+ label: Minimal reproduction
25
+ description: The smallest input that shows the problem. Paste it, or link a repository or gist.
26
+ validations:
27
+ required: true
28
+ - type: input
29
+ id: version
30
+ attributes:
31
+ label: Version
32
+ description: The release or commit you ran.
33
+ validations:
34
+ required: true
35
+ - type: input
36
+ id: runtime
37
+ attributes:
38
+ label: Runtime and version
39
+ placeholder: Node 22.12.0, or Bun 1.3.0
40
+ validations:
41
+ required: true
42
+ - type: input
43
+ id: os
44
+ attributes:
45
+ label: Operating system
46
+ placeholder: macOS 26.1, Windows 11, Ubuntu 24.04
47
+ validations:
48
+ required: true
@@ -0,0 +1,5 @@
1
+ blank_issues_enabled: false
2
+ contact_links:
3
+ - name: Report a security vulnerability
4
+ url: https://github.com/<owner>/<repo>/security/advisories/new
5
+ about: Report it privately rather than in a public issue.
@@ -0,0 +1,16 @@
1
+ name: Feature request
2
+ description: Suggest something this project should do
3
+ labels: [enhancement]
4
+ body:
5
+ - type: textarea
6
+ id: job
7
+ attributes:
8
+ label: The job
9
+ description: What you were trying to get done when the project fell short, and how you work around it today.
10
+ validations:
11
+ required: true
12
+ - type: textarea
13
+ id: proposal
14
+ attributes:
15
+ label: What you would like
16
+ description: The behavior you have in mind, if you have one.
@@ -0,0 +1,3 @@
1
+ {
2
+ ".": "0.0.0"
3
+ }
@@ -0,0 +1,50 @@
1
+ # Contributing to <project>
2
+
3
+ This page covers getting a working checkout, how to test a change, and the commit and pull request rules the hooks enforce.
4
+
5
+ ## Setup
6
+
7
+ <Prerequisites, such as the runtime and its minimum version.>
8
+
9
+ ```bash
10
+ git clone https://github.com/<owner>/<repo>.git
11
+ cd <repo>
12
+ <install command>
13
+ <check command>
14
+ ```
15
+
16
+ <What the install step activates, such as git hooks, and what the check command runs.>
17
+
18
+ ## Layout
19
+
20
+ | Path | What it holds |
21
+ | -------- | ------------- |
22
+ | `<path>` | <role> |
23
+
24
+ ## Tests
25
+
26
+ <The commands that run the tests and what each one covers.>
27
+
28
+ ## Commit messages
29
+
30
+ Commits follow [Conventional Commits](https://www.conventionalcommits.org), and release-please reads them to cut each release.
31
+
32
+ - The header reads `<type>(<scope>): <subject>`, such as `fix(server): close the socket on shutdown`
33
+ - The header is at most 72 characters
34
+ - The first word of the subject is lowercase, and the subject ends with no period
35
+
36
+ The types are `feat`, `fix`, `refactor`, `docs`, `chore`, `perf`, `test`, `style`, `build`, `ci`, and `revert`.
37
+
38
+ ## Pull requests
39
+
40
+ Branch from `main` and open the pull request against it. Say what the change does and why, which files it touches, and how you tested it.
41
+
42
+ CI runs on every pull request, and a pull request merges once it passes. Keep each one to a single concern. A refactor that a feature needs reads better as its own pull request ahead of the feature.
43
+
44
+ ## Releases
45
+
46
+ release-please cuts every release from the conventional commits on `main`. Each push to `main` keeps one release pull request open, holding the next version and its `CHANGELOG.md` entry. Merging that pull request tags the release.
47
+
48
+ ## AI-assisted contributions
49
+
50
+ Contributions written with a coding agent are welcome. You are the author of what you submit, so read every line before you open the pull request and be ready to explain it.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) <year> <holder>
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,13 @@
1
+ # Security policy
2
+
3
+ <One sentence on what in this project is security-sensitive.>
4
+
5
+ ## Reporting a vulnerability
6
+
7
+ Report it privately through GitHub's [private vulnerability reporting](https://github.com/<owner>/<repo>/security/advisories/new). Do not open a public issue for it.
8
+
9
+ Include the version, your OS, and the steps that reproduce the problem. You get a reply in the advisory thread.
10
+
11
+ ## Supported versions
12
+
13
+ Only the latest release receives fixes.
@@ -0,0 +1,12 @@
1
+ {
2
+ "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
3
+ "include-component-in-tag": false,
4
+ "packages": {
5
+ ".": {
6
+ "release-type": "simple",
7
+ "changelog-path": "CHANGELOG.md",
8
+ "initial-version": "0.0.1",
9
+ "bump-minor-pre-major": true
10
+ }
11
+ }
12
+ }
@@ -7,13 +7,16 @@ on:
7
7
  - main
8
8
  workflow_dispatch:
9
9
 
10
+ permissions:
11
+ contents: read
12
+
10
13
  jobs:
11
14
  shell-checks:
12
15
  name: 🐚 Shell Checks
13
16
  runs-on: ubuntu-latest
14
17
  steps:
15
18
  - name: Checkout
16
- uses: actions/checkout@v4
19
+ uses: actions/checkout@v7
17
20
 
18
21
  - name: Setup Bun
19
22
  uses: oven-sh/setup-bun@v2
@@ -20,6 +20,9 @@ concurrency:
20
20
  group: readme-screenshot-${{ github.ref }}
21
21
  cancel-in-progress: true
22
22
 
23
+ permissions:
24
+ contents: read
25
+
23
26
  jobs:
24
27
  capture:
25
28
  name: 🖼️ Refresh README Screenshot
@@ -32,7 +35,7 @@ jobs:
32
35
  contents: write
33
36
  steps:
34
37
  - name: Checkout
35
- uses: actions/checkout@v4
38
+ uses: actions/checkout@v7
36
39
  with:
37
40
  ref: ${{ github.head_ref }}
38
41
 
@@ -48,7 +51,7 @@ jobs:
48
51
  fi
49
52
 
50
53
  - name: Setup Node
51
- uses: actions/setup-node@v4
54
+ uses: actions/setup-node@v7
52
55
  with:
53
56
  node-version: '22'
54
57
 
@@ -62,7 +65,7 @@ jobs:
62
65
 
63
66
  - name: Cache Playwright Browser
64
67
  id: playwright-cache
65
- uses: actions/cache@v4
68
+ uses: actions/cache@v6
66
69
  with:
67
70
  path: ~/.cache/ms-playwright
68
71
  key: playwright-${{ runner.os }}-chromium-${{ hashFiles('**/package.json') }}
@@ -9,16 +9,19 @@ concurrency:
9
9
  group: verify-${{ github.ref }}
10
10
  cancel-in-progress: true
11
11
 
12
+ permissions:
13
+ contents: read
14
+
12
15
  jobs:
13
16
  static-checks:
14
17
  name: 🔍 Static Checks
15
18
  runs-on: ubuntu-latest
16
19
  steps:
17
20
  - name: Checkout
18
- uses: actions/checkout@v4
21
+ uses: actions/checkout@v7
19
22
 
20
23
  - name: Setup Node
21
- uses: actions/setup-node@v4
24
+ uses: actions/setup-node@v7
22
25
  with:
23
26
  node-version: '22'
24
27
 
@@ -44,10 +47,10 @@ jobs:
44
47
  runs-on: ubuntu-latest
45
48
  steps:
46
49
  - name: Checkout
47
- uses: actions/checkout@v4
50
+ uses: actions/checkout@v7
48
51
 
49
52
  - name: Setup Node
50
- uses: actions/setup-node@v4
53
+ uses: actions/setup-node@v7
51
54
  with:
52
55
  node-version: '22'
53
56
 
@@ -67,10 +70,10 @@ jobs:
67
70
  runs-on: ubuntu-latest
68
71
  steps:
69
72
  - name: Checkout
70
- uses: actions/checkout@v4
73
+ uses: actions/checkout@v7
71
74
 
72
75
  - name: Setup Node
73
- uses: actions/setup-node@v4
76
+ uses: actions/setup-node@v7
74
77
  with:
75
78
  node-version: '22'
76
79
 
@@ -86,7 +89,7 @@ jobs:
86
89
  run: bun run build
87
90
 
88
91
  - name: Upload Build Output
89
- uses: actions/upload-artifact@v4
92
+ uses: actions/upload-artifact@v7
90
93
  with:
91
94
  name: build-output
92
95
  path: dist/
@@ -98,10 +101,10 @@ jobs:
98
101
  needs: [static-checks, unit-tests, build-verify]
99
102
  steps:
100
103
  - name: Checkout
101
- uses: actions/checkout@v4
104
+ uses: actions/checkout@v7
102
105
 
103
106
  - name: Setup Node
104
- uses: actions/setup-node@v4
107
+ uses: actions/setup-node@v7
105
108
  with:
106
109
  node-version: '22'
107
110
 
@@ -114,7 +117,7 @@ jobs:
114
117
  run: bun install --frozen-lockfile
115
118
 
116
119
  - name: Download Build Output
117
- uses: actions/download-artifact@v4
120
+ uses: actions/download-artifact@v8
118
121
  with:
119
122
  name: build-output
120
123
  path: dist/
@@ -124,7 +127,7 @@ jobs:
124
127
 
125
128
  - name: Cache Playwright Browsers
126
129
  id: playwright-cache
127
- uses: actions/cache@v4
130
+ uses: actions/cache@v6
128
131
  with:
129
132
  path: ~/.cache/ms-playwright
130
133
  key: playwright-chromium-${{ runner.os }}-${{ hashFiles('**/package.json') }}
@@ -139,7 +142,7 @@ jobs:
139
142
  run: bun run test:e2e --project=chromium
140
143
 
141
144
  - name: Upload E2E Report
142
- uses: actions/upload-artifact@v4
145
+ uses: actions/upload-artifact@v7
143
146
  if: failure()
144
147
  with:
145
148
  name: playwright-report