Quality

Static quality and accessibility inspection for generated HTML in Riebeckite.

日本語

Overview

qualityPlugin() runs a small set of dependency-free, regex-based rules over the HTML produced by the build and reports the findings through the shared diagnostics channel. There is no DOM, no axe-core, and no headless browser.

At the manifest stage the plugin inspects each public entry's rendered article HTML. Integrations that finish HTML generation can additionally call the exported inspectGeneratedHtml hook for final pages.

Usage

import { defineConfig } from "@riebeckite/core";
import { qualityPlugin } from "@riebeckite/plugin-quality";
 
export default defineConfig({
  // ...
  plugins: [qualityPlugin({ failOn: "error" })],
});

Options

Rules

API

• qualityPlugin(options?) — plugin factory.
• inspectHtml(html, options?) — pure function returning Diagnostic[].
• inspectGeneratedHtml(page, options?) — pure function that inspects a final page and sets filePath to page.path.
• RULE_CODES — the stable code identifiers.
• Types: QualityOptions, InspectOptions.

Limitations

The scanner is regex-based, not a real DOM. It does not validate malformed markup, does not track nesting depth, and only handles well-formed, non-nested elements when pairing an open tag with its close tag. Comments and <script>/<style> contents are masked before scanning. Rules that depend on document structure (heading order, table headers) can therefore miss or misattribute findings in unusual markup.

See also

• Plugin guide