@futurelastic/colab-handbook 1.16.0-rc.1 → 1.16.0-rc.11
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 +17 -16
- package/README.vi.md +19 -18
- package/audit/audit.mjs +5 -53
- package/package.json +1 -1
- package/templates/README.md +33 -4
- package/tools/lib/install-check.js +1 -1
- package/tools/lib/md-anchors.js +60 -0
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ colab register # adds the repo to this machine's fleet list
|
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
Then, in an agent session in that repo, run the `code-start` skill with an issue
|
|
24
|
-
number — each
|
|
24
|
+
number — each agent runtime has its own way to invoke a skill, see [*Choose your agent runtime*](#choose-your-agent-runtime).
|
|
25
25
|
With an agent at hand, the `handbook-sync` skill replaces the last three commands and also does
|
|
26
26
|
the rest of adoption (see [*Adopting it into a repo*](#adopting-it-into-a-repo)).
|
|
27
27
|
You need `git`, `node` ≥ 18 and `gh` ≥ 2.94 logged in (`gh auth login`); distro
|
|
@@ -115,7 +115,7 @@ with a pointer to [#604](https://github.com/futurelastic/colab-handbook/issues/6
|
|
|
115
115
|
## Your first session
|
|
116
116
|
|
|
117
117
|
A unit of work goes round one loop. Each step is a skill, invoked by name in an
|
|
118
|
-
agent session (the syntax is the
|
|
118
|
+
agent session (the syntax is the agent runtime's — [*Choose your agent runtime*](#choose-your-agent-runtime)),
|
|
119
119
|
or followed by hand from [`skills/`](skills/).
|
|
120
120
|
|
|
121
121
|
| Step | Skill | Who runs it | What it leaves behind |
|
|
@@ -235,9 +235,9 @@ the step you are refining by its number (`code-ship` B1c, `code-sweep` §3): a
|
|
|
235
235
|
large skill is a short core plus reference files, and the core keeps every
|
|
236
236
|
step's number.
|
|
237
237
|
|
|
238
|
-
Claude Code loads the file into the skill automatically. Other
|
|
238
|
+
Claude Code loads the file into the skill automatically. Other agent runtimes get a
|
|
239
239
|
plain sentence in each skill telling the agent to read the file, which works
|
|
240
|
-
without any
|
|
240
|
+
without any runtime support. Because the file instructs agents, a change to it
|
|
241
241
|
is never treated as docs-only: it merges on `auto-trunk` or a human's go, like a
|
|
242
242
|
`CLAUDE.md` change. Rule:
|
|
243
243
|
[`CONVENTIONS.md` §8, *Local policy*](CONVENTIONS.md#local-policy--a-repo-refines-a-skill-without-forking-it-520).
|
|
@@ -261,11 +261,12 @@ migration hold with or without it.
|
|
|
261
261
|
| [`CONVENTIONS.md`](CONVENTIONS.md) | The rules. Normative, the single source of truth (EN). |
|
|
262
262
|
| [`AGENTS.md`](AGENTS.md) | The entry point for AI agents — the operational distillation (EN). |
|
|
263
263
|
| [`project.schema.md`](project.schema.md) | Field reference for `.github/project.yml`. |
|
|
264
|
-
| [`templates/`](templates/) | **Copy-and-own** starting points: CI, release, git hooks (a secret scan and an identity scan), and the `CLAUDE.md` block for adopting repos.
|
|
264
|
+
| [`templates/`](templates/) | **Copy-and-own** starting points: CI, release, git hooks (a secret scan and an identity scan), and the `CLAUDE.md` block for adopting repos. Optional — the handbook ships no enforcement; each file's home is the tool that runs it ([`templates/README.md`](templates/README.md#where-each-file-lives--the-handbook-ships-no-enforcement-643)). Copy it, edit it, own it; one caller, `instruction-files.yml`, is kept for compatibility. |
|
|
265
265
|
| [`tools/`](tools/) | `colab` — a small CLI (optional): adopt a repo, claim issues, allocate ports, manage worktrees, and merge a finished branch to trunk when the repo grants it. JSON state, zero dependencies. Command reference: [`tools/README.md`](tools/README.md). |
|
|
266
|
-
| [`audit/`](audit/) | An external conformance checker. Reads all your repos — every owner, including local-only ones — and reports drift in a single run. Advisory only. `--identity` also scans public repository descriptions and topics, which no git hook can see. `--batch-history` shows each repo's measured batch landing picture, flagged only against thresholds the repo declares. What each check means: [`audit/README.md`](audit/README.md). |
|
|
266
|
+
| [`audit/`](audit/) | An external conformance checker. Reads all your repos — every owner, including local-only ones — and reports drift in a single run. Advisory only. `--identity` also scans public repository descriptions and topics, which no git hook can see. `--batch-history` shows each repo's measured batch landing picture, flagged only against thresholds the repo declares. The text checks stay here; the multi-repo sweep is adopter tooling and leaves once its replacement ships. What each check means: [`audit/README.md`](audit/README.md). |
|
|
267
267
|
| [`skills/`](skills/) | The session flow — see [*Your first session*](#your-first-session). Plain `SKILL.md` folders; `install.sh` links them into each coding agent you choose. |
|
|
268
|
-
| [`
|
|
268
|
+
| [`guides/`](guides/) | The role guides — author, reviewer, coordinator, cure, by hand — each written as the files that role leaves for the next. The judgement only; the skills keep their names and point to their guide. |
|
|
269
|
+
| [`engines/`](engines/) | One small data file per agent runtime: where its user-level skills go, how a skill is invoked, what it supports. Adding an agent runtime is adding a file — [`engines/README.md`](engines/README.md). |
|
|
269
270
|
| [`install.sh`](install.sh) | Sets up **your machine**: skills, the `colab` CLI, the pre-commit hook, the fleet list. Idempotent; `--dry` shows everything first. |
|
|
270
271
|
|
|
271
272
|
## Setting up a machine
|
|
@@ -289,12 +290,12 @@ Later moves are explicit:
|
|
|
289
290
|
A clone with uncommitted changes is never moved, and a re-run without either
|
|
290
291
|
flag keeps whatever is checked out.
|
|
291
292
|
|
|
292
|
-
### Choose your
|
|
293
|
+
### Choose your agent runtime
|
|
293
294
|
|
|
294
295
|
The skills are plain `SKILL.md` folders that call `git`, `gh` and `colab`; any
|
|
295
296
|
coding agent that reads skills can run them. What differs is **where each
|
|
296
297
|
agent looks for them**, so the install asks. At a terminal, `./install.sh`
|
|
297
|
-
lists the
|
|
298
|
+
lists the agent runtimes it knows and lets you pick one or more, with *other: give a
|
|
298
299
|
path* last. Unattended, say it with a flag:
|
|
299
300
|
|
|
300
301
|
```sh
|
|
@@ -303,21 +304,21 @@ path* last. Unattended, say it with a flag:
|
|
|
303
304
|
./install.sh --skills-dir ~/my-agent/skills # any other agent: you give its folder
|
|
304
305
|
```
|
|
305
306
|
|
|
306
|
-
|
|
|
307
|
+
| Agent runtime | Skills folder | Invoke | Before the skills work there |
|
|
307
308
|
|---|---|---|---|
|
|
308
309
|
| Claude Code (`claude`) | `~/.claude/skills` | `/code-start` | Nothing. This user-level install **wins** over a repo's own `.claude/skills/<name>` of the same name (precedence is enterprise > personal > project), so rename a repo variant you want used. |
|
|
309
310
|
| OpenAI Codex (`codex`) | `~/.agents/skills` | `$code-start` | Its default sandbox has no network, so `gh` fails: set `[sandbox_workspace_write] network_access = true` in `~/.codex/config.toml`. Values from Codex's docs; not yet verified by a clean-machine run. |
|
|
310
311
|
| anything else | `--skills-dir <path>` | the agent's own way | The agent's shell needs network access for `gh`. The folder is remembered in `~/.colab/skills-dirs`. |
|
|
311
312
|
|
|
312
|
-
A re-run with no flag and no terminal keeps every
|
|
313
|
+
A re-run with no flag and no terminal keeps every agent runtime it finds already
|
|
313
314
|
linked, so an existing machine changes nothing. Finding none, it installs for
|
|
314
|
-
Claude Code and says so. The per-
|
|
315
|
+
Claude Code and says so. The per-runtime facts live in [`engines/`](engines/),
|
|
315
316
|
one file each — that folder is the source for the table above.
|
|
316
317
|
|
|
317
318
|
| Flag | What it does |
|
|
318
319
|
|---|---|
|
|
319
|
-
| *(none)* | Symlink `skills/` into each chosen
|
|
320
|
-
| `--engine <id>[,<id>]` | Install for these
|
|
320
|
+
| *(none)* | Symlink `skills/` into each chosen agent runtime's user-level folder, so they are available in every repo you open. Asks at a terminal; otherwise keeps what is linked (see [*Choose your agent runtime*](#choose-your-agent-runtime)). |
|
|
321
|
+
| `--engine <id>[,<id>]` | Install for these agent runtimes (`claude`, `codex` — the files in `engines/`), no question asked. |
|
|
321
322
|
| `--skills-dir <path>` | Also install into this folder, for an agent `engines/` does not know. |
|
|
322
323
|
| `--tools` | The `colab` CLI twice: a **symlink** at `~/.local/bin/colab` for your sessions (it prints the `PATH` line if needed), and a stamped **frozen copy** at `~/.colab/bin/colab` for always-on services. Also creates an empty `~/.colab/state.json` if there is none. |
|
|
323
324
|
| `--hooks` | Point this clone's git at `.githooks/`: a gitleaks secret scan and an identity scan whose vocabulary you keep outside every repo (see [`templates/README.md`](templates/README.md)). |
|
|
@@ -353,8 +354,8 @@ node audit/audit.mjs # a conformance report across every registered repo
|
|
|
353
354
|
colab update # stamped copies that fell behind, the frozen CLI included
|
|
354
355
|
```
|
|
355
356
|
|
|
356
|
-
`--check` reports, per
|
|
357
|
-
plus that
|
|
357
|
+
`--check` reports, per agent runtime, how many skills are linked, missing or broken,
|
|
358
|
+
plus that runtime's own caveats (Codex's sandbox network, for instance). It also reports whether the frozen copy is behind the latest release and
|
|
358
359
|
which commands it does not dispatch, whether the state file exists, whether
|
|
359
360
|
anything is registered, whether both pre-commit hooklets can run, and whether
|
|
360
361
|
`notifyUrl` is unset, or lacks a URL, while a local observer declared one. ✗ means
|
package/README.vi.md
CHANGED
|
@@ -20,7 +20,7 @@ colab register # đưa repo vào danh sách fleet của máy này
|
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
Sau đó, trong một phiên agent ở repo đó, chạy skill `code-start` kèm số issue —
|
|
23
|
-
mỗi
|
|
23
|
+
mỗi agent runtime có cách gọi skill riêng, xem [*Chọn agent runtime*](#chọn-agent-runtime). Có agent
|
|
24
24
|
trong tay thì skill `handbook-sync` thay được ba lệnh cuối và làm nốt phần adopt còn
|
|
25
25
|
lại (xem [*Adopt vào một repo*](#adopt-vào-một-repo)). Cần có `git`, `node` ≥ 18
|
|
26
26
|
và `gh` ≥ 2.94 đã đăng nhập (`gh auth login`); gói `gh` của các distro thường cũ
|
|
@@ -114,7 +114,7 @@ production đủ 7 ngày. Thông báo nằm ở đầu
|
|
|
114
114
|
## Phiên làm việc đầu tiên
|
|
115
115
|
|
|
116
116
|
Mỗi đầu việc đi qua một vòng. Mỗi bước là một skill, gọi theo tên trong phiên
|
|
117
|
-
agent (cú pháp gọi là của
|
|
117
|
+
agent (cú pháp gọi là của agent runtime — [*Chọn agent runtime*](#chọn-agent-runtime)), hoặc tự làm
|
|
118
118
|
theo bằng tay từ [`skills/`](skills/).
|
|
119
119
|
|
|
120
120
|
| Bước | Skill | Ai chạy | Để lại gì |
|
|
@@ -234,8 +234,8 @@ chối thì vẫn bị từ chối. Hãy gọi bước bạn muốn chỉnh theo
|
|
|
234
234
|
B1c, `code-sweep` §3): một skill lớn gồm một phần lõi ngắn cộng các file tham
|
|
235
235
|
chiếu, và phần lõi giữ số của mọi bước.
|
|
236
236
|
|
|
237
|
-
Claude Code tự nạp file vào skill. Các
|
|
238
|
-
skill bảo agent đọc file, cách này chạy được mà không cần
|
|
237
|
+
Claude Code tự nạp file vào skill. Các agent runtime khác có một câu thường trong mỗi
|
|
238
|
+
skill bảo agent đọc file, cách này chạy được mà không cần runtime hỗ trợ gì.
|
|
239
239
|
Vì file này ra lệnh cho agent, thay đổi trong nó không bao giờ được coi là
|
|
240
240
|
docs-only: nó merge bằng `auto-trunk` hoặc khi có người duyệt, giống một thay đổi
|
|
241
241
|
`CLAUDE.md`. Quy tắc:
|
|
@@ -260,11 +260,12 @@ quyền cấp trước khi chạy migration vẫn đứng vững dù có nó hay
|
|
|
260
260
|
| [`CONVENTIONS.md`](CONVENTIONS.md) | Luật. Chuẩn tắc, nguồn sự thật duy nhất (EN). |
|
|
261
261
|
| [`AGENTS.md`](AGENTS.md) | Cửa vào cho AI agent — bản chưng cất vận hành (EN). |
|
|
262
262
|
| [`project.schema.md`](project.schema.md) | Tham chiếu field của `.github/project.yml`. |
|
|
263
|
-
| [`templates/`](templates/) | Điểm khởi đầu **copy-về-là-của-bạn**: CI, release, git hook (một bản quét secret và một bản quét danh tính), và block `CLAUDE.md` cho repo adopt.
|
|
263
|
+
| [`templates/`](templates/) | Điểm khởi đầu **copy-về-là-của-bạn**: CI, release, git hook (một bản quét secret và một bản quét danh tính), và block `CLAUDE.md` cho repo adopt. Tuỳ chọn — handbook không kèm cơ chế cưỡng chế nào; nhà của mỗi file là công cụ chạy nó ([`templates/README.md`](templates/README.md#where-each-file-lives--the-handbook-ships-no-enforcement-643)). Copy, sửa, sở hữu; riêng một caller, `instruction-files.yml`, được giữ để tương thích. |
|
|
264
264
|
| [`tools/`](tools/) | `colab` — một CLI nhỏ (tùy chọn): adopt một repo, claim issue, cấp port, quản lý worktree, và merge nhánh đã xong vào trunk khi repo cho phép. State JSON, không dependency. Tham chiếu các lệnh: [`tools/README.md`](tools/README.md). |
|
|
265
|
-
| [`audit/`](audit/) | Trình kiểm tra conformance từ bên ngoài. Đọc mọi repo của bạn — mọi owner, kể cả repo local-only — và báo drift trong một lần chạy. Chỉ cảnh báo. Thêm `--identity` thì quét cả description và topic của repo public — thứ mà không git hook nào nhìn thấy được. Thêm `--batch-history` thì hiện số liệu batch landing đo được của từng repo, chỉ cảnh báo theo ngưỡng repo tự khai báo. Ý nghĩa từng check: [`audit/README.md`](audit/README.md). |
|
|
265
|
+
| [`audit/`](audit/) | Trình kiểm tra conformance từ bên ngoài. Đọc mọi repo của bạn — mọi owner, kể cả repo local-only — và báo drift trong một lần chạy. Chỉ cảnh báo. Thêm `--identity` thì quét cả description và topic của repo public — thứ mà không git hook nào nhìn thấy được. Thêm `--batch-history` thì hiện số liệu batch landing đo được của từng repo, chỉ cảnh báo theo ngưỡng repo tự khai báo. Các check văn bản ở lại đây; phần quét nhiều repo là công cụ của bên adopt và sẽ rời đi khi bản thay thế ra mắt. Ý nghĩa từng check: [`audit/README.md`](audit/README.md). |
|
|
266
266
|
| [`skills/`](skills/) | Luồng phiên làm việc — xem [*Phiên làm việc đầu tiên*](#phiên-làm-việc-đầu-tiên). Là các thư mục `SKILL.md` thuần; `install.sh` link chúng vào từng coding agent bạn chọn. |
|
|
267
|
-
| [`
|
|
267
|
+
| [`guides/`](guides/) | Các hướng dẫn theo vai trò — author, reviewer, coordinator, cure, by hand — mỗi bản viết dưới dạng các file vai trò đó để lại cho bước sau. Chỉ phần phán đoán; các skill giữ nguyên tên và trỏ tới hướng dẫn của mình. |
|
|
268
|
+
| [`engines/`](engines/) | Mỗi agent runtime một file dữ liệu nhỏ: skill cấp user đặt ở đâu, gọi skill thế nào, agent hỗ trợ gì. Thêm agent runtime là thêm một file — [`engines/README.md`](engines/README.md). |
|
|
268
269
|
| [`install.sh`](install.sh) | Cài đặt cho **máy của bạn**: skills, CLI `colab`, hook pre-commit, danh sách fleet. Idempotent; `--dry` cho xem trước mọi thứ. |
|
|
269
270
|
|
|
270
271
|
## Cài đặt máy
|
|
@@ -288,12 +289,12 @@ sau đều phải chủ động:
|
|
|
288
289
|
Clone đang có thay đổi chưa commit thì không bao giờ bị chuyển, và chạy lại
|
|
289
290
|
không kèm flag nào thì giữ nguyên thứ đang checkout.
|
|
290
291
|
|
|
291
|
-
### Chọn
|
|
292
|
+
### Chọn agent runtime
|
|
292
293
|
|
|
293
294
|
Các skill là thư mục `SKILL.md` thuần, chỉ gọi `git`, `gh` và `colab`; coding
|
|
294
295
|
agent nào đọc được skill thì chạy được chúng. Khác nhau là **mỗi agent tìm
|
|
295
296
|
skill ở đâu**, nên bản cài sẽ hỏi. Ở terminal, `./install.sh` liệt kê các
|
|
296
|
-
|
|
297
|
+
agent runtime nó biết và cho bạn chọn một hoặc nhiều, lựa chọn cuối là *other: give a
|
|
297
298
|
path*. Chạy không người trông thì nói bằng flag:
|
|
298
299
|
|
|
299
300
|
```sh
|
|
@@ -302,21 +303,21 @@ path*. Chạy không người trông thì nói bằng flag:
|
|
|
302
303
|
./install.sh --skills-dir ~/my-agent/skills # agent khác: bạn đưa thư mục của nó
|
|
303
304
|
```
|
|
304
305
|
|
|
305
|
-
|
|
|
306
|
+
| Agent runtime | Thư mục skill | Gọi | Cần làm gì để skill chạy được |
|
|
306
307
|
|---|---|---|---|
|
|
307
308
|
| Claude Code (`claude`) | `~/.claude/skills` | `/code-start` | Không cần gì. Bản cài cấp user này **thắng** `.claude/skills/<name>` cùng tên của repo (thứ tự ưu tiên là enterprise > personal > project), nên muốn dùng bản của repo thì đổi tên nó. |
|
|
308
309
|
| OpenAI Codex (`codex`) | `~/.agents/skills` | `$code-start` | Sandbox mặc định không có mạng nên `gh` lỗi: đặt `[sandbox_workspace_write] network_access = true` trong `~/.codex/config.toml`. Số liệu lấy từ tài liệu của Codex; chưa được xác minh bằng một lần chạy trên máy sạch. |
|
|
309
310
|
| agent khác | `--skills-dir <path>` | theo cách của agent | Shell của agent cần có mạng cho `gh`. Thư mục được ghi nhớ trong `~/.colab/skills-dirs`. |
|
|
310
311
|
|
|
311
|
-
Chạy lại không flag và không có terminal thì giữ mọi
|
|
312
|
-
sẵn, nên máy đã cài không thay đổi gì. Không thấy
|
|
313
|
-
Code và nói rõ điều đó. Thông tin từng
|
|
314
|
-
mỗi
|
|
312
|
+
Chạy lại không flag và không có terminal thì giữ mọi agent runtime đã thấy được link
|
|
313
|
+
sẵn, nên máy đã cài không thay đổi gì. Không thấy agent runtime nào thì cài cho Claude
|
|
314
|
+
Code và nói rõ điều đó. Thông tin từng agent runtime nằm trong [`engines/`](engines/),
|
|
315
|
+
mỗi agent runtime một file — thư mục đó là nguồn của bảng trên.
|
|
315
316
|
|
|
316
317
|
| Flag | Làm gì |
|
|
317
318
|
|---|---|
|
|
318
|
-
| *(không có)* | Symlink `skills/` vào thư mục cấp user của từng
|
|
319
|
-
| `--engine <id>[,<id>]` | Cài cho các
|
|
319
|
+
| *(không có)* | Symlink `skills/` vào thư mục cấp user của từng agent runtime đã chọn, để mở repo nào cũng có. Ở terminal thì hỏi; không thì giữ những gì đã link (xem [*Chọn agent runtime*](#chọn-agent-runtime)). |
|
|
320
|
+
| `--engine <id>[,<id>]` | Cài cho các agent runtime này (`claude`, `codex` — các file trong `engines/`), không hỏi. |
|
|
320
321
|
| `--skills-dir <path>` | Cài thêm vào thư mục này, cho agent mà `engines/` chưa biết. |
|
|
321
322
|
| `--tools` | CLI `colab` cài hai lần: một **symlink** ở `~/.local/bin/colab` cho các phiên làm việc của bạn (in sẵn dòng `PATH` nếu cần), và một **bản đóng băng** có đóng dấu ở `~/.colab/bin/colab` cho các service luôn-bật. Đồng thời tạo `~/.colab/state.json` rỗng nếu chưa có. |
|
|
322
323
|
| `--hooks` | Trỏ git của clone này vào `.githooks/`: quét secret bằng gitleaks, và quét danh tính với danh sách từ khoá do bạn giữ NGOÀI mọi repo (xem [`templates/README.md`](templates/README.md)). |
|
|
@@ -351,8 +352,8 @@ node audit/audit.mjs # báo cáo conformance cho mọi repo đã đăng ký
|
|
|
351
352
|
colab update # các bản copy có đóng dấu đã tụt lại, kể cả CLI đóng băng
|
|
352
353
|
```
|
|
353
354
|
|
|
354
|
-
`--check` báo theo từng
|
|
355
|
-
các lưu ý riêng của
|
|
355
|
+
`--check` báo theo từng agent runtime: bao nhiêu skill đã link, thiếu hay hỏng, kèm
|
|
356
|
+
các lưu ý riêng của runtime đó (ví dụ mạng trong sandbox của Codex). Nó cũng báo bản đóng băng có tụt sau bản phát hành mới nhất không và lệnh nào
|
|
356
357
|
nó không chạy được, file state có tồn tại không, đã đăng ký repo nào chưa, cả
|
|
357
358
|
hai hooklet pre-commit có chạy được không, và `notifyUrl` có đang trống (hoặc
|
|
358
359
|
thiếu một URL) trong khi một observer trên máy đã khai endpoint không. ✗ nghĩa là thứ đã cài đang cũ
|
package/audit/audit.mjs
CHANGED
|
@@ -91,6 +91,8 @@ const stamp = require("../tools/lib/stamp.js");
|
|
|
91
91
|
const { missingConventionLabels, staleConventionDescriptions, MINIMAL_LABEL_NAMES } = require("../tools/lib/labels.js");
|
|
92
92
|
// #393: "adopted locally, not committed" — one classifier, shared with `colab adopt --local`.
|
|
93
93
|
const { localAdoptionState } = require("../tools/lib/local-adopt.js");
|
|
94
|
+
// #158 heading slugs, shared with the rule-inventory check (#632).
|
|
95
|
+
const { collectHeadingSlugs } = require("../tools/lib/md-anchors.js");
|
|
94
96
|
// #144's authority-flip precedence ladder — shared with `tools/colab` for the same reason
|
|
95
97
|
// every other cross-tool reading in this file is: two implementations of "which key governs"
|
|
96
98
|
// is exactly the two-places-drift disease this handbook exists to kill.
|
|
@@ -2505,59 +2507,9 @@ function splitDerivedSpans(text) {
|
|
|
2505
2507
|
return { authoredLines, malformed };
|
|
2506
2508
|
}
|
|
2507
2509
|
|
|
2508
|
-
//
|
|
2509
|
-
//
|
|
2510
|
-
//
|
|
2511
|
-
// project.schema.md, skills/handbook-sync/SKILL.md, tools/README.md) — every one of
|
|
2512
|
-
// them resolves under it. Not a general markdown-heading parser: it does not need to be,
|
|
2513
|
-
// because the only headings it is ever asked to slugify are the ones already governing
|
|
2514
|
-
// the links this check exists to validate.
|
|
2515
|
-
function slugifyHeading(text) {
|
|
2516
|
-
return text
|
|
2517
|
-
.replace(/`([^`]*)`/g, "$1") // code spans contribute their literal text, not backticks
|
|
2518
|
-
.replace(/\[([^\]]*)\]\([^)]*\)/g, "$1") // [text](url) contributes only the text
|
|
2519
|
-
.trim()
|
|
2520
|
-
.replace(/#+$/, "") // a trailing "##" some repos use to mark a self-anchor
|
|
2521
|
-
.toLowerCase()
|
|
2522
|
-
// strip punctuation, keep Unicode letters/digits, underscore, hyphens/spaces -- NOT
|
|
2523
|
-
// collapsed. `\w` is ASCII-only ([A-Za-z0-9_]); GitHub's real slugifier keeps Unicode
|
|
2524
|
-
// letters (Vietnamese, Japanese, accented Latin, ...), so `\w` alone silently deleted
|
|
2525
|
-
// them and produced a slug GitHub never renders (#280). `\p{L}`/`\p{N}` (with the `/u`
|
|
2526
|
-
// flag) widen letter/digit matching to Unicode while `_` stays its own explicit member
|
|
2527
|
-
// of the class -- it must NOT be folded into `\p{L}`/`\p{N}`, because the very next
|
|
2528
|
-
// step below (`.replace(/[ _]/g, "-")`) turns underscores into hyphens and needs them
|
|
2529
|
-
// to survive this line to do it; the issue's own one-line suggestion dropped `_` from
|
|
2530
|
-
// the class and would have silently broken every underscored heading slug.
|
|
2531
|
-
.replace(/[^\p{L}\p{N}_\- ]+/gu, "")
|
|
2532
|
-
.trim()
|
|
2533
|
-
// Each space/underscore becomes its OWN hyphen -- never collapsed. GitHub does not
|
|
2534
|
-
// merge runs: a heading like "tier -- required" strips the em-dash but keeps both
|
|
2535
|
-
// spaces around where it was, producing "tier--required" (double hyphen), and every
|
|
2536
|
-
// link already written against a real heading in this repo is punctuated that way.
|
|
2537
|
-
// Collapsing here silently breaks every one of them.
|
|
2538
|
-
.replace(/[ _]/g, "-");
|
|
2539
|
-
}
|
|
2540
|
-
|
|
2541
|
-
// Every heading in `text`, in document order, mapped to its resolved slug — including
|
|
2542
|
-
// GitHub's duplicate-slug suffixing (`-1`, `-2`, … in heading order, not alphabetical).
|
|
2543
|
-
// Fenced code blocks are skipped so a `#` inside a code sample is never read as a heading.
|
|
2544
|
-
function collectHeadingSlugs(text) {
|
|
2545
|
-
const slugs = new Set();
|
|
2546
|
-
const seen = new Map(); // base slug -> next suffix to try
|
|
2547
|
-
let inFence = false;
|
|
2548
|
-
for (const line of text.split("\n")) {
|
|
2549
|
-
if (/^\s*(```|~~~)/.test(line)) { inFence = !inFence; continue; }
|
|
2550
|
-
if (inFence) continue;
|
|
2551
|
-
const m = /^#{1,6}\s+(.+?)\s*$/.exec(line);
|
|
2552
|
-
if (!m) continue;
|
|
2553
|
-
const base = slugifyHeading(m[1]);
|
|
2554
|
-
if (!base) continue;
|
|
2555
|
-
const n = seen.get(base) ?? 0;
|
|
2556
|
-
seen.set(base, n + 1);
|
|
2557
|
-
slugs.add(n === 0 ? base : `${base}-${n}`);
|
|
2558
|
-
}
|
|
2559
|
-
return slugs;
|
|
2560
|
-
}
|
|
2510
|
+
// slugifyHeading + collectHeadingSlugs live in tools/lib/md-anchors.js (#632) — one slugifier,
|
|
2511
|
+
// shared with scripts/check-rule-inventory.mjs, so an inventory `dest#anchor` and a doc link
|
|
2512
|
+
// cannot disagree about what a heading's anchor is.
|
|
2561
2513
|
|
|
2562
2514
|
// Every `](target#fragment)` markdown link, repo-relative to the file that carries it.
|
|
2563
2515
|
// `target` is `""` for a same-file link (`[…](#slug)`); anything already resolved by the
|
package/package.json
CHANGED
package/templates/README.md
CHANGED
|
@@ -2,11 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
Starting points you **copy into your own repo**. That is the entire model.
|
|
4
4
|
|
|
5
|
-
> **These are NOT called remotely.**
|
|
6
|
-
>
|
|
5
|
+
> **These are NOT called remotely — with one exception.** `instruction-files.yml` is a caller:
|
|
6
|
+
> its one job `uses:` this handbook's reusable `.github/workflows/instruction-files.yml` (#588,
|
|
7
|
+
> kept for compatibility — see *Where each file lives* below). Every other file here is copied,
|
|
8
|
+
> not called. (`dist-refs.yml` is a
|
|
7
9
|
> `workflow_call` workflow, but its caller is your own release workflow, in the same repo, via
|
|
8
10
|
> `uses: ./.github/workflows/dist-refs.yml` — the file still lives, in full, where it runs.) An earlier version of this
|
|
9
|
-
> handbook told repos to call shared workflows; that was reversed. Every workflow now
|
|
11
|
+
> handbook told repos to call shared workflows; that was reversed. Every other workflow now
|
|
10
12
|
> lives, in full, inside the repo that runs it. You copy the file, you edit it, **you
|
|
11
13
|
> own it.** Divergence between your copy and this template is expected — a shared
|
|
12
14
|
> workflow that silently changes under a hundred repos is the failure mode we are
|
|
@@ -70,6 +72,30 @@ Named it something other than `ci-heavy.yml`? Say so with `heavy-workflow:` in `
|
|
|
70
72
|
light templates show a commented `paths-ignore` for docs as an option; the old in-workflow
|
|
71
73
|
docs-only guard is gone.
|
|
72
74
|
|
|
75
|
+
## Where each file lives — the handbook ships no enforcement (#643)
|
|
76
|
+
|
|
77
|
+
Every file in this folder is an **optional starting file**: copy it if it helps, change it as
|
|
78
|
+
you like, or write your own. The handbook states rules; the tool that runs a file is what
|
|
79
|
+
enforces anything, and that tool is the file's home. Where the runner is still a `colab`
|
|
80
|
+
command in this repo, the file stays here until that command's replacement ships — code moves
|
|
81
|
+
only after its replacement exists (epic #631), and a file that moves keeps its path here with a
|
|
82
|
+
header naming its new home ([`docs/compat-surfaces.md`](../docs/compat-surfaces.md)).
|
|
83
|
+
|
|
84
|
+
| File | Runs it today | Home |
|
|
85
|
+
|---|---|---|
|
|
86
|
+
| `ci-node.yml`, `ci-python.yml`, `ci-laravel.yml` (with the #625 `Migration round-trip` job), `ci-*-heavy.yml` | your forge's CI; `colab ship` / `promote` read or dispatch the runs; `colab template --roundtrip` writes the round-trip job | the adopter's CI layer; until it ships (#608), an optional starting file here |
|
|
87
|
+
| `release-tag.yml`, `release-auto.yml` | your forge's CI; `release-auto.yml` runs `colab release cut` / `finalize --auto` | the release commands' new home (#608); an optional starting file here until then |
|
|
88
|
+
| `dist-refs.yml`, `npx-launcher.mjs`, `npx-service.mjs` | your own release workflow and package `bin` | stays here, as an optional starting file |
|
|
89
|
+
| `deploy-xserver.yml`, `deploy-container.yml`, `deploy-container-run.mjs`, `deploy-adapter-portainer.mjs` | your repo's deploy workflow | the adopter's deploy tooling; here as an optional starting file |
|
|
90
|
+
| `pre-push-guard` | git, honouring `COLAB_SHIP=1` from `colab ship` | the tool that lands branches (#608); an optional starting file here until then |
|
|
91
|
+
| `pre-commit-dispatch`, `pre-commit-identity`, `identity-vocabulary.example` | git (this repo's own `.githooks/` run them in place) | stays here, as an optional starting file |
|
|
92
|
+
| `pre-commit-instruction-files`, `instruction-files.yml` | `colab instruction-files`; the reusable workflow in this repo | the `colab instruction-files` command; the reusable workflow is the one remote call this folder keeps, for compatibility |
|
|
93
|
+
| `docs-lint.mjs`, `docs-lint.yml`, `branch-name.yml` | your CI (advisory or opt-in); `code-wrap`'s docs step | stays here, as an optional starting file |
|
|
94
|
+
| `repo-CLAUDE-block.md`, `gotchas-d-README.md`, `adr-README.md` | nothing — text you paste or copy (`colab adopt` pastes the block) | stays here |
|
|
95
|
+
|
|
96
|
+
Nothing in this table changes what a copied file does. A stamp, a drift report or a `colab`
|
|
97
|
+
check that reads one of these files is that tool's behaviour, documented with the tool.
|
|
98
|
+
|
|
73
99
|
## What each template is for
|
|
74
100
|
|
|
75
101
|
| File | Copy to | For | Notes |
|
|
@@ -175,7 +201,7 @@ colab template ci-python --dest .github/workflows/ci.yml --roundtrip --roundtrip
|
|
|
175
201
|
|
|
176
202
|
### Migration round-trip — what the Laravel job proves, and what it cannot
|
|
177
203
|
|
|
178
|
-
`ci-laravel.yml`'s `migrations` job runs every migration **twice per engine**: once from
|
|
204
|
+
`ci-laravel.yml`'s `migrations` job runs every migration **twice per database engine**: once from
|
|
179
205
|
zero, then — after rolling back the migrations the change adds and seeding rows at the
|
|
180
206
|
schema *before* the change — once more, the way a deploy lands new migrations on data
|
|
181
207
|
that predates them. The schema after both passes must match. Two things to know before
|
|
@@ -376,6 +402,9 @@ drift is only ever a suggestion (#607), so the trailer is moot there. Full contr
|
|
|
376
402
|
is missing or incoherent, when a declared toolchain disagrees with what CI actually
|
|
377
403
|
pins, when branch names drift, and when a stamped copy has fallen behind its template.
|
|
378
404
|
It is advisory — run it locally or on a schedule. It is **not** wired into any repo's CI.
|
|
405
|
+
That multi-repo sweep is adopter tooling: it runs from here, unchanged, until its replacement
|
|
406
|
+
ships, and then leaves; only the text checks stay
|
|
407
|
+
([`audit/README.md`, *What stays and what leaves*](../audit/README.md#what-stays-and-what-leaves-643)).
|
|
379
408
|
|
|
380
409
|
## Runner policy
|
|
381
410
|
|
|
@@ -162,7 +162,7 @@ function checkSkills({ root, home, colabHome }) {
|
|
|
162
162
|
const byId = Object.fromEntries(all.map((e) => [e.id, e]));
|
|
163
163
|
const targets = all.filter((e) => e.skills_dir).map((e) => ({ e, dir: engines.expandHome(e.skills_dir, home) }));
|
|
164
164
|
for (const dir of engines.rememberedDirs(colabHome)) {
|
|
165
|
-
if (!targets.some((t) => t.dir === dir)) targets.push({ e: byId.generic || { id: 'generic', label: 'another
|
|
165
|
+
if (!targets.some((t) => t.dir === dir)) targets.push({ e: byId.generic || { id: 'generic', label: 'another agent runtime', note: [], caveat: [] }, dir });
|
|
166
166
|
}
|
|
167
167
|
|
|
168
168
|
const rows = [];
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
// md-anchors — the heading-to-anchor slugs a markdown link or an inventory `dest#anchor` resolves
|
|
3
|
+
// against. Moved out of audit/audit.mjs (#158) by #632 so the audit and
|
|
4
|
+
// scripts/check-rule-inventory.mjs share one slugifier.
|
|
5
|
+
|
|
6
|
+
// Minimal GitHub-compatible heading→anchor slugifier (#158). GitHub's real algorithm is
|
|
7
|
+
// unpublished; this is deliberately the common-case subset, calibrated against the 47
|
|
8
|
+
// anchor links already live in this repo (CLAUDE.md, CONVENTIONS.md, README*.md,
|
|
9
|
+
// project.schema.md, skills/handbook-sync/SKILL.md, tools/README.md) — every one of
|
|
10
|
+
// them resolves under it. Not a general markdown-heading parser: it does not need to be,
|
|
11
|
+
// because the only headings it is ever asked to slugify are the ones already governing
|
|
12
|
+
// the links this check exists to validate.
|
|
13
|
+
function slugifyHeading(text) {
|
|
14
|
+
return text
|
|
15
|
+
.replace(/`([^`]*)`/g, "$1") // code spans contribute their literal text, not backticks
|
|
16
|
+
.replace(/\[([^\]]*)\]\([^)]*\)/g, "$1") // [text](url) contributes only the text
|
|
17
|
+
.trim()
|
|
18
|
+
.replace(/#+$/, "") // a trailing "##" some repos use to mark a self-anchor
|
|
19
|
+
.toLowerCase()
|
|
20
|
+
// strip punctuation, keep Unicode letters/digits, underscore, hyphens/spaces -- NOT
|
|
21
|
+
// collapsed. `\w` is ASCII-only ([A-Za-z0-9_]); GitHub's real slugifier keeps Unicode
|
|
22
|
+
// letters (Vietnamese, Japanese, accented Latin, ...), so `\w` alone silently deleted
|
|
23
|
+
// them and produced a slug GitHub never renders (#280). `\p{L}`/`\p{N}` (with the `/u`
|
|
24
|
+
// flag) widen letter/digit matching to Unicode while `_` stays its own explicit member
|
|
25
|
+
// of the class -- it must NOT be folded into `\p{L}`/`\p{N}`, because the very next
|
|
26
|
+
// step below (`.replace(/[ _]/g, "-")`) turns underscores into hyphens and needs them
|
|
27
|
+
// to survive this line to do it; the issue's own one-line suggestion dropped `_` from
|
|
28
|
+
// the class and would have silently broken every underscored heading slug.
|
|
29
|
+
.replace(/[^\p{L}\p{N}_\- ]+/gu, "")
|
|
30
|
+
.trim()
|
|
31
|
+
// Each space/underscore becomes its OWN hyphen -- never collapsed. GitHub does not
|
|
32
|
+
// merge runs: a heading like "tier -- required" strips the em-dash but keeps both
|
|
33
|
+
// spaces around where it was, producing "tier--required" (double hyphen), and every
|
|
34
|
+
// link already written against a real heading in this repo is punctuated that way.
|
|
35
|
+
// Collapsing here silently breaks every one of them.
|
|
36
|
+
.replace(/[ _]/g, "-");
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
// Every heading in `text`, in document order, mapped to its resolved slug — including
|
|
40
|
+
// GitHub's duplicate-slug suffixing (`-1`, `-2`, … in heading order, not alphabetical).
|
|
41
|
+
// Fenced code blocks are skipped so a `#` inside a code sample is never read as a heading.
|
|
42
|
+
function collectHeadingSlugs(text) {
|
|
43
|
+
const slugs = new Set();
|
|
44
|
+
const seen = new Map(); // base slug -> next suffix to try
|
|
45
|
+
let inFence = false;
|
|
46
|
+
for (const line of text.split("\n")) {
|
|
47
|
+
if (/^\s*(```|~~~)/.test(line)) { inFence = !inFence; continue; }
|
|
48
|
+
if (inFence) continue;
|
|
49
|
+
const m = /^#{1,6}\s+(.+?)\s*$/.exec(line);
|
|
50
|
+
if (!m) continue;
|
|
51
|
+
const base = slugifyHeading(m[1]);
|
|
52
|
+
if (!base) continue;
|
|
53
|
+
const n = seen.get(base) ?? 0;
|
|
54
|
+
seen.set(base, n + 1);
|
|
55
|
+
slugs.add(n === 0 ? base : `${base}-${n}`);
|
|
56
|
+
}
|
|
57
|
+
return slugs;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
module.exports = { slugifyHeading, collectHeadingSlugs };
|