@caltho/site-kit 0.2.5 → 0.2.6

package/README.md

@@ -58,7 +58,7 @@ the kit only checks it's a URL.
 | **Content** (`@caltho/site-kit/content`) | `defineSite` and the pieces to build blocks from (`text`, `md`, `image`, `link`, `href`, `business`, …); the checks, including that every link lands on a page and every `#part` exists; the JSON Schema. |
 | **prepare** | Loads the content from CalOS (`CALOS_CONTENT_URL`, `CALOS_SITE_TOKEN`; the site's own while nothing's published there) or `content/site.json`, sends CalOS the schema, checks it, writes the schema, and makes every picture the content names as WebP at the widths screens need plus a 1200×630 share crop, named by content so they cache for a year. |
 | **finish** | After the framework's build: a content security policy in every page (each inline script named by hash), `_headers` (security headers, long caching, `noindex` on preview addresses), and `_redirects` from CalOS (`CALOS_REDIRECTS_URL`; a build that can't reach CalOS fails rather than lose them). |
-| **check** | Every page in a real browser through axe (WCAG 2.0–2.2 A and AA, best practice) on a computer and a phone; fails on any violation, on anything the policy blocks, and on anything that doesn't load. |
+| **check** | Every page in a real browser on a computer and a phone: fails on anything the policy blocks and anything that doesn't load. What axe finds (WCAG 2.0–2.2 A and AA, best practice) is said with where, for the site to weigh (a colour the business chose over the contrast rule is their choice); `--strict` fails on it too, `--allow=rule,rule` leaves named rules out. |
 | **Search** | Titles that fit, canonical addresses, the business as schema.org data (hours, areas, address), FAQ and breadcrumb data, robots.txt, the sitemap. |
 | **Policies** | Privacy, accessibility and terms, written from the business's facts and what the site does. Optional: a site calls `policy()` where it wants them. |
 | **Helpers for components** (`@caltho/site-kit/lib`) | The pieces that touch no files: `md` (Markdown that can't run HTML), `plain`, `policy`, the search data, `imagesIn`, `clock`, `dayRange`, `telHref`. |

package/dist/cli/check.d.ts

@@ -1,4 +1,5 @@
 export declare function check(dir: string, o?: {
-    allow?: string[];
+    allow?: string[]; /** What axe finds fails the check too. */
+    strict?: boolean;
     log?: (line: string) => void;
 }): Promise<boolean>;

package/dist/cli/check.js

@@ -1,7 +1,9 @@
 // Checks a built site in a real browser before it's published: every page in its sitemap and the
-// 404 page, on a computer screen and a phone, with axe (WCAG 2.2 AA and best practice), and with
-// nothing blocked by the site's own content security policy or failing to load. Says what's wrong
-// and where; true when nothing is.
+// 404 page, on a computer screen and a phone, with nothing blocked by the site's own content
+// security policy or failing to load, and with axe (WCAG 2.2 AA and best practice). Something
+// broken fails the check. What axe finds is said, with where, but is the site's to weigh (a colour
+// the business chose over the contrast rule is their choice): it fails the check only with
+// `strict`. True when nothing is broken (and, strict, nothing is found).
 var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
     if (typeof path === "string" && /^\.\.?\//.test(path)) {
         return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
@@ -28,6 +30,7 @@ export async function check(dir, o = {}) {
     paths.push("/404.html");
     const server = await serve(dir, port);
     const problems = [];
+    const found = [];
     const browser = await chromium.launch(process.env.CHROMIUM_PATH ? { executablePath: process.env.CHROMIUM_PATH } : {}).catch((err) => {
         server.close();
         throw err;
@@ -58,7 +61,7 @@ export async function check(dir, o = {}) {
                 window.axe.run(document, { runOnly: { type: "tag", values: ["wcag2a", "wcag2aa", "wcag21a", "wcag21aa", "wcag22aa", "best-practice"] } })));
                 for (const v of result.violations.filter((x) => !allow.has(x.id))) {
                     const targets = v.nodes.slice(0, 3).map((n) => n.target.join(" "));
-                    problems.push(`${path} (${screen}): ${v.id}: ${v.help} [${v.impact}] at ${targets.join(", ")}${v.nodes.length > 3 ? ` and ${v.nodes.length - 3} more` : ""}`);
+                    found.push(`${path} (${screen}): ${v.id}: ${v.help} [${v.impact}] at ${targets.join(", ")}${v.nodes.length > 3 ? ` and ${v.nodes.length - 3} more` : ""}`);
                 }
             }
             await context.close();
@@ -68,10 +71,14 @@ export async function check(dir, o = {}) {
         await browser.close();
         server.close();
     }
-    if (problems.length) {
-        log(`✗ ${dir}: ${problems.length} problem${problems.length === 1 ? "" : "s"}\n  - ${[...new Set(problems)].join("\n  - ")}`);
-        return false;
-    }
-    log(`✓ ${dir}: ${paths.length} pages, on a computer and a phone: no accessibility problems axe can find${allow.size ? ` (except the ones allowed: ${[...allow].join(", ")})` : ""}, nothing blocked or broken`);
-    return true;
+    const list = (lines) => `\n  - ${[...new Set(lines)].join("\n  - ")}`;
+    if (problems.length)
+        log(`✗ ${dir}: ${problems.length} problem${problems.length === 1 ? "" : "s"}${list(problems)}`);
+    else
+        log(`✓ ${dir}: ${paths.length} pages, on a computer and a phone: nothing blocked or broken`);
+    if (found.length)
+        log(`${o.strict ? "✗" : "•"} ${dir}: accessibility, ${found.length} thing${found.length === 1 ? "" : "s"} to look at${o.strict ? "" : " (the site's to weigh; --strict fails on them)"}${list(found)}`);
+    else
+        log(`✓ ${dir}: no accessibility problems axe can find${allow.size ? ` (except the ones allowed: ${[...allow].join(", ")})` : ""}`);
+    return !problems.length && (!o.strict || !found.length);
 }

package/dist/cli/index.js

@@ -2,7 +2,7 @@
 // site-kit prepare            content checked, schema written, images ready for the build (.site/, public/)
 // site-kit finish [out]       after the build: the content security policy, _headers, _redirects
 // site-kit serve [out] [port] the build served as Cloudflare Pages will
-// site-kit check [out] [--allow=rule,rule]  every page in a real browser: axe, blocked or broken loads
+// site-kit check [out] [--allow=rule,rule] [--strict]  every page in a real browser: blocked or broken loads fail; what axe finds is said (fails only with --strict)
 import { resolve } from "node:path";
 import { finish } from "../finish.js";
 import { prepare } from "../prepare.js";
@@ -23,7 +23,7 @@ try {
         const { check } = await import("./check.js");
         const allow = args.filter((a) => a.startsWith("--allow=")).flatMap((a) => a.slice(8).split(","));
         const dir = args.find((a) => !a.startsWith("--")) ?? "out";
-        process.exitCode = (await check(resolve(dir), { allow })) ? 0 : 1;
+        process.exitCode = (await check(resolve(dir), { allow, strict: args.includes("--strict") })) ? 0 : 1;
     }
     else {
         console.error("Usage: site-kit prepare | finish [out] | serve [out] [port] | check [out]");

package/dist/content/index.js

@@ -149,7 +149,7 @@ export function defineSite(blocks, o = {}) {
         lang: z.string().default("en-US").meta({ title: "Language" }),
         business,
         /** Where the contact forms post to, if the site has any (a CalOS form's address, or another service's). */
-        form: z.url({ protocol: /^https?$/ }).meta({ title: "Where its forms send" }).optional(),
+        form: z.url({ protocol: /^https?$/ }).meta({ title: "Where its forms send", "x-ui": "form" }).optional(),
         /** The header's links in order, and its button: edited as one list in CalOS. Left out, the pages' menu labels are used. */
         menu: z
             .object({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caltho/site-kit",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "What every Caltho site is built with: the contract with CalOS (content, and how a site declares what is editable), images, search and security, and the checks",
   "license": "MIT",
   "type": "module",