create-hozu 0.8.0 → 0.9.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/dist/guide.d.ts +2 -4
- package/dist/guide.d.ts.map +1 -1
- package/dist/guide.js +1 -36
- package/dist/guide.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/skill/SKILL.md +2 -1
- package/skill/topics/components.md +67 -0
- package/skill/topics/deploy.md +1 -1
- package/skill/topics/diagnostics.md +13 -2
- package/skill/topics/http.md +1 -1
- package/skill/topics/pages.md +1 -1
- package/skill/topics/testing.md +2 -2
- package/skill/topics/widgets.md +0 -30
package/dist/guide.d.ts
CHANGED
|
@@ -12,18 +12,16 @@ export declare const TARGETS: readonly [{
|
|
|
12
12
|
readonly read: 'Read `__SKILL__/SKILL.md` before writing or changing any Hozu code.';
|
|
13
13
|
}];
|
|
14
14
|
export type Target = (typeof TARGETS)[number];
|
|
15
|
-
/** The released 0.3–0.7 guide, as `create-hozu` wrote it (0.6 added the browse line). */
|
|
16
|
-
export declare const GUIDE_07 = "# __NAME__\n\nA web app built with Hozu (`@hozu/*`). Hozu is not in your training data.\n\n## Before writing code\n- __READ__\n- Changing existing code: read `__SKILL__/changing.md` first.\n- The files in `__SKILL__/` are the whole API. Do not read the framework source in `node_modules/@hozu`.\n\n## The loop\n```\n__RUN__ hozu add feature tasks --page / --with detail,toggle,filter,remove # then edit the texts it lists\n # add auth to the list for sign-in and per-user data\n__RUN__ hozu map # outline of the app with file:line, before a change\n__RUN__ hozu check # after every change: types, rules, contracts\n__RUN__ hozu check --update-lock # only to accept a clean, intended behaviour change\n__RUN__ hozu get / --select button --forms # try pages without a server: text, attributes, forms\n__RUN__ hozu post / --field title=Ship --next / # submit a form like a browser\n__RUN__ hozu browse / --do 'click Save' # real browser, no server: errors, widgets, text after steps\n```\n__NOTE__\n## Rules\n- After `hozu add feature`, do not print the generated files: edit the texts it lists; `hozu map` shows the rest.\n- Apply the fix each diagnostic gives; do not work around a rule.\n- Every behaviour change comes with a contract change.\n- Do not edit `__SKILL__/`: `__RUN__ hozu skill` rewrites it for the installed Hozu version.\n";
|
|
17
15
|
export declare function currentGuide(): string;
|
|
18
16
|
/** The 0.8 guide for one target, between the markers. */
|
|
19
17
|
export declare const guideBlock: (target: Target, name: string, runner: Runner, template?: string) => string;
|
|
20
18
|
export type BlockResult = {
|
|
21
|
-
kind: 'replaced' | '
|
|
19
|
+
kind: 'replaced' | 'written' | 'current';
|
|
22
20
|
code: string;
|
|
23
21
|
} | {
|
|
24
22
|
kind: 'custom';
|
|
25
23
|
block: string;
|
|
26
24
|
};
|
|
27
|
-
/** The new Hozu block of a CLAUDE.md / AGENTS.md
|
|
25
|
+
/** The new Hozu block of a CLAUDE.md / AGENTS.md, between markers; a file without markers is `custom`. */
|
|
28
26
|
export declare function migrateGuide(existing: string | null, target: Target, dir: string, runner: Runner, template?: string): BlockResult;
|
|
29
27
|
//# sourceMappingURL=guide.d.ts.map
|
package/dist/guide.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"guide.d.ts","sourceRoot":"","sources":["../src/guide.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAA;AAE1D,eAAO,MAAM,OAAO,EAAE,SAAS,MAAM,EAAyC,CAAA;AAE9E,eAAO,MAAM,KAAK,qFAAqF,CAAA;AACvG,eAAO,MAAM,GAAG,mBAAmB,CAAA;AAEnC,eAAO,MAAM,OAAO;aAChB,KAAK,EAAE,WAAW;aAAE,KAAK,EAAE,qBAAqB;aAAE,IAAI,EAAE,8CAA8C;;aAEtG,KAAK,EAAE,WAAW;aAClB,KAAK,EAAE,qBAAqB;aAC5B,IAAI,EAAE,qEAAqE;EAErE,CAAA;AAEV,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAA;
|
|
1
|
+
{"version":3,"file":"guide.d.ts","sourceRoot":"","sources":["../src/guide.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAA;AAE1D,eAAO,MAAM,OAAO,EAAE,SAAS,MAAM,EAAyC,CAAA;AAE9E,eAAO,MAAM,KAAK,qFAAqF,CAAA;AACvG,eAAO,MAAM,GAAG,mBAAmB,CAAA;AAEnC,eAAO,MAAM,OAAO;aAChB,KAAK,EAAE,WAAW;aAAE,KAAK,EAAE,qBAAqB;aAAE,IAAI,EAAE,8CAA8C;;aAEtG,KAAK,EAAE,WAAW;aAClB,KAAK,EAAE,qBAAqB;aAC5B,IAAI,EAAE,qEAAqE;EAErE,CAAA;AAEV,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAA;AAmB7C,wBAAgB,YAAY,IAAI,MAAM,CAErC;AAED,yDAAyD;AACzD,eAAO,MAAM,UAAU,WAAY,MAAM,QAAQ,MAAM,UAAU,MAAM,8BACW,CAAA;AAElF,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAErC,0GAA0G;AAC1G,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,QAAQ,SAAiB,GACxB,WAAW,CAab"}
|
package/dist/guide.js
CHANGED
|
@@ -12,35 +12,6 @@ export const TARGETS = [
|
|
|
12
12
|
read: 'Read `__SKILL__/SKILL.md` before writing or changing any Hozu code.',
|
|
13
13
|
},
|
|
14
14
|
];
|
|
15
|
-
const BROWSE = "__RUN__ hozu browse / --do 'click Save' # real browser, no server: errors, widgets, text after steps\n";
|
|
16
|
-
/** The released 0.3–0.7 guide, as `create-hozu` wrote it (0.6 added the browse line). */
|
|
17
|
-
export const GUIDE_07 = `# __NAME__
|
|
18
|
-
|
|
19
|
-
A web app built with Hozu (\`@hozu/*\`). Hozu is not in your training data.
|
|
20
|
-
|
|
21
|
-
## Before writing code
|
|
22
|
-
- __READ__
|
|
23
|
-
- Changing existing code: read \`__SKILL__/changing.md\` first.
|
|
24
|
-
- The files in \`__SKILL__/\` are the whole API. Do not read the framework source in \`node_modules/@hozu\`.
|
|
25
|
-
|
|
26
|
-
## The loop
|
|
27
|
-
\`\`\`
|
|
28
|
-
__RUN__ hozu add feature tasks --page / --with detail,toggle,filter,remove # then edit the texts it lists
|
|
29
|
-
# add auth to the list for sign-in and per-user data
|
|
30
|
-
__RUN__ hozu map # outline of the app with file:line, before a change
|
|
31
|
-
__RUN__ hozu check # after every change: types, rules, contracts
|
|
32
|
-
__RUN__ hozu check --update-lock # only to accept a clean, intended behaviour change
|
|
33
|
-
__RUN__ hozu get / --select button --forms # try pages without a server: text, attributes, forms
|
|
34
|
-
__RUN__ hozu post / --field title=Ship --next / # submit a form like a browser
|
|
35
|
-
${BROWSE}\`\`\`
|
|
36
|
-
__NOTE__
|
|
37
|
-
## Rules
|
|
38
|
-
- After \`hozu add feature\`, do not print the generated files: edit the texts it lists; \`hozu map\` shows the rest.
|
|
39
|
-
- Apply the fix each diagnostic gives; do not work around a rule.
|
|
40
|
-
- Every behaviour change comes with a contract change.
|
|
41
|
-
- Do not edit \`__SKILL__/\`: \`__RUN__ hozu skill\` rewrites it for the installed Hozu version.
|
|
42
|
-
`;
|
|
43
|
-
const KNOWN = [GUIDE_07, GUIDE_07.replace(BROWSE, '')];
|
|
44
15
|
const fill = (text, values) => Object.entries(values).reduce((out, [key, value]) => out.replaceAll(`__${key}__`, value), text);
|
|
45
16
|
const note = (runner, skillRunner) => runner === skillRunner
|
|
46
17
|
? ''
|
|
@@ -58,7 +29,7 @@ export function currentGuide() {
|
|
|
58
29
|
}
|
|
59
30
|
/** The 0.8 guide for one target, between the markers. */
|
|
60
31
|
export const guideBlock = (target, name, runner, template = currentGuide()) => `${BEGIN}\n${filled(template, target, name, runner, 'npx').trimEnd()}\n${END}\n`;
|
|
61
|
-
/** The new Hozu block of a CLAUDE.md / AGENTS.md
|
|
32
|
+
/** The new Hozu block of a CLAUDE.md / AGENTS.md, between markers; a file without markers is `custom`. */
|
|
62
33
|
export function migrateGuide(existing, target, dir, runner, template = currentGuide()) {
|
|
63
34
|
const begin = existing?.indexOf(BEGIN) ?? -1;
|
|
64
35
|
const end = existing?.indexOf(END) ?? -1;
|
|
@@ -72,12 +43,6 @@ export function migrateGuide(existing, target, dir, runner, template = currentGu
|
|
|
72
43
|
const code = existing.slice(0, begin) + block + existing.slice(end + END.length).replace(/^\n/, '');
|
|
73
44
|
return { kind: code === existing ? 'current' : 'replaced', code };
|
|
74
45
|
}
|
|
75
|
-
for (const r of RUNNERS) {
|
|
76
|
-
if (KNOWN.some((known) => existing === filled(known, target, name, r, 'pnpm exec')))
|
|
77
|
-
return { kind: 'marked', code: block };
|
|
78
|
-
if (existing === filled(template, target, name, r, 'npx'))
|
|
79
|
-
return { kind: 'marked', code: block };
|
|
80
|
-
}
|
|
81
46
|
return { kind: 'custom', block };
|
|
82
47
|
}
|
|
83
48
|
//# sourceMappingURL=guide.js.map
|
package/dist/guide.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"guide.js","sourceRoot":"","sources":["../src/guide.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAIxC,MAAM,CAAC,MAAM,OAAO,GAAsB,CAAC,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;AAE9E,MAAM,CAAC,MAAM,KAAK,GAAG,kFAAkF,CAAA;AACvG,MAAM,CAAC,MAAM,GAAG,GAAG,gBAAgB,CAAA;AAEnC,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,qBAAqB,EAAE,IAAI,EAAE,8CAA8C,EAAE;IAC1G;QACE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,qBAAqB;QAC5B,IAAI,EAAE,qEAAqE;KAC5E;CACO,CAAA;AAIV,MAAM,
|
|
1
|
+
{"version":3,"file":"guide.js","sourceRoot":"","sources":["../src/guide.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAIxC,MAAM,CAAC,MAAM,OAAO,GAAsB,CAAC,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;AAE9E,MAAM,CAAC,MAAM,KAAK,GAAG,kFAAkF,CAAA;AACvG,MAAM,CAAC,MAAM,GAAG,GAAG,gBAAgB,CAAA;AAEnC,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,qBAAqB,EAAE,IAAI,EAAE,8CAA8C,EAAE;IAC1G;QACE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,qBAAqB;QAC5B,IAAI,EAAE,qEAAqE;KAC5E;CACO,CAAA;AAIV,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,MAA8B,EAAE,EAAE,CAC5D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,GAAG,IAAI,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,CAAA;AAEjG,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAE,EAAE,CACnD,MAAM,KAAK,WAAW;IACpB,CAAC,CAAC,EAAE;IACJ,CAAC,CAAC,oCAAoC,WAAW,2BAA2B,MAAM,SAAS,CAAA;AAE/F,SAAS,MAAM,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAY,EAAE,MAAc,EAAE,WAAmB;IACjG,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE;QACjD,IAAI,EAAE,IAAI;QACV,GAAG,EAAE,MAAM;QACX,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC;KAChC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,OAAO,YAAY,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,uBAAuB,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;AAC/F,CAAC;AAED,yDAAyD;AACzD,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,IAAY,EAAE,MAAc,EAAE,QAAQ,GAAG,YAAY,EAAE,EAAE,EAAE,CACpG,GAAG,KAAK,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,KAAK,GAAG,IAAI,CAAA;AAMlF,0GAA0G;AAC1G,MAAM,UAAU,YAAY,CAC1B,QAAuB,EACvB,MAAc,EACd,GAAW,EACX,MAAc,EACd,QAAQ,GAAG,YAAY,EAAE;IAEzB,MAAM,KAAK,GAAG,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;IAC5C,MAAM,GAAG,GAAG,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;IACxC,MAAM,GAAG,GAAG,KAAK,IAAI,CAAC,IAAI,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,QAAS,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;IAC9E,MAAM,IAAI,GAAG,GAAG,EAAE,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAA;IAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,MAAM,CAAA;IAC3E,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC1D,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;IAC9D,IAAI,KAAK,IAAI,CAAC,IAAI,GAAG,GAAG,KAAK,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACnG,OAAO,EAAE,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,CAAA;IACnE,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAA;AAClC,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type Runner } from './guide.ts';
|
|
2
2
|
export type Agent = 'claude' | 'agents' | 'both';
|
|
3
3
|
export type { BlockResult, Runner, Target } from './guide.ts';
|
|
4
|
-
export { BEGIN, currentGuide, END,
|
|
4
|
+
export { BEGIN, currentGuide, END, guideBlock, migrateGuide, RUNNERS, TARGETS } from './guide.ts';
|
|
5
5
|
export declare const AGENTS: readonly Agent[];
|
|
6
6
|
export declare const defaultSkill: string;
|
|
7
7
|
export declare const runnerOf: (userAgent: string | undefined) => Runner;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgB,KAAK,MAAM,EAAW,MAAM,YAAY,CAAA;AAE/D,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AAChD,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAC7D,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgB,KAAK,MAAM,EAAW,MAAM,YAAY,CAAA;AAE/D,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AAChD,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAC7D,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEjG,eAAO,MAAM,MAAM,EAAE,SAAS,KAAK,EAAiC,CAAA;AAGpE,eAAO,MAAM,YAAY,QAAsB,CAAA;AAM/C,eAAO,MAAM,QAAQ,cAAe,MAAM,GAAG,SAAS,KAAG,MAGxD,CAAA;AAQD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAC3C;AAED,wBAAsB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAkB3G;AAYD,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,eAAO,MAAM,WAAW,SAAU,MAAM,WAAW,MAAM;;;;;QAKrD,KAAK;QACL,KAAK;QACL,KAAK;;;QAGL,oBAAoB;QACpB,WAAW;QACX,YAAY;QACZ,WAAW;QACX,YAAY;QACZ,sBAAsB;QACtB,kBAAkB;QAClB,iBAAiB;QACjB,GAAG;;;QAGH,eAAe;QACf,aAAa;QACb,UAAU;;;QAED,IAAI;;CACf,CAAA;AAEF,wBAAsB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAmBtF"}
|
package/dist/index.js
CHANGED
|
@@ -2,7 +2,7 @@ import { cp, mkdir, readdir, readFile, rm, stat, writeFile } from 'node:fs/promi
|
|
|
2
2
|
import { dirname, join, relative } from 'node:path';
|
|
3
3
|
import { fileURLToPath } from 'node:url';
|
|
4
4
|
import { migrateGuide, TARGETS } from './guide.js';
|
|
5
|
-
export { BEGIN, currentGuide, END,
|
|
5
|
+
export { BEGIN, currentGuide, END, guideBlock, migrateGuide, RUNNERS, TARGETS } from './guide.js';
|
|
6
6
|
export const AGENTS = ['claude', 'agents', 'both'];
|
|
7
7
|
const root = fileURLToPath(new URL('../', import.meta.url));
|
|
8
8
|
export const defaultSkill = join(root, 'skill');
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACpF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,EAAE,YAAY,EAAe,OAAO,EAAE,MAAM,YAAY,CAAA;AAI/D,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACpF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,EAAE,YAAY,EAAe,OAAO,EAAE,MAAM,YAAY,CAAA;AAI/D,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEjG,MAAM,CAAC,MAAM,MAAM,GAAqB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;AAEpE,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,KAAK,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;AAC3D,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;AAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;AAEzC,MAAM,OAAO,GAAG,CAAC,KAAY,EAAE,EAAE,CAC/B,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,MAAM,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AAExF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,SAA6B,EAAU,EAAE;IAChE,MAAM,IAAI,GAAG,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IACrC,OAAO,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAA;AAClG,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,EAAE,CAC9B,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CACb,GAAG,EAAE,CAAC,IAAI,EACV,GAAG,EAAE,CAAC,KAAK,CACZ,CAAA;AAaH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,GAAW,EAAE,KAAY,EAAE,OAAqB;IACpF,MAAM,GAAG,GAAe,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;IACnD,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAA;QAChC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QACjD,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAChD,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,IAAI,YAAY,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACzE,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAA;QAC/B,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAC3E,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QAC7D,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ;YAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAA;aACjF,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;YAClC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,KAAK,UAAU,KAAK,CAAC,GAAW;IAC9B,MAAM,GAAG,GAAa,EAAE,CAAA;IACxB,KAAK,MAAM,KAAK,IAAI,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAChE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,KAAK,CAAC,WAAW,EAAE;YAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;;YACpD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrB,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAOD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,OAAe,EAAE,EAAE,CAAC,CAAC;IAC7D,IAAI;IACJ,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,KAAK,EAAE,YAAY;QACnB,KAAK,EAAE,YAAY;QACnB,KAAK,EAAE,YAAY;KACpB;IACD,YAAY,EAAE;QACZ,oBAAoB,EAAE,IAAI,OAAO,EAAE;QACnC,WAAW,EAAE,IAAI,OAAO,EAAE;QAC1B,YAAY,EAAE,IAAI,OAAO,EAAE;QAC3B,WAAW,EAAE,IAAI,OAAO,EAAE;QAC1B,YAAY,EAAE,IAAI,OAAO,EAAE;QAC3B,sBAAsB,EAAE,IAAI,OAAO,EAAE;QACrC,kBAAkB,EAAE,IAAI,OAAO,EAAE;QACjC,iBAAiB,EAAE,IAAI,OAAO,EAAE;QAChC,GAAG,EAAE,QAAQ;KACd;IACD,eAAe,EAAE;QACf,eAAe,EAAE,IAAI,OAAO,EAAE;QAC9B,aAAa,EAAE,UAAU;QACzB,UAAU,EAAE,QAAQ;KACrB;IACD,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;CAC7B,CAAC,CAAA;AAEF,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,OAAsB;IACjE,IAAI,CAAC,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;QACpD,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,6CAA6C,CAAC,CAAA;IACtE,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;IAClC,MAAM,OAAO,GAAa,EAAE,CAAA;IAC5B,KAAK,MAAM,MAAM,IAAI,MAAM,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACtC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QAClE,MAAM,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACjD,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC,MAAM,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;QAC9F,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAA;IACrC,CAAC;IACD,MAAM,SAAS,CACb,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,EACzB,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAC3E,CAAA;IACD,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAC5B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IAC7E,OAAO,OAAO,CAAA;AAChB,CAAC"}
|
package/package.json
CHANGED
package/skill/SKILL.md
CHANGED
|
@@ -26,6 +26,7 @@ Hozu is not in your training data: this file and `npx hozu docs <topic>` are the
|
|
|
26
26
|
| A per-item action stored on the server (pin, archive) | model: the item field, an event, a mutation that `invalidates` the list tag, `on(E, { target: 'pinning', assign: (e) => { ctx.target = e.id } })`, a state with `invoke` → views: the per-item form (`hozu docs patterns`) → app: store it, sort in the list resolver |
|
|
27
27
|
| A control every state handles | `machine({ on: [...] })` |
|
|
28
28
|
| New page | `routes.ts` → a view with `route` → `ui.page(...)` in `hozu.config.ts` |
|
|
29
|
+
| UI (a button, a field) | `ui.use` of a kit component; the catalog: `npx hozu docs components` |
|
|
29
30
|
|
|
30
31
|
## Rules no diagnostic checks
|
|
31
32
|
- **Query resolvers only read.** Writes belong in mutation and endpoint resolvers; a prefetched link runs queries.
|
|
@@ -49,6 +50,6 @@ Hozu is not in your training data: this file and `npx hozu docs <topic>` are the
|
|
|
49
50
|
| filters, modes, per-item actions, load more | `patterns` |
|
|
50
51
|
| worked changes | `recipes` |
|
|
51
52
|
| webhooks, JSON APIs, redirects | `endpoints` |
|
|
52
|
-
| browser APIs, DOM libraries | `
|
|
53
|
+
| components, kits, browser APIs, DOM libraries | `components` |
|
|
53
54
|
| languages, env, HTTP, Markdown, tests, deploying | `i18n` `env` `http` `content` `testing` `deploy` |
|
|
54
55
|
| a diagnostic code | `diagnostics` |
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Components (shared UI, kits, browser code)
|
|
2
|
+
|
|
3
|
+
A UI piece used by several features is a component in a kit. Start with `hozu add kit ui` (writes `ui/kit.ts`,
|
|
4
|
+
`ui/tv.ts` and `project({ kits })`), then `hozu add component ui Button`; `hozu add component <feature> <Name>` makes
|
|
5
|
+
one private to that feature.
|
|
6
|
+
```ts
|
|
7
|
+
// ui/button.ts; ui/kit.ts lists it: ui.kit({ id: 'ui', components: [button, input] })
|
|
8
|
+
const styles = tv({ // tv from ./tv.ts
|
|
9
|
+
base: 'inline-flex gap-2 rounded px-4 py-2 disabled:opacity-50 aria-busy:cursor-wait',
|
|
10
|
+
variants: { tone: { primary: 'bg-indigo-600 text-white', ghost: 'text-slate-700 hover:bg-slate-100' } },
|
|
11
|
+
defaultVariants: { tone: 'primary' },
|
|
12
|
+
})
|
|
13
|
+
export const Button = ui.component({
|
|
14
|
+
tag: 'button', styles, slots: ['icon'], children: true, events: ['press'],
|
|
15
|
+
props: z.object({ type: z.enum(['button', 'submit']).default('button'), busy: z.boolean().default(false) }),
|
|
16
|
+
render: ({ props, slots, children, on }) =>
|
|
17
|
+
ui.button({ type: props.type, 'aria-busy': props.busy, on: { click: on.press } }, [slots.icon, ...children]),
|
|
18
|
+
})
|
|
19
|
+
```
|
|
20
|
+
```ts
|
|
21
|
+
ui.use(Button, { variant: { tone: 'ghost' }, props: { busy: ctx.saving }, slots: { icon: ui.span({}, ['+']) },
|
|
22
|
+
on: { press: ui.send(Save, {}) }, class: 'w-full' }, ['Save']) // in a view; its id is ui.Button
|
|
23
|
+
```
|
|
24
|
+
- **`ui.use` keys:** `variant` (literals), `props` (data), `slots`, `on`, `class`; children only with
|
|
25
|
+
`children: true`. Every key is optional when the component needs none.
|
|
26
|
+
- **Variants vs props:** a variant is a fixed look chosen in the view (HZ071 for data); anything that changes while
|
|
27
|
+
the page runs is a prop. Style a state through the attribute that announces it: `disabled:`, `aria-pressed:`,
|
|
28
|
+
`aria-busy:`, `aria-invalid:`, `aria-expanded:`, `open:`. `toggle` is for states without one.
|
|
29
|
+
- **Render:** it reads only `props`, `slots`, `children`, `on` and `classes` (the other tv slots,
|
|
30
|
+
`classes.label`); the caller passes sends, links and text in (HZ070). Hozu puts the root class on the root.
|
|
31
|
+
- **Extension:** `class` may add classes that set none of the component's properties (`w-full`, `relative`,
|
|
32
|
+
`md:hidden`). To change one, declare a variant; a one-off ends with `!` (`rounded-lg!`) (HZ072–HZ077).
|
|
33
|
+
`hozu check` counts the `!` per component; `extend: false` refuses every class.
|
|
34
|
+
- A view fragment that two features inline is a component, not a `part()` (HZ080).
|
|
35
|
+
|
|
36
|
+
## Client components (browser APIs, DOM libraries)
|
|
37
|
+
`hozu add component <kit|feature> <Name> --client` writes the declaration, the client module, the bundle in `app.ts`
|
|
38
|
+
and the `@hozu/bundle` dependency.
|
|
39
|
+
```ts
|
|
40
|
+
export const Map = ui.component({ tag: 'div', props: z.object({ lat: z.number(), lng: z.number() }),
|
|
41
|
+
emits: { picked: z.object({ id: z.string() }) }, client: new URL('./map.client.ts', import.meta.url),
|
|
42
|
+
load: 'visible', render: () => ui.div({}, []) }) // 'eager' | 'visible' | 'idle'
|
|
43
|
+
ui.use(Map, { props: { lat: ctx.lat, lng: ctx.lng }, on: { picked: (d) => ui.send(Pick, { id: d.id }) },
|
|
44
|
+
class: 'h-96 w-full' })
|
|
45
|
+
```
|
|
46
|
+
```ts
|
|
47
|
+
// map.client.ts: a type-only import of the declaration
|
|
48
|
+
import { implement } from '@hozu/core/component'
|
|
49
|
+
import type { Map } from './components.ts'
|
|
50
|
+
export default implement<typeof Map>(({ el, props, emit, signal }) => {
|
|
51
|
+
const map = createMap(el, props) // any DOM library
|
|
52
|
+
map.on('pick', (id) => emit('picked', { id }))
|
|
53
|
+
return { update(next) { map.move(next) }, destroy() { map.remove() } }
|
|
54
|
+
})
|
|
55
|
+
```
|
|
56
|
+
- The render is the server HTML the module takes over; with `children: true` the children stay as the no-JS
|
|
57
|
+
fallback. The root takes no attributes or `on`: put a role or label on a wrapping element.
|
|
58
|
+
- `app.ts` passes `components: bundleComponents` (`@hozu/bundle`) to `app()` (HZ045 without it). A library's CSS
|
|
59
|
+
goes in `app.css`; a map or chart host needs a height class.
|
|
60
|
+
- `hozu browse /` lists each one as mounted / failed / not mounted with its size and canvases; a mounted host has
|
|
61
|
+
`data-hozu-component="<id>"` and `data-hozu-component-state="mounted"`.
|
|
62
|
+
|
|
63
|
+
## Look them up
|
|
64
|
+
- `hozu docs components` (this topic, then the app's list), `hozu inspect ui.Button` (variants, props, owned
|
|
65
|
+
classes, every use), `hozu impact ui.Button`.
|
|
66
|
+
- `hozu render ui.Button --variant tone=ghost --props '{"busy":true}' --slot icon=+` renders it alone: HTML, root
|
|
67
|
+
class, owned properties, diagnostics.
|
package/skill/topics/deploy.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Deployment
|
|
2
2
|
|
|
3
3
|
- **One app module:** `project({ app: new URL('./app.ts', import.meta.url) })`, and `app.ts` default-exports
|
|
4
|
-
`app({ resolvers: resolvers(project, (implement) => [...]), session?,
|
|
4
|
+
`app({ resolvers: resolvers(project, (implement) => [...]), session?, components?, og?, csp?, onError?, preview? })`
|
|
5
5
|
from `@hozu/runtime-server`. `hozu serve`, `hozu check`, `hozu get`, `hozu browse` and `testApp(app)` all run this
|
|
6
6
|
module, so what the tools verify is what production serves. There is no wrapper position: headers go through
|
|
7
7
|
`project({ http })`, statuses through `head.failed` and endpoint `failed`, the language through the URL.
|
|
@@ -23,6 +23,7 @@ around the rule.
|
|
|
23
23
|
| HZ026 | a class produces no CSS | fix the Tailwind class |
|
|
24
24
|
| HZ027 | a DOM field used outside an event, or wrong for this event | read `ui.dom.*` only in `ui.send` payloads |
|
|
25
25
|
| HZ028 | `img` without width/height | add both |
|
|
26
|
+
| HZ029 | a client component's module is missing, or a handler for an event it does not emit | create the module (`hozu add component … --client`); handle declared `emits` only |
|
|
26
27
|
| HZ030 | `ui.html` of untrusted data | render text instead |
|
|
27
28
|
| HZ031 | a literal not allowed by its schema | use an allowed value (the patch suggests one) |
|
|
28
29
|
| HZ032 | internal link or form action written as a string | `ui.link(route, params)` / `ui.link(endpoint)` |
|
|
@@ -37,7 +38,7 @@ around the rule.
|
|
|
37
38
|
| HZ041 | a machine uses a message, `ui.format` or `locale` | store a code in context; choose the message in the view |
|
|
38
39
|
| HZ043 | `site.offline` has params, no page, or per-request data | point it at a static page, or remove `offline` |
|
|
39
40
|
| HZ044 | a feature file was loaded without the Hozu transform | run node with `--import @hozu/transform/register` (`npm start` does), or add `hozuTransform()` to Vite / Vitest |
|
|
40
|
-
| HZ045 | no `project({ app })`, its default export is not `app(…)`, or views use
|
|
41
|
+
| HZ045 | no `project({ app })`, its default export is not `app(…)`, or views use client components and `app()` has no bundle | `export default app({ resolvers, components: bundleComponents })` |
|
|
41
42
|
| HZ046 | an endpoint path is reserved, has params or collides; an error without a status; a form posting to it with another method or an undeclared field | a static path such as `/api/…` (patch); map every error in `failed` |
|
|
42
43
|
| HZ047 | a `fn` body uses an imported name or `let` state (it is sent to the browser as source) | pass the value as input, or write it as a `const` helper in the module |
|
|
43
44
|
| HZ048 | `seed` names a field the context lacks, has no machine or route, or two views on one page seed a machine | seed top-level context fields, on one view per page |
|
|
@@ -55,6 +56,16 @@ around the rule.
|
|
|
55
56
|
| HZ060 | a page route starts with a locale segment (`/de/…` under `site.locales`) | rename the route (patch); the locale prefix is added for you |
|
|
56
57
|
| HZ061 | (warning) a form-fed event payload declares limits | move them to the mutation input |
|
|
57
58
|
| HZ062 | (warning) a GET endpoint declares `invalidates` | `method: 'POST'`, or keep it on purpose (e-mail links) |
|
|
58
|
-
| HZ063 | (warning) as HZ055, in a form holding `ui.html`, a
|
|
59
|
+
| HZ063 | (warning) as HZ055, in a form holding `ui.html`, a client component or another view | as HZ055 |
|
|
59
60
|
| HZ064 | two contracts with identical IR | remove one (patch) |
|
|
61
|
+
| HZ070 | a component's render references a declaration (event, query, route, message…) | pass a `Send` through `on`, an `Href` prop, text as a prop or slot |
|
|
62
|
+
| HZ071 | a variant from data | make it a prop, styled through an attribute (`aria-pressed:`, `data-[x=y]:`) |
|
|
63
|
+
| HZ072 | a caller's `class` sets a property the component owns | declare a variant; a one-off ends with `!` (snippet) |
|
|
64
|
+
| HZ073 / HZ074 | `!` inside a component / a leading `!x` | remove it (patch in the tv config, snippet in the render) / write `x!` (patch) |
|
|
65
|
+
| HZ075 | (warning) a caller's inherited class (colour, font) is hidden by an inner element | a variant, or style the inner element |
|
|
66
|
+
| HZ076 | (warning) a component owns a margin | remove it (patch); outer spacing is the caller's |
|
|
67
|
+
| HZ077 | (warning) `!` on a property the component does not own | remove the `!` (patch) |
|
|
68
|
+
| HZ078 | the kit's `tv.ts` config differs from the design system | `hozu add kit <id> --sync` |
|
|
69
|
+
| HZ079 | two classes of one element set the same property | the patch: a complementary toggle, or remove the one that never wins |
|
|
70
|
+
| HZ080 | (warning) a `part()` view inlined by two features | the snippet: the same `ui.component` in a kit |
|
|
60
71
|
| HZ042 | `site.locales` empty / missing `site.lang` / not a canonical tag, or `ui.alternate` of an undeclared locale | fix the list (`'zh-TW'`, not `'zh_tw'`) |
|
package/skill/topics/http.md
CHANGED
|
@@ -12,6 +12,6 @@ http: {
|
|
|
12
12
|
headers: [{ routes: 'all', set: { 'permissions-policy': 'camera=()' } }], // not cache-control (HZ038)
|
|
13
13
|
},
|
|
14
14
|
```
|
|
15
|
-
Server options live in the app module: `app({ resolvers, session?,
|
|
15
|
+
Server options live in the app module: `app({ resolvers, session?, components?, onError?, csp?, og?, preview? })`.
|
|
16
16
|
A strict CSP, `nosniff` and a cross-site POST check are on by default; `csp: { script: ['https://…'] }` adds sources.
|
|
17
17
|
There are no rewrites: one URL has one owner. For your own HTTP routes, see `hozu docs endpoints`.
|
package/skill/topics/pages.md
CHANGED
|
@@ -50,4 +50,4 @@ export default project({
|
|
|
50
50
|
- A detail view: `ui.view({ route: itemPage, render: ({ params }) => ui.query(getItem, { id: params.id }, { ready,
|
|
51
51
|
failed: { NotFound: () => ui.p({}, ['Not found']), Unexpected: () => … } }) })`.
|
|
52
52
|
- A page loads JS only when a machine-bound part renders on it (`hozu plan <route>`). Every link loads a document;
|
|
53
|
-
state across pages lives in the URL (`seed`), on the server (queries) or in a
|
|
53
|
+
state across pages lives in the URL (`seed`), on the server (queries) or in a client component's own storage.
|
package/skill/topics/testing.md
CHANGED
|
@@ -33,9 +33,9 @@
|
|
|
33
33
|
- `≠ DIFFERS` marks a step where both modes made a request and the resulting text differs: a no-JS/JS parity bug.
|
|
34
34
|
- Errors: uncaught exceptions, `console.error`s, CSP violations and failed requests, each with the page, the
|
|
35
35
|
resource type and the mode. A 400 re-render of an invalid native post is not an error.
|
|
36
|
-
- Exit code 1 when a step failed, the modes differ, a
|
|
36
|
+
- Exit code 1 when a step failed, the modes differ, a client component failed or any error was printed. `--json` has every
|
|
37
37
|
line; `--full` prints them all; `--select <css>`, `--screenshot shot.png` and `--reduced-motion` as before.
|
|
38
|
-
- It also prints the
|
|
38
|
+
- It also prints the client components on the page (mounted, failed, size, canvases).
|
|
39
39
|
- In code: `const page = await testApp(app).get('/')` from `@hozu/testing`, with `app` the default export of
|
|
40
40
|
`app.ts` → `{ status, headers, html, text, payload }`; `.post(path, fields)` submits a native form, with fields as
|
|
41
41
|
a record or as `[name, value]` pairs for repeated names. `testApp(app, { session: store })` may swap only the
|
package/skill/topics/widgets.md
DELETED
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
# Widgets (browser APIs, DOM libraries)
|
|
2
|
-
|
|
3
|
-
Start with `hozu add widget <feature> <Name>`: it writes the declaration, the client module, the bundle in `app.ts`
|
|
4
|
-
and the `@hozu/bundle` dependency. There is no `widget` export; the pieces are:
|
|
5
|
-
```ts
|
|
6
|
-
export const Map = ui.widget({ tag: 'div', props: z.object({ lat: z.number(), lng: z.number() }),
|
|
7
|
-
events: { picked: z.object({ id: z.string() }) }, client: new URL('./map.client.ts', import.meta.url),
|
|
8
|
-
load: 'visible', wraps: false }) // widgets.ts; the feature lists the module
|
|
9
|
-
ui.use(Map, { props: { lat: ctx.lat, lng: ctx.lng }, on: { picked: (d) => ui.send(Pick, { id: d.id }) },
|
|
10
|
-
class: 'h-96 w-full' }, []) // in a view
|
|
11
|
-
```
|
|
12
|
-
```ts
|
|
13
|
-
// map.client.ts: a type-only import of the declaration
|
|
14
|
-
import { implement } from '@hozu/core/widget'
|
|
15
|
-
import type { Map } from './widgets.ts'
|
|
16
|
-
export default implement<typeof Map>(({ el, props, emit, signal }) => {
|
|
17
|
-
const map = createMap(el, props) // any DOM library
|
|
18
|
-
map.on('pick', (id) => emit('picked', { id }))
|
|
19
|
-
return { update(next) { map.move(next) }, destroy() { map.remove() } }
|
|
20
|
-
})
|
|
21
|
-
```
|
|
22
|
-
- `on` is optional. `ui.use` takes no other attributes: put a role or label on a wrapping element,
|
|
23
|
-
`ui.section({ role: 'region', 'aria-label': 'Map' }, [ui.use(Map, { props }, [])])`.
|
|
24
|
-
- `load`: `'eager' | 'visible' | 'idle'`; `wraps: true` keeps the children as server HTML.
|
|
25
|
-
- `app.ts` passes `widgets: bundleWidgets` to `app()` (`import { bundleWidgets } from '@hozu/bundle'`; without it
|
|
26
|
-
the server refuses to start and `hozu check` reports HZ045; `hozu build` bundles them itself). A library's CSS goes in `app.css` (`@import "leaflet/dist/leaflet.css";`); a map or chart host needs a
|
|
27
|
-
height class.
|
|
28
|
-
- Check it with `hozu browse /` (no server): each widget is listed as mounted / failed / not mounted with its size
|
|
29
|
-
and canvases, next to any error it threw. A mounted host carries `data-hozu-widget="<feature>.<Name>"` and
|
|
30
|
-
`data-hozu-widget-state="mounted"` for your own browser tests.
|