@accesslint/storybook-addon 0.8.10 → 0.8.12

package/README.md

@@ -1,5 +1,5 @@
 [![npm version](https://img.shields.io/npm/v/@accesslint/storybook-addon)](https://www.npmjs.com/package/@accesslint/storybook-addon)
-[![license](https://img.shields.io/github/license/AccessLint/storybook-addon)](https://github.com/AccessLint/storybook-addon/blob/main/LICENSE)
+[![license](https://img.shields.io/github/license/AccessLint/accesslint)](https://github.com/AccessLint/accesslint/blob/main/storybook-addon/LICENSE)
 
 # @accesslint/storybook-addon
 
@@ -7,13 +7,14 @@ Catch accessibility violations in your Storybook stories as you develop. Powered
 
 <img height="414" alt="Storybook screenshot with alt text violation in the details of the AccessLint tab" src="https://github.com/user-attachments/assets/42bb12ee-3a07-4443-8b60-35c2c9c735a9" />
 
-
 ## Getting Started
 
 ```sh
 npm install @accesslint/storybook-addon
 ```
 
+`storybook` 9+ and `vitest` 3+ are required as peer dependencies.
+
 Add the addon to your `.storybook/main.ts` (or `.storybook/main.js`):
 
 ```ts
@@ -104,7 +105,7 @@ test("LoginForm is accessible", () => {
 
 ```ts
 await expect(canvasElement).toBeAccessible({
-  disabledRules: ["accesslint-045"],
+  disabledRules: ["landmarks/region"],
 });
 ```
 
@@ -115,10 +116,10 @@ When the assertion fails, the error message lists each violation with its rule I
 ```
 Expected element to have no accessibility violations, but found 2:
 
-  accesslint-001 [A] (1.1.1): Image is missing alt text
+  text-alternatives/img-alt [A] (1.1.1): Image is missing alt text
     img[src="hero.png"]
 
-  accesslint-012 [A] (1.3.1): Form input is missing a label
+  labels-and-names/form-label [A] (1.3.1): Form input is missing a label
     input[type="email"]
 ```
 
@@ -159,11 +160,11 @@ const preview = {
 export default preview;
 ```
 
-| Mode | Behavior |
-| --- | --- |
-| `"error"` | Violations fail the test (default) |
-| `"todo"` | Violations show as warnings — yellow sidebar dots, non-blocking in CI |
-| `"off"` | Skip auditing entirely |
+| Mode      | Behavior                                                              |
+| --------- | --------------------------------------------------------------------- |
+| `"error"` | Violations fail the test (default)                                    |
+| `"todo"`  | Violations show as warnings — yellow sidebar dots, non-blocking in CI |
+| `"off"`   | Skip auditing entirely                                                |
 
 Override per-story:
 
@@ -177,14 +178,14 @@ export const Experimental = {
 
 ### Disabling rules
 
-Disable specific rules globally in your preview file:
+Extend the addon's audit options from your preview file:
 
 ```ts
 // .storybook/preview.ts
-import { configureRules } from "@accesslint/core";
+import { setAuditOptions } from "@accesslint/storybook-addon/preview";
 
-configureRules({
-  disabledRules: ["accesslint-045"], // e.g. disable landmark region rule
+setAuditOptions({
+  disabledRules: ["landmarks/region"], // e.g. disable landmark region rule
 });
 ```
 
@@ -225,10 +226,7 @@ import { setProjectAnnotations } from "@storybook/react";
 import { enableAccessLint } from "@accesslint/storybook-addon/portable";
 import * as previewAnnotations from "./.storybook/preview";
 
-const project = setProjectAnnotations([
-  previewAnnotations,
-  enableAccessLint(),
-]);
+const project = setProjectAnnotations([previewAnnotations, enableAccessLint()]);
 
 beforeAll(project.beforeAll);
 ```
@@ -251,36 +249,36 @@ test("Primary button is accessible", async () => {
 
 ### Exports
 
-| Entry point | Description |
-| --- | --- |
-| `@accesslint/storybook-addon` | Main addon registration (manager + preview) |
+| Entry point                                 | Description                                           |
+| ------------------------------------------- | ----------------------------------------------------- |
+| `@accesslint/storybook-addon`               | Main addon registration (manager + preview)           |
 | `@accesslint/storybook-addon/vitest-plugin` | `accesslintTest()` Vite plugin for Vitest integration |
-| `@accesslint/storybook-addon/vitest-setup` | Setup file registered by the Vite plugin |
-| `@accesslint/storybook-addon/matchers` | `toBeAccessible()` custom matcher |
-| `@accesslint/storybook-addon/portable` | `enableAccessLint()` for portable stories |
-| `@accesslint/storybook-addon/preview` | Preview annotations (afterEach hook) |
+| `@accesslint/storybook-addon/vitest-setup`  | Setup file registered by the Vite plugin              |
+| `@accesslint/storybook-addon/matchers`      | `toBeAccessible()` custom matcher                     |
+| `@accesslint/storybook-addon/portable`      | `enableAccessLint()` for portable stories             |
+| `@accesslint/storybook-addon/preview`       | Preview annotations (afterEach hook)                  |
 
 ### `accesslintTest(options?)`
 
 Vite plugin that registers AccessLint's `afterEach` annotation and the `toBeAccessible()` matcher for Vitest story tests.
 
-| Option | Type | Description |
-| --- | --- | --- |
+| Option      | Type       | Description                                        |
+| ----------- | ---------- | -------------------------------------------------- |
 | `tags.skip` | `string[]` | Stories with any of these tags will not be audited |
 
 ### `parameters.accesslint`
 
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| `test` | `"todo" \| "error" \| "off"` | `"error"` | Controls how violations are reported |
-| `disable` | `boolean` | `false` | Set to `true` to skip auditing (same as `test: "off"`) |
+| Parameter | Type                         | Default   | Description                                            |
+| --------- | ---------------------------- | --------- | ------------------------------------------------------ |
+| `test`    | `"todo" \| "error" \| "off"` | `"error"` | Controls how violations are reported                   |
+| `disable` | `boolean`                    | `false`   | Set to `true` to skip auditing (same as `test: "off"`) |
 
 ### `toBeAccessible(options?)`
 
 Custom matcher for asserting an element has no accessibility violations.
 
-| Option | Type | Description |
-| --- | --- | --- |
+| Option          | Type       | Description                         |
+| --------------- | ---------- | ----------------------------------- |
 | `disabledRules` | `string[]` | Rule IDs to skip for this assertion |
 
 ### `enableAccessLint()`
@@ -296,7 +294,7 @@ Returns AccessLint's preview annotations for use with `setProjectAnnotations` in
 
 ## Issues
 
-Please report issues in the [AccessLint core repository](https://github.com/AccessLint/core/issues).
+Please report issues in the [AccessLint monorepo](https://github.com/AccessLint/accesslint/issues).
 
 ## License
 

package/dist/chunk-pbuEa-1d.js

@@ -0,0 +1,13 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+export { __exportAll as t };

package/dist/index.cjs

@@ -1,116 +1,6 @@
-'use strict';
-
-var csf = require('storybook/internal/csf');
-var core = require('@accesslint/core');
-var previewApi = require('storybook/preview-api');
-
-var __defProp = Object.defineProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-
-// src/preview.ts
-var preview_exports = {};
-__export(preview_exports, {
-  afterEach: () => afterEach,
-  initialGlobals: () => initialGlobals,
-  parameters: () => parameters
-});
-
-// src/constants.ts
-var ADDON_ID = "accesslint/a11y";
-var RESULT_EVENT = `${ADDON_ID}/result`;
-
-// src/preview.ts
-var initialGlobals = {
-  accesslint: {}
-};
-var parameters = {
-  accesslint: {}
-};
-core.configureRules({
-  disabledRules: ["accesslint-045"]
-});
-var BUDGET_MS = 12;
-function yieldToMain() {
-  return new Promise((resolve) => setTimeout(resolve, 0));
-}
-function scopeViolations(violations) {
-  const root = document.getElementById("storybook-root");
-  if (!root) return violations;
-  return violations.filter((v) => {
-    const local = v.selector.replace(/^.*>>>\s*iframe>\s*/, "");
-    try {
-      const el = document.querySelector(local);
-      return el && root.contains(el);
-    } catch {
-      return false;
-    }
-  });
-}
-function enrichViolations(violations) {
-  return violations.map((v) => {
-    const rule = core.getRuleById(v.ruleId);
-    return {
-      ...v,
-      element: void 0,
-      // not serializable
-      description: rule?.description,
-      wcag: rule?.wcag,
-      level: rule?.level,
-      guidance: rule?.guidance
-    };
-  });
-}
-var afterEach = async ({
-  reporting,
-  parameters: parameters2,
-  viewMode,
-  tags,
-  id
-}) => {
-  const accesslintParam = parameters2?.accesslint;
-  if (accesslintParam?.disable === true || accesslintParam?.test === "off") return;
-  if (viewMode !== "story") return;
-  const skipTags = typeof __ACCESSLINT_SKIP_TAGS__ !== "undefined" ? __ACCESSLINT_SKIP_TAGS__ : [];
-  const allSkipTags = ["skip-accesslint", ...skipTags];
-  const matchedTag = tags?.find((t) => allSkipTags.includes(t));
-  if (matchedTag) {
-    const result2 = { skipped: true, reason: matchedTag };
-    previewApi.addons.getChannel().emit(RESULT_EVENT, { storyId: id, result: result2 });
-    reporting.addReport({
-      type: "accesslint",
-      version: 1,
-      result: result2,
-      status: "passed"
-    });
-    return;
-  }
-  const audit = core.createChunkedAudit(document);
-  while (audit.processChunk(BUDGET_MS)) {
-    await yieldToMain();
-  }
-  const violations = audit.getViolations();
-  const scoped = scopeViolations(violations);
-  const enriched = enrichViolations(scoped);
-  const hasViolations = enriched.length > 0;
-  const mode = accesslintParam?.test === "todo" ? "warning" : "failed";
-  const status = hasViolations ? mode : "passed";
-  const result = {
-    violations: enriched,
-    ruleCount: core.getActiveRules().length
-  };
-  previewApi.addons.getChannel().emit(RESULT_EVENT, { storyId: id, result, status });
-  reporting.addReport({
-    type: "accesslint",
-    version: 1,
-    result,
-    status
-  });
-};
-
-// src/index.ts
-var index_default = () => csf.definePreviewAddon(preview_exports);
-
-module.exports = index_default;
+const require_preview = require("./preview-B8cvp9pY.cjs");
+let storybook_internal_csf = require("storybook/internal/csf");
+//#region src/index.ts
+var src_default = () => (0, storybook_internal_csf.definePreviewAddon)(require_preview.preview_exports);
+//#endregion
+module.exports = src_default;

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import * as storybook_internal_csf from 'storybook/internal/csf';
+import * as _$storybook_internal_csf0 from "storybook/internal/csf";
 
-declare const _default: () => storybook_internal_csf.PreviewAddon<storybook_internal_csf.AddonTypes>;
-
-export { _default as default };
+//#region src/index.d.ts
+declare const _default: () => _$storybook_internal_csf0.PreviewAddon<_$storybook_internal_csf0.AddonTypes>;
+export = _default;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import * as storybook_internal_csf from 'storybook/internal/csf';
+import * as _$storybook_internal_csf0 from "storybook/internal/csf";
 
-declare const _default: () => storybook_internal_csf.PreviewAddon<storybook_internal_csf.AddonTypes>;
-
-export { _default as default };
+//#region src/index.d.ts
+declare const _default: () => _$storybook_internal_csf0.PreviewAddon<_$storybook_internal_csf0.AddonTypes>;
+//#endregion
+export { _default as default };

package/dist/index.js

@@ -1,6 +1,6 @@
-import { preview_exports } from './chunk-XTEGJNR3.js';
-import { definePreviewAddon } from 'storybook/internal/csf';
-
-var index_default = () => definePreviewAddon(preview_exports);
-
-export { index_default as default };
+import { i as preview_exports } from "./preview-B3suakeJ.js";
+import { definePreviewAddon } from "storybook/internal/csf";
+//#region src/index.ts
+var src_default = () => definePreviewAddon(preview_exports);
+//#endregion
+export { src_default as default };

package/dist/manager.d.ts

@@ -0,0 +1 @@
+export { };