Skip to content

feat(catalog): reference blocks for every command of the guide #514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
u8array merged 1 commit into from
Oct 4, 2026
Merged

feat(catalog): reference blocks for every command of the guide #514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/core/src/catalog/catalog.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,17 @@ describe("zpl command catalog", () => {

it("ties each reference block to its command and keeps the parameter prose plain", () => {
const PARAM_WORD_CAP = 12;
// An enumeration with a dozen tokens needs room, the other cells do not.
const VALUES_WORD_CAP = 32;
for (const c of ZPL_COMMANDS) {
if (!c.reference) continue;
const { syntax, params, example } = c.reference;
expect(syntax.startsWith(commandId(c)), c.cmd).toBe(true);
expect(example, c.cmd).toContain(commandId(c));
expect(syntax.slice(commandId(c).length).match(/[a-z]/g) ?? [], c.cmd).toEqual(params.map((p) => p.name));
for (const p of params) {
for (const text of [p.meaning, p.values, p.default ?? "x"]) {
expect(text.split(/\s+/).length, `${c.cmd} ${p.name}`).toBeLessThanOrEqual(PARAM_WORD_CAP);
for (const [text, cap] of [[p.meaning, PARAM_WORD_CAP], [p.values, VALUES_WORD_CAP], [p.default ?? "x", PARAM_WORD_CAP]] as const) {
expect(text.split(/\s+/).length, `${c.cmd} ${p.name}`).toBeLessThanOrEqual(cap);
expect(text, `${c.cmd} ${p.name}`).not.toMatch(/[();:]|[^\x20-\x7E]/);
}
// An enum cell lists its tokens, so a single-token default must be one of them.
Expand Down
Loading
Loading