@staticforge/checker 0.0.0-stage → 0.1.1

package/dist/html-validate.js

@@ -0,0 +1,103 @@
+import { HtmlValidate, StaticConfigLoader } from 'html-validate';
+/**
+ * html-validate rules that check the same thing as a staticforge rule report
+ * under the staticforge ID, so the finding is de-duplicated against (and fixed
+ * by) the source rule. Everything else is reported as `html/<rule>`.
+ */
+const ALIASES = {
+    'heading-level': 'heading-order',
+    'wcag/h37': 'img-alt',
+};
+/** WCAG success criteria for html-validate's accessibility rules. */
+const WCAG = {
+    'area-alt': '1.1.1',
+    'aria-hidden-body': '4.1.2',
+    'aria-label-misuse': '4.1.2',
+    'empty-heading': '2.4.6',
+    'heading-level': '1.3.1',
+    'hidden-focusable': '4.1.2',
+    'input-missing-label': '1.3.1',
+    'meta-refresh': '2.2.1',
+    'multiple-labeled-controls': '1.3.1',
+    'no-autoplay': '1.4.2',
+    'no-redundant-role': '4.1.2',
+    'text-content': '4.1.2',
+    'unique-landmark': '1.3.1',
+    'valid-autocomplete': '1.3.5',
+    'wcag/h30': '2.4.4',
+    'wcag/h32': '3.2.2',
+    'wcag/h36': '1.1.1',
+    'wcag/h37': '1.1.1',
+    'wcag/h63': '1.3.1',
+    'wcag/h67': '1.1.1',
+    'wcag/h71': '1.3.1',
+};
+/** Messages that a staticforge rule reports (with a fix or a better hint): [rule, message text]. */
+const COVERED = [
+    ['element-required-content', '<title>'], // document-title
+    ['element-required-attributes', '"lang"'], // html-lang
+    ['element-required-attributes', '<iframe> is missing required "title"'], // iframe-title
+];
+/**
+ * html-validate resolves (and schema-validates) its config for every file,
+ * which took more than half of the time per page. One config applies to all
+ * pages, so it is resolved once.
+ */
+class ResolvedOnceLoader extends StaticConfigLoader {
+    resolved;
+    getConfigFor(handle, configOverride) {
+        if (configOverride !== undefined)
+            return super.getConfigFor(handle, configOverride);
+        this.resolved ??= super.getConfigFor(handle);
+        return this.resolved;
+    }
+}
+let validator;
+function getValidator() {
+    validator ??= new HtmlValidate(new ResolvedOnceLoader({
+        extends: ['html-validate:standard', 'html-validate:a11y', 'html-validate:document'],
+        rules: {
+            // Subresource integrity only protects resources from other origins.
+            'require-sri': ['error', { target: 'crossorigin' }],
+            // Covered by the document-title rule, which can also fix it.
+            'empty-title': 'off',
+            // Not accessibility problems: worth knowing, not worth failing a build.
+            'long-title': 'warn',
+            'no-implicit-button-type': 'warn',
+            'no-redundant-role': 'warn',
+            'prefer-button': 'warn',
+            'prefer-native-element': 'warn',
+            'prefer-tbody': 'warn',
+            'tel-non-breaking': 'warn',
+        },
+    }));
+    return validator;
+}
+/** Validate one built page with html-validate. */
+export async function validateHtml(page, html) {
+    const report = await getValidator().validateString(html, page.output);
+    const findings = [];
+    for (const result of report.results) {
+        for (const message of result.messages) {
+            if (COVERED.some(([ruleId, text]) => message.ruleId === ruleId && message.message.includes(text))) {
+                continue;
+            }
+            const wcag = WCAG[message.ruleId];
+            findings.push({
+                layer: 'output',
+                diagnostic: {
+                    ruleId: ALIASES[message.ruleId] ?? `html/${message.ruleId}`,
+                    severity: message.severity >= 2 ? 'error' : 'warning',
+                    message: message.message,
+                    ...(page.source !== undefined && { file: page.source }),
+                    url: page.url,
+                    ...(message.selector !== null && { selector: message.selector }),
+                    ...(wcag !== undefined && { wcag }),
+                    ...(message.ruleUrl !== undefined && { helpUrl: message.ruleUrl }),
+                },
+            });
+        }
+    }
+    return findings;
+}
+//# sourceMappingURL=html-validate.js.map

package/dist/html-validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-validate.js","sourceRoot":"","sources":["../src/html-validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,YAAY,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAGlF;;;;GAIG;AACH,MAAM,OAAO,GAA2B;IACtC,eAAe,EAAE,eAAe;IAChC,UAAU,EAAE,SAAS;CACtB,CAAC;AAEF,qEAAqE;AACrE,MAAM,IAAI,GAA2B;IACnC,UAAU,EAAE,OAAO;IACnB,kBAAkB,EAAE,OAAO;IAC3B,mBAAmB,EAAE,OAAO;IAC5B,eAAe,EAAE,OAAO;IACxB,eAAe,EAAE,OAAO;IACxB,kBAAkB,EAAE,OAAO;IAC3B,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,OAAO;IACvB,2BAA2B,EAAE,OAAO;IACpC,aAAa,EAAE,OAAO;IACtB,mBAAmB,EAAE,OAAO;IAC5B,cAAc,EAAE,OAAO;IACvB,iBAAiB,EAAE,OAAO;IAC1B,oBAAoB,EAAE,OAAO;IAC7B,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;CACpB,CAAC;AAEF,oGAAoG;AACpG,MAAM,OAAO,GAAuB;IAClC,CAAC,0BAA0B,EAAE,SAAS,CAAC,EAAE,iBAAiB;IAC1D,CAAC,6BAA6B,EAAE,QAAQ,CAAC,EAAE,YAAY;IACvD,CAAC,6BAA6B,EAAE,sCAAsC,CAAC,EAAE,eAAe;CACzF,CAAC;AAEF;;;;GAIG;AACH,MAAM,kBAAmB,SAAQ,kBAAkB;IACzC,QAAQ,CAA6D;IAEpE,YAAY,CACnB,MAAc,EACd,cAA2B;QAE3B,IAAI,cAAc,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QACpF,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAED,IAAI,SAAmC,CAAC;AAExC,SAAS,YAAY;IACnB,SAAS,KAAK,IAAI,YAAY,CAC5B,IAAI,kBAAkB,CAAC;QACrB,OAAO,EAAE,CAAC,wBAAwB,EAAE,oBAAoB,EAAE,wBAAwB,CAAC;QACnF,KAAK,EAAE;YACL,oEAAoE;YACpE,aAAa,EAAE,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;YACnD,6DAA6D;YAC7D,aAAa,EAAE,KAAK;YACpB,wEAAwE;YACxE,YAAY,EAAE,MAAM;YACpB,yBAAyB,EAAE,MAAM;YACjC,mBAAmB,EAAE,MAAM;YAC3B,eAAe,EAAE,MAAM;YACvB,uBAAuB,EAAE,MAAM;YAC/B,cAAc,EAAE,MAAM;YACtB,kBAAkB,EAAE,MAAM;SAC3B;KACF,CAAC,CACH,CAAC;IACF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,kDAAkD;AAClD,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,IAAe,EAAE,IAAY;IAC9D,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACtE,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACpC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACtC,IACE,OAAO,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAChF,EACD,CAAC;gBACD,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAClC,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,QAAQ;gBACf,UAAU,EAAE;oBACV,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,QAAQ,OAAO,CAAC,MAAM,EAAE;oBAC3D,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;oBACrD,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;oBACvD,GAAG,EAAE,IAAI,CAAC,GAAG;oBACb,GAAG,CAAC,OAAO,CAAC,QAAQ,KAAK,IAAI,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;oBAChE,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,CAAC;oBACnC,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;iBACnE;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './check.js';
+export { INSTALL_BROWSER_COMMAND, PLAYWRIGHT_VERSION, type WcagLevel } from './headless.js';
+export * from './report/index.js';
+export type { CheckPage, Finding, Layer } from './types.js';
+export { CheckCache } from './cache.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAC5F,cAAc,mBAAmB,CAAC;AAClC,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from './check.js';
+export { INSTALL_BROWSER_COMMAND, PLAYWRIGHT_VERSION } from './headless.js';
+export * from './report/index.js';
+export { CheckCache } from './cache.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAkB,MAAM,eAAe,CAAC;AAC5F,cAAc,mBAAmB,CAAC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC"}

package/dist/output-rules.d.ts

@@ -0,0 +1,25 @@
+import type { Element, Root } from 'hast';
+import type { CheckPage, Finding } from './types.js';
+export interface OutputContext {
+    page: CheckPage;
+    /** The built page, parsed. */
+    tree: Root;
+    /** Whether a POSIX path relative to the build directory is a file. */
+    exists: (path: string) => boolean;
+    /** Element ids of a built HTML file, by output path. */
+    idsOf: (output: string) => ReadonlySet<string> | undefined;
+    trailingSlash: 'always' | 'never';
+}
+interface Visit {
+    node: Element;
+    ancestors: Element[];
+}
+/** Every element with its ancestors, in document order. */
+export declare function elementsOf(tree: Root): Visit[];
+/** Element ids (and legacy `<a name>` anchors) of a parsed page. */
+export declare function idsOf(tree: Root): Set<string>;
+/** A short CSS path like `#main > article > p:nth-child(3) > img`. */
+export declare function selectorOf({ node, ancestors }: Visit): string;
+export declare function checkOutput(ctx: OutputContext): Finding[];
+export {};
+//# sourceMappingURL=output-rules.d.ts.map

package/dist/output-rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"output-rules.d.ts","sourceRoot":"","sources":["../src/output-rules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAe,MAAM,MAAM,CAAC;AAIvD,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,SAAS,CAAC;IAChB,8BAA8B;IAC9B,IAAI,EAAE,IAAI,CAAC;IACX,sEAAsE;IACtE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IAClC,wDAAwD;IACxD,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC3D,aAAa,EAAE,QAAQ,GAAG,OAAO,CAAC;CACnC;AAED,UAAU,KAAK;IACb,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,OAAO,EAAE,CAAC;CACtB;AAED,2DAA2D;AAC3D,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,KAAK,EAAE,CAa9C;AAED,oEAAoE;AACpE,wBAAgB,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAS7C;AAED,sEAAsE;AACtE,wBAAgB,UAAU,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,KAAK,GAAG,MAAM,CAkB7D;AA0BD,wBAAgB,WAAW,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,EAAE,CA8JzD"}

package/dist/output-rules.js

@@ -0,0 +1,265 @@
+import { toString as hastToString } from 'hast-util-to-string';
+import { resolveRequest } from '@staticforge/server';
+/** Every element with its ancestors, in document order. */
+export function elementsOf(tree) {
+    const out = [];
+    const walk = (children, ancestors) => {
+        for (const child of children) {
+            if (child.type !== 'element')
+                continue;
+            out.push({ node: child, ancestors });
+            walk(child.children, [...ancestors, child]);
+            if (child.tagName === 'template' && child.content)
+                walk(child.content.children, [...ancestors, child]);
+        }
+    };
+    walk(tree.children, []);
+    return out;
+}
+/** Element ids (and legacy `<a name>` anchors) of a parsed page. */
+export function idsOf(tree) {
+    const ids = new Set();
+    for (const { node } of elementsOf(tree)) {
+        const id = node.properties.id;
+        if (typeof id === 'string' && id !== '')
+            ids.add(id);
+        const name = node.properties.name;
+        if (node.tagName === 'a' && typeof name === 'string' && name !== '')
+            ids.add(name);
+    }
+    return ids;
+}
+/** A short CSS path like `#main > article > p:nth-child(3) > img`. */
+export function selectorOf({ node, ancestors }) {
+    const parts = [];
+    const chain = [...ancestors, node];
+    for (let i = chain.length - 1; i >= 0; i--) {
+        const el = chain[i];
+        const id = el.properties.id;
+        if (typeof id === 'string' && /^[A-Za-z][\w-]*$/.test(id)) {
+            parts.unshift(`#${id}`);
+            break;
+        }
+        const parent = chain[i - 1];
+        const siblings = parent?.children.filter((c) => c.type === 'element') ?? [];
+        const sameTag = siblings.filter((s) => s.tagName === el.tagName);
+        parts.unshift(sameTag.length > 1 ? `${el.tagName}:nth-child(${siblings.indexOf(el) + 1})` : el.tagName);
+    }
+    return parts.join(' > ');
+}
+const text = (node) => hastToString(node).replace(/\s+/g, ' ').trim();
+const attr = (node, name) => {
+    const value = node.properties[name];
+    if (typeof value === 'string')
+        return value;
+    if (Array.isArray(value))
+        return value.join(' ');
+    return undefined;
+};
+const URL_ATTRIBUTES = {
+    a: ['href'],
+    area: ['href'],
+    link: ['href'],
+    script: ['src'],
+    img: ['src', 'srcSet'],
+    source: ['src', 'srcSet'],
+    video: ['src', 'poster'],
+    audio: ['src'],
+    track: ['src'],
+    iframe: ['src'],
+    embed: ['src'],
+};
+const SCHEME = /^[a-z][a-z\d+.-]*:/i;
+export function checkOutput(ctx) {
+    const { page, tree } = ctx;
+    const findings = [];
+    const all = elementsOf(tree);
+    const report = (diagnostic, at, match) => {
+        findings.push({
+            layer: 'output',
+            diagnostic: {
+                ...diagnostic,
+                ...(page.source !== undefined && { file: page.source }),
+                url: page.url,
+                ...(at && { selector: selectorOf(at) }),
+            },
+            ...(match !== undefined && { match }),
+        });
+    };
+    const find = (tagName) => all.find((v) => v.node.tagName === tagName);
+    // html-lang
+    const html = find('html');
+    if (html !== undefined && (attr(html.node, 'lang') ?? '').trim() === '') {
+        report({
+            ruleId: 'html-lang',
+            severity: 'error',
+            wcag: '3.1.1',
+            message: 'The <html> element has no lang attribute',
+            hint: 'Set lang on <html> in the layout (or the document), e.g. lang="en".',
+        }, html);
+    }
+    // document-title
+    const title = find('title');
+    if (title === undefined || text(title.node) === '') {
+        report({
+            ruleId: 'document-title',
+            severity: 'error',
+            wcag: '2.4.2',
+            message: title === undefined ? 'Page has no <title>' : 'Page has an empty <title>',
+        }, title ?? html);
+    }
+    // meta-viewport
+    const viewport = all.find((v) => v.node.tagName === 'meta' && attr(v.node, 'name') === 'viewport');
+    if (viewport === undefined) {
+        report({
+            ruleId: 'meta-viewport',
+            severity: 'warning',
+            wcag: '1.4.10',
+            message: 'Page has no <meta name="viewport">, so it will not reflow on small screens',
+            hint: 'Add <meta name="viewport" content="width=device-width, initial-scale=1">.',
+        });
+    }
+    else {
+        const content = (attr(viewport.node, 'content') ?? '').toLowerCase();
+        const scalable = /user-scalable\s*=\s*(no|0)\b/.exec(content);
+        const maxScale = /maximum-scale\s*=\s*([\d.]+)/.exec(content);
+        if (scalable !== null || (maxScale?.[1] !== undefined && Number(maxScale[1]) < 2)) {
+            report({
+                ruleId: 'meta-viewport',
+                severity: 'error',
+                wcag: '1.4.4',
+                message: 'The viewport meta tag prevents zooming',
+                hint: 'Remove user-scalable=no and any maximum-scale below 2.',
+            }, viewport);
+        }
+    }
+    // landmark-main
+    const main = all.find((v) => v.node.tagName === 'main' || attr(v.node, 'role') === 'main');
+    if (main === undefined) {
+        report({
+            ruleId: 'landmark-main',
+            severity: 'warning',
+            wcag: '1.3.1',
+            message: 'Page has no <main> landmark',
+            hint: 'Wrap the primary content in <main id="main">.',
+        });
+    }
+    // skip-link: pages with repeated blocks (header/nav) need a way past them.
+    const body = find('body');
+    const hasBlocks = all.some((v) => v.node.tagName === 'nav' || v.node.tagName === 'header');
+    if (body !== undefined && hasBlocks) {
+        const firstLink = all.find((v) => v.node.tagName === 'a' && attr(v.node, 'href') !== undefined);
+        const href = firstLink === undefined ? undefined : attr(firstLink.node, 'href');
+        const target = href?.startsWith('#') ? safeDecode(href.slice(1)) : undefined;
+        const ids = idsOf(tree);
+        if (target === undefined || target === '' || !ids.has(target)) {
+            report({
+                ruleId: 'skip-link',
+                severity: 'warning',
+                wcag: '2.4.1',
+                message: 'The first link on the page is not a skip link to the main content',
+                hint: 'Start <body> with <a class="skip-link" href="#main">Skip to content</a>.',
+            }, firstLink);
+        }
+    }
+    for (const visit of all) {
+        const { node } = visit;
+        // video-captions
+        if (node.tagName === 'video') {
+            const hasCaptions = node.children.some((c) => c.type === 'element' &&
+                c.tagName === 'track' &&
+                ['captions', 'subtitles'].includes(attr(c, 'kind') ?? ''));
+            if (!hasCaptions) {
+                report({
+                    ruleId: 'video-captions',
+                    severity: 'warning',
+                    wcag: '1.2.2',
+                    message: 'Video has no captions track',
+                    hint: 'Add <track kind="captions" src="…vtt" srclang="en">, unless the video has no speech.',
+                }, visit);
+            }
+        }
+        // iframe-title
+        if (node.tagName === 'iframe' &&
+            (attr(node, 'title') ?? '').trim() === '' &&
+            String(node.properties.ariaHidden) !== 'true') {
+            report({
+                ruleId: 'iframe-title',
+                severity: 'error',
+                wcag: '4.1.2',
+                message: '<iframe> has no title describing its content',
+            }, visit);
+        }
+        checkUrls(visit, ctx, report);
+    }
+    return findings;
+}
+const safeDecode = (value) => {
+    try {
+        return decodeURIComponent(value);
+    }
+    catch {
+        return value;
+    }
+};
+function checkUrls(visit, ctx, report) {
+    const { node } = visit;
+    for (const name of URL_ATTRIBUTES[node.tagName] ?? []) {
+        const raw = node.properties[name];
+        if (typeof raw !== 'string' && !Array.isArray(raw))
+            continue;
+        const values = name === 'srcSet'
+            ? String(Array.isArray(raw) ? raw.join(',') : raw)
+                .split(',')
+                .map((candidate) => candidate.trim().split(/\s+/)[0] ?? '')
+            : [String(Array.isArray(raw) ? raw.join(' ') : raw)];
+        for (const value of values) {
+            if (value === '' || SCHEME.test(value) || value.startsWith('//'))
+                continue;
+            const url = new URL(value, `http://site.invalid${ctx.page.url}`);
+            const isLink = node.tagName === 'a' || node.tagName === 'area';
+            // Unresolved page sources (e.g. other.md) are reported by the build.
+            if (/\.(?:md|markdown)$/i.test(url.pathname))
+                continue;
+            const resolution = resolveRequest(url.pathname, ctx.exists, {
+                trailingSlash: ctx.trailingSlash,
+            });
+            if (resolution.kind === 'redirect') {
+                report({
+                    ruleId: 'link-trailing-slash',
+                    severity: 'warning',
+                    message: `Link to ${value} redirects to ${resolution.location}`,
+                    hint: "Link to the page's canonical URL to save a redirect.",
+                }, visit, url.pathname);
+                continue;
+            }
+            if (resolution.kind === 'not-found' || resolution.status === 404) {
+                report({
+                    ruleId: 'link-broken',
+                    severity: 'error',
+                    message: isLink
+                        ? `Link to ${value} does not match any page or file in the built site`
+                        : `<${node.tagName}> ${name.toLowerCase()} ${value} does not exist in the built site`,
+                }, visit, url.pathname);
+                continue;
+            }
+            const fragment = safeDecode(url.hash.slice(1));
+            if (!isLink ||
+                fragment === '' ||
+                fragment.toLowerCase() === 'top' ||
+                fragment.startsWith(':~:')) {
+                continue;
+            }
+            const ids = ctx.idsOf(resolution.path);
+            if (ids !== undefined && !ids.has(fragment)) {
+                report({
+                    ruleId: 'link-fragment',
+                    severity: 'warning',
+                    message: `Link to ${value} points to #${fragment}, which is not an id on that page`,
+                    hint: 'Check the heading or element id; heading ids are derived from their text.',
+                }, visit);
+            }
+        }
+    }
+}
+//# sourceMappingURL=output-rules.js.map

package/dist/output-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output-rules.js","sourceRoot":"","sources":["../src/output-rules.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAmBrD,2DAA2D;AAC3D,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,MAAM,GAAG,GAAY,EAAE,CAAC;IACxB,MAAM,IAAI,GAAG,CAAC,QAAuB,EAAE,SAAoB,EAAQ,EAAE;QACnE,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;YAC7B,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;gBAAE,SAAS;YACvC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YACrC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,GAAG,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;YAC5C,IAAI,KAAK,CAAC,OAAO,KAAK,UAAU,IAAI,KAAK,CAAC,OAAO;gBAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,GAAG,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACxB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,KAAK,CAAC,IAAU;IAC9B,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,EAAE;YAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAClC,IAAI,IAAI,CAAC,OAAO,KAAK,GAAG,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,EAAE;YAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrF,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,UAAU,CAAC,EAAE,IAAI,EAAE,SAAS,EAAS;IACnD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,KAAK,GAAG,CAAC,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC;IACnC,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAY,CAAC;QAC/B,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1D,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACxB,MAAM;QACR,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5B,MAAM,QAAQ,GAAG,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAgB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;QAC1F,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC;QACjE,KAAK,CAAC,OAAO,CACX,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,cAAc,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CACzF,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,IAAI,GAAG,CAAC,IAAa,EAAU,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AACvF,MAAM,IAAI,GAAG,CAAC,IAAa,EAAE,IAAY,EAAsB,EAAE;IAC/D,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,cAAc,GAA6B;IAC/C,CAAC,EAAE,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,MAAM,EAAE,CAAC,KAAK,CAAC;IACf,GAAG,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;IACtB,MAAM,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,KAAK,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;IACxB,KAAK,EAAE,CAAC,KAAK,CAAC;IACd,KAAK,EAAE,CAAC,KAAK,CAAC;IACd,MAAM,EAAE,CAAC,KAAK,CAAC;IACf,KAAK,EAAE,CAAC,KAAK,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,GAAG,qBAAqB,CAAC;AAErC,MAAM,UAAU,WAAW,CAAC,GAAkB;IAC5C,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;IAC3B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,CACb,UAAyD,EACzD,EAAU,EACV,KAAc,EACR,EAAE;QACR,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE;gBACV,GAAG,UAAU;gBACb,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvD,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,GAAG,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;aACxC;YACD,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,CAAC;SACtC,CAAC,CAAC;IACL,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,CAAC,OAAe,EAAqB,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IAEjG,YAAY;IACZ,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1B,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACxE,MAAM,CACJ;YACE,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,0CAA0C;YACnD,IAAI,EAAE,qEAAqE;SAC5E,EACD,IAAI,CACL,CAAC;IACJ,CAAC;IAED,iBAAiB;IACjB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5B,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;QACnD,MAAM,CACJ;YACE,MAAM,EAAE,gBAAgB;YACxB,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,2BAA2B;SACnF,EACD,KAAK,IAAI,IAAI,CACd,CAAC;IACJ,CAAC;IAED,gBAAgB;IAChB,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CACvB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,UAAU,CACxE,CAAC;IACF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,CAAC;YACL,MAAM,EAAE,eAAe;YACvB,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,4EAA4E;YACrF,IAAI,EAAE,2EAA2E;SAClF,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QACrE,MAAM,QAAQ,GAAG,8BAA8B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,8BAA8B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAClF,MAAM,CACJ;gBACE,MAAM,EAAE,eAAe;gBACvB,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,wCAAwC;gBACjD,IAAI,EAAE,wDAAwD;aAC/D,EACD,QAAQ,CACT,CAAC;QACJ,CAAC;IACH,CAAC;IAED,gBAAgB;IAChB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,CAAC;IAC3F,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,CAAC;YACL,MAAM,EAAE,eAAe;YACvB,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,6BAA6B;YACtC,IAAI,EAAE,+CAA+C;SACtD,CAAC,CAAC;IACL,CAAC;IAED,2EAA2E;IAC3E,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1B,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;IAC3F,IAAI,IAAI,KAAK,SAAS,IAAI,SAAS,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC;QAChG,MAAM,IAAI,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAChF,MAAM,MAAM,GAAG,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7E,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,MAAM,CACJ;gBACE,MAAM,EAAE,WAAW;gBACnB,QAAQ,EAAE,SAAS;gBACnB,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,mEAAmE;gBAC5E,IAAI,EAAE,0EAA0E;aACjF,EACD,SAAS,CACV,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;QACxB,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QACvB,iBAAiB;QACjB,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CACpC,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,IAAI,KAAK,SAAS;gBACpB,CAAC,CAAC,OAAO,KAAK,OAAO;gBACrB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAC5D,CAAC;YACF,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,MAAM,CACJ;oBACE,MAAM,EAAE,gBAAgB;oBACxB,QAAQ,EAAE,SAAS;oBACnB,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,6BAA6B;oBACtC,IAAI,EAAE,sFAAsF;iBAC7F,EACD,KAAK,CACN,CAAC;YACJ,CAAC;QACH,CAAC;QACD,eAAe;QACf,IACE,IAAI,CAAC,OAAO,KAAK,QAAQ;YACzB,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,MAAM,EAC7C,CAAC;YACD,MAAM,CACJ;gBACE,MAAM,EAAE,cAAc;gBACtB,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,8CAA8C;aACxD,EACD,KAAK,CACN,CAAC;QACJ,CAAC;QACD,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,KAAa,EAAU,EAAE;IAC3C,IAAI,CAAC;QACH,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,SAAS,SAAS,CAChB,KAAY,EACZ,GAAkB,EAClB,MAA4F;IAE5F,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IACvB,KAAK,MAAM,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;YAAE,SAAS;QAC7D,MAAM,MAAM,GACV,IAAI,KAAK,QAAQ;YACf,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;iBAC7C,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC/D,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,KAAK,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,SAAS;YAC3E,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,sBAAsB,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YACjE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,KAAK,GAAG,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,CAAC;YAC/D,qEAAqE;YACrE,IAAI,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAAE,SAAS;YAEvD,MAAM,UAAU,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE;gBAC1D,aAAa,EAAE,GAAG,CAAC,aAAa;aACjC,CAAC,CAAC;YACH,IAAI,UAAU,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBACnC,MAAM,CACJ;oBACE,MAAM,EAAE,qBAAqB;oBAC7B,QAAQ,EAAE,SAAS;oBACnB,OAAO,EAAE,WAAW,KAAK,iBAAiB,UAAU,CAAC,QAAQ,EAAE;oBAC/D,IAAI,EAAE,sDAAsD;iBAC7D,EACD,KAAK,EACL,GAAG,CAAC,QAAQ,CACb,CAAC;gBACF,SAAS;YACX,CAAC;YACD,IAAI,UAAU,CAAC,IAAI,KAAK,WAAW,IAAI,UAAU,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACjE,MAAM,CACJ;oBACE,MAAM,EAAE,aAAa;oBACrB,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,MAAM;wBACb,CAAC,CAAC,WAAW,KAAK,oDAAoD;wBACtE,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK,mCAAmC;iBACxF,EACD,KAAK,EACL,GAAG,CAAC,QAAQ,CACb,CAAC;gBACF,SAAS;YACX,CAAC;YAED,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/C,IACE,CAAC,MAAM;gBACP,QAAQ,KAAK,EAAE;gBACf,QAAQ,CAAC,WAAW,EAAE,KAAK,KAAK;gBAChC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,EAC1B,CAAC;gBACD,SAAS;YACX,CAAC;YACD,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC5C,MAAM,CACJ;oBACE,MAAM,EAAE,eAAe;oBACvB,QAAQ,EAAE,SAAS;oBACnB,OAAO,EAAE,WAAW,KAAK,eAAe,QAAQ,mCAAmC;oBACnF,IAAI,EAAE,2EAA2E;iBAClF,EACD,KAAK,CACN,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/report/index.d.ts

@@ -0,0 +1,5 @@
+export * from './junit.js';
+export * from './pretty.js';
+export * from './sarif.js';
+export * from './schema.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/report/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/report/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/dist/report/index.js

@@ -0,0 +1,5 @@
+export * from './junit.js';
+export * from './pretty.js';
+export * from './sarif.js';
+export * from './schema.js';
+//# sourceMappingURL=index.js.map

package/dist/report/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/report/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/dist/report/junit.d.ts

@@ -0,0 +1,8 @@
+import type { CheckResult } from '../check.js';
+/**
+ * JUnit XML: one test suite per file (or page), one test case per problem.
+ * Problems at or above `failOn` are failures; the rest pass, with the problem
+ * in system-out.
+ */
+export declare function formatJunit(result: CheckResult): string;
+//# sourceMappingURL=junit.d.ts.map

package/dist/report/junit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"junit.d.ts","sourceRoot":"","sources":["../../src/report/junit.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAW/C;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CA8CvD"}

package/dist/report/junit.js

@@ -0,0 +1,51 @@
+const xml = (text) => text
+    .replace(/&/g, '&')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;')
+    .replace(/"/g, '&quot;')
+    // eslint-disable-next-line no-control-regex
+    .replace(/[\u0000-\u0008\u000B\u000C\u000E-\u001F]/g, '');
+/**
+ * JUnit XML: one test suite per file (or page), one test case per problem.
+ * Problems at or above `failOn` are failures; the rest pass, with the problem
+ * in system-out.
+ */
+export function formatJunit(result) {
+    const failing = (d) => d.severity === 'error' || (result.failOn === 'warning' && d.severity === 'warning');
+    const suites = new Map();
+    for (const d of result.diagnostics) {
+        const key = d.file ?? d.url ?? 'site';
+        suites.set(key, [...(suites.get(key) ?? []), d]);
+    }
+    const failures = result.diagnostics.filter(failing).length;
+    const out = [
+        '<?xml version="1.0" encoding="UTF-8"?>',
+        `<testsuites name="sforge check" tests="${result.diagnostics.length}" failures="${failures}" time="${(result.durationMs / 1000).toFixed(3)}">`,
+    ];
+    for (const [name, diagnostics] of suites) {
+        out.push(`  <testsuite name="${xml(name)}" tests="${diagnostics.length}" failures="${diagnostics.filter(failing).length}">`);
+        for (const d of diagnostics) {
+            const location = d.line !== undefined ? `${name}:${d.line}:${d.column ?? 1}` : name;
+            const details = [
+                `${location} ${d.severity} ${d.ruleId}`,
+                d.message,
+                d.url !== undefined ? `Page: ${d.url}` : undefined,
+                d.selector !== undefined ? `Element: ${d.selector}` : undefined,
+                d.wcag !== undefined ? `WCAG: ${d.wcag}` : undefined,
+                d.hint,
+                d.helpUrl,
+            ]
+                .filter((s) => s !== undefined)
+                .join('\n');
+            out.push(`    <testcase classname="${xml(name)}" name="${xml(`${d.ruleId}: ${d.message}`)}">`);
+            out.push(failing(d)
+                ? `      <failure type="${xml(d.ruleId)}" message="${xml(d.message)}">${xml(details)}</failure>`
+                : `      <system-out>${xml(details)}</system-out>`);
+            out.push('    </testcase>');
+        }
+        out.push('  </testsuite>');
+    }
+    out.push('</testsuites>', '');
+    return out.join('\n');
+}
+//# sourceMappingURL=junit.js.map

package/dist/report/junit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"junit.js","sourceRoot":"","sources":["../../src/report/junit.ts"],"names":[],"mappings":"AAGA,MAAM,GAAG,GAAG,CAAC,IAAY,EAAU,EAAE,CACnC,IAAI;KACD,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;KACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;KACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;KACrB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,4CAA4C;KAC3C,OAAO,CAAC,2CAA2C,EAAE,EAAE,CAAC,CAAC;AAE9D;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAmB;IAC7C,MAAM,OAAO,GAAG,CAAC,CAAa,EAAW,EAAE,CACzC,CAAC,CAAC,QAAQ,KAAK,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;IAEtF,MAAM,MAAM,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC/C,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACnC,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAC3D,MAAM,GAAG,GAAG;QACV,wCAAwC;QACxC,0CAA0C,MAAM,CAAC,WAAW,CAAC,MAAM,eAAe,QAAQ,WAAW,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;KAC/I,CAAC;IACF,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,EAAE,CAAC;QACzC,GAAG,CAAC,IAAI,CACN,sBAAsB,GAAG,CAAC,IAAI,CAAC,YAAY,WAAW,CAAC,MAAM,eAAe,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,IAAI,CACnH,CAAC;QACF,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YACpF,MAAM,OAAO,GAAG;gBACd,GAAG,QAAQ,IAAI,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,MAAM,EAAE;gBACvC,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS;gBAClD,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;gBAC/D,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS;gBACpD,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,OAAO;aACV;iBACE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;iBAC9B,IAAI,CAAC,IAAI,CAAC,CAAC;YACd,GAAG,CAAC,IAAI,CACN,4BAA4B,GAAG,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CACrF,CAAC;YACF,GAAG,CAAC,IAAI,CACN,OAAO,CAAC,CAAC,CAAC;gBACR,CAAC,CAAC,wBAAwB,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,OAAO,CAAC,YAAY;gBAChG,CAAC,CAAC,qBAAqB,GAAG,CAAC,OAAO,CAAC,eAAe,CACrD,CAAC;YACF,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9B,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7B,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAC9B,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC"}

package/dist/report/pretty.d.ts

@@ -0,0 +1,9 @@
+import type { CheckResult } from '../check.js';
+/**
+ * Human-readable report, grouped by file. A problem that appears at the same
+ * place on several pages (usually the theme) is listed once, with its pages.
+ */
+export declare function formatPretty(result: CheckResult, options?: {
+    color?: boolean;
+}): string;
+//# sourceMappingURL=pretty.d.ts.map

package/dist/report/pretty.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pretty.d.ts","sourceRoot":"","sources":["../../src/report/pretty.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAY/C;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,MAAM,CAmF3F"}