accented 0.0.0-20250424114613 → 0.0.0-20250618181418

package/src/task-queue.test.ts

@@ -1,11 +1,12 @@
 import assert from 'node:assert/strict';
-import {mock, suite, test} from 'node:test';
+import { mock, suite, test } from 'node:test';
 
-import TaskQueue from './task-queue.js';
+import { TaskQueue } from './task-queue';
 
-const wait = (duration: number) => new Promise(resolve => setTimeout(resolve, duration));
+const wait = (duration: number) => new Promise((resolve) => setTimeout(resolve, duration));
 
-const createAsyncCallback = (duration: number) => mock.fn(() => new Promise(resolve => setTimeout(resolve, duration)));
+const createAsyncCallback = (duration: number) =>
+  mock.fn(() => new Promise((resolve) => setTimeout(resolve, duration)));
 
 suite('TaskQueue', () => {
   test('callback is not called after a TaskQueue is created, even after a timeout', async () => {

package/src/task-queue.ts

@@ -1,8 +1,8 @@
-import type { Throttle } from './types';
+import type { Throttle } from './types.ts';
 
 type TaskCallback<T> = (items: Array<T>) => void;
 
-export default class TaskQueue<T> {
+export class TaskQueue<T> {
   #throttle: Throttle;
   #asyncCallback: TaskCallback<T> | null = null;
 

package/src/types.ts

@@ -1,6 +1,6 @@
-import type axe from 'axe-core';
 import type { Signal } from '@preact/signals-core';
-import type { AccentedTrigger } from './elements/accented-trigger';
+import type axe from 'axe-core';
+import type { AccentedTrigger } from './elements/accented-trigger.ts';
 
 export type Throttle = {
   /**
@@ -8,7 +8,7 @@ export type Throttle = {
    *
    * Default: `1000`.
    * */
-  wait?: number,
+  wait?: number;
 
   /**
    * When to run the scan on Accented initialization or on a mutation.
@@ -17,8 +17,8 @@ export type Throttle = {
    *
    * Default: `true`.
    * */
-  leading?: boolean
-}
+  leading?: boolean;
+};
 
 export type Output = {
   /**
@@ -26,8 +26,8 @@ export type Output = {
    *
    * Default: `true`.
    * */
-  console?: boolean
-}
+  console?: boolean;
+};
 
 /**
  * Model context type based on axe.ElementContext,
@@ -43,27 +43,27 @@ export type SelectorList = Array<Selector> | NodeList;
 // The rest of the type is structured the same as in axe-core.
 export type ContextProp = Selector | SelectorList;
 
-export type ContextObject = {
-  include: ContextProp;
-  exclude?: ContextProp;
-} | {
-  exclude: ContextProp;
-  include?: ContextProp;
-};
+export type ContextObject =
+  | {
+      include: ContextProp;
+      exclude?: ContextProp;
+    }
+  | {
+      exclude: ContextProp;
+      include?: ContextProp;
+    };
 
 export type Context = ContextProp | ContextObject;
 
-
-
 export const allowedAxeOptions = ['rules', 'runOnly'] as const;
 
-export type AxeOptions = Pick<axe.RunOptions, typeof allowedAxeOptions[number]>;
+export type AxeOptions = Pick<axe.RunOptions, (typeof allowedAxeOptions)[number]>;
 
 type CallbackParams = {
   /**
    * The most current array of elements with issues.
    * */
-  elementsWithIssues: Array<ElementWithIssues>,
+  elementsWithIssues: Array<ElementWithIssues>;
 
   /**
    * * `performance`: runtime performance of the last scan. An object:
@@ -75,17 +75,16 @@ type CallbackParams = {
    *   or an object with `include` and `exclude` properties (if any nodes were excluded).
    * */
   performance: {
-    totalBlockingTime: number,
-    scan: number,
-    domUpdate: number,
-    scanContext: ScanContext | Array<Node>
-  }
-}
+    totalBlockingTime: number;
+    scan: number;
+    domUpdate: number;
+    scanContext: ScanContext | Array<Node>;
+  };
+};
 
 export type Callback = (params: CallbackParams) => void;
 
 export type AccentedOptions = {
-
   /**
    * The `context` parameter for `axe.run()`.
    *
@@ -102,7 +101,7 @@ export type AccentedOptions = {
    *
    * Default: `document`.
    */
-  context?: Context,
+  context?: Context;
 
   /**
    * The `options` parameter for `axe.run()`.
@@ -118,7 +117,7 @@ export type AccentedOptions = {
    *
    * Default: `{}`.
    */
-  axeOptions?: AxeOptions,
+  axeOptions?: AxeOptions;
 
   /**
    * The character sequence that’s used in various elements, attributes and stylesheets that Accented adds to the page.
@@ -135,24 +134,24 @@ export type AccentedOptions = {
    *
    * Default: `accented`.
    */
-  name?: string,
+  name?: string;
 
   /**
    * Output options object.
    * */
-  output?: Output,
+  output?: Output;
 
   /**
    * Scan throttling options object.
    * */
-  throttle?: Throttle,
+  throttle?: Throttle;
 
   /**
    * A callback that will be called after each scan.
    *
    * Default: `() => {}`.
    * */
-  callback?: Callback
+  callback?: Callback;
 };
 
 /**
@@ -162,41 +161,41 @@ export type AccentedOptions = {
 export type DisableAccented = () => void;
 
 export type Position = {
-  left: number,
-  top: number,
-  width: number,
-  height: number
+  left: number;
+  top: number;
+  width: number;
+  height: number;
 };
 
 export type Issue = {
-  id: string,
-  title: string,
-  description: string,
-  url: string,
-  impact: axe.ImpactValue
+  id: string;
+  title: string;
+  description: string;
+  url: string;
+  impact: axe.ImpactValue;
 };
 
 export type BaseElementWithIssues = {
-  element: HTMLElement | SVGElement,
-  rootNode: Node
+  element: HTMLElement | SVGElement;
+  rootNode: Node;
 };
 
 export type ElementWithIssues = BaseElementWithIssues & {
-  issues: Array<Issue>
+  issues: Array<Issue>;
 };
 
 export type ExtendedElementWithIssues = BaseElementWithIssues & {
-  issues: Signal<ElementWithIssues['issues']>,
-  visible: Signal<boolean>,
-  trigger: AccentedTrigger,
-  position: Signal<Position>,
-  skipRender: boolean,
-  anchorNameValue: string,
-  scrollableAncestors: Signal<Set<Element>>
-  id: number
+  issues: Signal<ElementWithIssues['issues']>;
+  visible: Signal<boolean>;
+  trigger: AccentedTrigger;
+  position: Signal<Position>;
+  skipRender: boolean;
+  anchorNameValue: string;
+  scrollableAncestors: Signal<Set<Element>>;
+  id: number;
 };
 
 export type ScanContext = {
-  include: Array<Node>,
-  exclude: Array<Node>
+  include: Array<Node>;
+  exclude: Array<Node>;
 };

package/src/utils/are-elements-with-issues-equal.ts

@@ -1,9 +1,11 @@
-import type { BaseElementWithIssues } from "../types";
+import type { BaseElementWithIssues } from '../types.ts';
 
-export default function areElementsWithIssuesEqual(
+export function areElementsWithIssuesEqual(
   elementWithIssues1: BaseElementWithIssues,
-  elementWithIssues2: BaseElementWithIssues
+  elementWithIssues2: BaseElementWithIssues,
 ) {
-  return elementWithIssues1.element === elementWithIssues2.element
-    && elementWithIssues1.rootNode === elementWithIssues2.rootNode;
+  return (
+    elementWithIssues1.element === elementWithIssues2.element &&
+    elementWithIssues1.rootNode === elementWithIssues2.rootNode
+  );
 }

package/src/utils/are-issue-sets-equal.test.ts

@@ -1,14 +1,14 @@
 import assert from 'node:assert/strict';
-import {suite, test} from 'node:test';
-import areIssueSetsEqual from './are-issue-sets-equal.js';
+import { suite, test } from 'node:test';
 import type { Issue } from '../types';
+import { areIssueSetsEqual } from './are-issue-sets-equal';
 
 const issue1: Issue = {
   id: 'id1',
   title: 'title1',
   description: 'description1',
   url: 'http://example.com',
-  impact: 'serious'
+  impact: 'serious',
 };
 
 const issue2: Issue = {
@@ -16,18 +16,22 @@ const issue2: Issue = {
   title: 'title2',
   description: 'description2',
   url: 'http://example.com',
-  impact: 'serious'
+  impact: 'serious',
 };
 
 // @ts-expect-error
-const issue2Clone: Issue = Object.keys(issue2).reduce((obj, key) => { obj[key] = issue2[key]; return obj; }, {});
+const issue2Clone: Issue = Object.keys(issue2).reduce((obj, key) => {
+  // @ts-expect-error
+  obj[key] = issue2[key];
+  return obj;
+}, {});
 
 const issue3: Issue = {
   id: 'id3',
   title: 'title3',
   description: 'description3',
   url: 'http://example.com',
-  impact: 'serious'
+  impact: 'serious',
 };
 
 suite('areIssueSetsEqual', () => {

package/src/utils/are-issue-sets-equal.ts

@@ -1,10 +1,12 @@
-import type { Issue } from '../types';
+import type { Issue } from '../types.ts';
 
 const issueProps: Array<keyof Issue> = ['id', 'title', 'description', 'url', 'impact'];
 
-export default function areIssueSetsEqual(issues1: Array<Issue>, issues2: Array<Issue>) {
-  return issues1.length === issues2.length &&
-    issues1.every(issue1 => Boolean(issues2.find(issue2 =>
-      issueProps.every(prop => issue2[prop] === issue1[prop])
-    )));
+export function areIssueSetsEqual(issues1: Array<Issue>, issues2: Array<Issue>) {
+  return (
+    issues1.length === issues2.length &&
+    issues1.every((issue1) =>
+      Boolean(issues2.find((issue2) => issueProps.every((prop) => issue2[prop] === issue1[prop]))),
+    )
+  );
 }

package/src/utils/containing-blocks.ts

@@ -7,7 +7,10 @@
  *
  * It's only meant to be used during initialization.
  */
-function testContainingBlockCreation<T extends keyof CSSStyleDeclaration>(prop: T, value: CSSStyleDeclaration[T]) {
+function testContainingBlockCreation<T extends keyof CSSStyleDeclaration>(
+  prop: T,
+  value: CSSStyleDeclaration[T],
+) {
   const container = document.createElement('div');
   container.style[prop] = value;
   container.style.position = 'fixed';
@@ -40,13 +43,13 @@ export function createsContainingBlock(prop: keyof CSSStyleDeclaration) {
 
 export function initializeContainingBlockSupportSet() {
   type StyleEntry<T extends keyof CSSStyleDeclaration> = {
-    [K in T]: { prop: K; value: CSSStyleDeclaration[K] }
+    [K in T]: { prop: K; value: CSSStyleDeclaration[K] };
   }[T];
 
   const propsToTest: Array<StyleEntry<'filter' | 'backdropFilter' | 'containerType'>> = [
     { prop: 'filter', value: 'blur(1px)' },
     { prop: 'backdropFilter', value: 'blur(1px)' },
-    { prop: 'containerType', value: 'size' }
+    { prop: 'containerType', value: 'size' },
   ];
 
   for (const { prop, value } of propsToTest) {

package/src/utils/contains.test.ts

@@ -1,7 +1,7 @@
-import { JSDOM } from 'jsdom';
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
-import contains from './contains';
+import { JSDOM } from 'jsdom';
+import { contains } from './contains';
 
 suite('contains', () => {
   test('an element contains itself', () => {

package/src/utils/contains.ts

@@ -1,6 +1,6 @@
 import { isDocumentFragment, isShadowRoot } from './dom-helpers.js';
 
-export default function contains(ancestor: Node, descendant: Node): boolean {
+export function contains(ancestor: Node, descendant: Node): boolean {
   if (ancestor.contains(descendant)) {
     return true;
   }

package/src/utils/deduplicate-nodes.ts

@@ -1,3 +1,3 @@
 export function deduplicateNodes(nodes: Array<Node>): Array<Node> {
-  return [...new Set(nodes)];;
+  return [...new Set(nodes)];
 }

package/src/utils/deep-merge.test.ts

@@ -1,7 +1,7 @@
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 
-import deepMerge from './deep-merge';
+import { deepMerge } from './deep-merge';
 
 suite('deepMerge', () => {
   test('merges two objects with overlapping keys', () => {
@@ -31,4 +31,11 @@ suite('deepMerge', () => {
     const result = deepMerge(target, source);
     assert.deepEqual(result, { a: [4, 5] });
   });
+
+  test('handles merging an object into a string in a logical way', () => {
+    const target = { a: 'hello' };
+    const source = { a: { b: 'bye' } };
+    const result = deepMerge(target, source);
+    assert.deepEqual(result, { a: { b: 'bye' } });
+  });
 });

package/src/utils/deep-merge.ts

@@ -1,16 +1,19 @@
+// biome-ignore lint/suspicious/noExplicitAny: I'm not sure how to type this properly
 type AnyObject = Record<string, any>;
 
-export default function deepMerge(target: AnyObject, source: AnyObject): AnyObject {
-  const output = {...target};
+const isObject = (obj: unknown): obj is AnyObject =>
+  typeof obj === 'object' && obj !== null && !Array.isArray(obj);
+
+export function deepMerge(target: AnyObject, source: AnyObject): AnyObject {
+  const output = { ...target };
   for (const key of Object.keys(source)) {
-    if (typeof source[key] === 'object' && source[key] !== null && !Array.isArray(source[key])) {
-      if (!(key in target)) {
-        output[key] = source[key];
-      } else {
+    if (isObject(source[key])) {
+      if (isObject(target[key])) {
         output[key] = deepMerge(target[key], source[key]);
+      } else {
+        output[key] = source[key];
       }
-    }
-    else {
+    } else {
       output[key] = source[key];
     }
   }

package/src/utils/dom-helpers.ts

@@ -1,6 +1,10 @@
 export function isNode(obj: object): obj is Node {
-  return 'nodeType' in obj && typeof obj.nodeType === 'number' &&
-    'nodeName' in obj && typeof obj.nodeName === 'string';
+  return (
+    'nodeType' in obj &&
+    typeof obj.nodeType === 'number' &&
+    'nodeName' in obj &&
+    typeof obj.nodeName === 'string'
+  );
 }
 
 export function isNodeList(obj: object): obj is NodeList {

package/src/utils/ensure-non-empty.ts

@@ -1,6 +1,6 @@
-export default function ensureNonEmpty<T>(arr: T[]): [T, ...T[]] {
+export function ensureNonEmpty<T>(arr: T[]): [T, ...T[]] {
   if (arr.length === 0) {
-    throw new Error("Array must not be empty");
+    throw new Error('Array must not be empty');
   }
   return arr as [T, ...T[]];
 }

package/src/utils/get-element-html.ts

@@ -1,4 +1,4 @@
-export default function getElementHtml(element: Element) {
+export function getElementHtml(element: Element) {
   const outerHtml = element.outerHTML;
   const innerHtml = element.innerHTML;
   if (!innerHtml) {
@@ -9,5 +9,7 @@ export default function getElementHtml(element: Element) {
     // This shouldn't be happening, but if it does, we can just return the outer HTML.
     return outerHtml;
   }
-  return outerHtml.slice(0, index) + '…' + outerHtml.slice(index + innerHtml.length);
+  const openingTag = outerHtml.slice(0, index);
+  const closingTag = outerHtml.slice(index + innerHtml.length);
+  return `${openingTag}…${closingTag}`;
 }

package/src/utils/get-element-position.ts

@@ -1,23 +1,36 @@
-import type { Position } from '../types';
-import { isHtmlElement } from './dom-helpers.js';
-import getParent from './get-parent.js';
+import type { Position } from '../types.ts';
 import { createsContainingBlock } from './containing-blocks.js';
+import { isHtmlElement } from './dom-helpers.js';
+import { getParent } from './get-parent.js';
 
 // https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_display/Containing_block#identifying_the_containing_block
 function isContainingBlock(element: Element, win: Window): boolean {
   const style = win.getComputedStyle(element);
-  const { transform, perspective, contain, contentVisibility, containerType, filter, backdropFilter, willChange } = style;
+  const {
+    transform,
+    perspective,
+    contain,
+    contentVisibility,
+    containerType,
+    filter,
+    backdropFilter,
+    willChange,
+  } = style;
   const containItems = contain.split(' ');
   const willChangeItems = willChange.split(/\s*,\s*/);
 
-  return transform !== 'none'
-    || perspective !== 'none'
-    || containItems.some((item) => ['layout', 'paint', 'strict', 'content'].includes(item))
-    || contentVisibility === 'auto'
-    || (createsContainingBlock('containerType') && containerType !== 'normal')
-    || (createsContainingBlock('filter') && filter !== 'none')
-    || (createsContainingBlock('backdropFilter') && backdropFilter !== 'none')
-    || willChangeItems.some((item) => ['transform', 'perspective', 'contain', 'filter', 'backdrop-filter'].includes(item));
+  return (
+    transform !== 'none' ||
+    perspective !== 'none' ||
+    containItems.some((item) => ['layout', 'paint', 'strict', 'content'].includes(item)) ||
+    contentVisibility === 'auto' ||
+    (createsContainingBlock('containerType') && containerType !== 'normal') ||
+    (createsContainingBlock('filter') && filter !== 'none') ||
+    (createsContainingBlock('backdropFilter') && backdropFilter !== 'none') ||
+    willChangeItems.some((item) =>
+      ['transform', 'perspective', 'contain', 'filter', 'backdrop-filter'].includes(item),
+    )
+  );
 }
 
 function getNonInitialContainingBlock(element: Element, win: Window): Element | null {
@@ -39,7 +52,7 @@ function getNonInitialContainingBlock(element: Element, win: Window): Element |
  * * The element itself, or one of the element's ancestors has a scale or rotate transform.
  * * The browser doesn't support anchor positioning.
  */
-export default function getElementPosition(element: Element, win: Window): Position {
+export function getElementPosition(element: Element, win: Window): Position {
   const nonInitialContainingBlock = getNonInitialContainingBlock(element, win);
   // If an element has a containing block as an ancestor,
   // and that containing block is not the <html> element (the initial containing block),
@@ -60,17 +73,17 @@ export default function getElementPosition(element: Element, win: Window): Posit
         currentElement = currentElement.offsetParent as HTMLElement | null;
       }
       return { top, left, width, height };
-    } else {
-      const elementRect = element.getBoundingClientRect();
-      const nonInitialContainingBlockRect = nonInitialContainingBlock.getBoundingClientRect();
-      return {
-        top: elementRect.top - nonInitialContainingBlockRect.top,
-        height: elementRect.height,
-        left: elementRect.left - nonInitialContainingBlockRect.left,
-        width: elementRect.width
-      };
     }
-  } else {
-    return element.getBoundingClientRect();
+
+    const elementRect = element.getBoundingClientRect();
+    const nonInitialContainingBlockRect = nonInitialContainingBlock.getBoundingClientRect();
+    return {
+      top: elementRect.top - nonInitialContainingBlockRect.top,
+      height: elementRect.height,
+      left: elementRect.left - nonInitialContainingBlockRect.left,
+      width: elementRect.width,
+    };
   }
+
+  return element.getBoundingClientRect();
 }

package/src/utils/get-parent.ts

@@ -1,6 +1,6 @@
 import { isDocumentFragment, isShadowRoot } from './dom-helpers.js';
 
-export default function getParent (element: Element): Element | null {
+export function getParent(element: Element): Element | null {
   if (element.parentElement) {
     return element.parentElement;
   }

package/src/utils/get-scan-context.test.ts

@@ -1,7 +1,7 @@
-import { JSDOM } from 'jsdom';
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
-import getScanContext from './get-scan-context';
+import { JSDOM } from 'jsdom';
+import { getScanContext } from './get-scan-context';
 
 suite('getScanContext', () => {
   test('when context doesn’t overlap with nodes, the result is empty', () => {
@@ -13,7 +13,7 @@ suite('getScanContext', () => {
 
     assert.deepEqual(scanContext, {
       include: [],
-      exclude: []
+      exclude: [],
     });
   });
 
@@ -27,7 +27,7 @@ suite('getScanContext', () => {
 
     assert.deepEqual(scanContext, {
       include: [contextNode],
-      exclude: []
+      exclude: [],
     });
   });
 
@@ -44,13 +44,16 @@ suite('getScanContext', () => {
     const { document } = dom.window;
     global.document = document;
     const mutatedNode = document.querySelector('#mutated-node')!;
-    const scanContext = getScanContext([mutatedNode], {include: ['.include'], exclude: ['.exclude']});
+    const scanContext = getScanContext([mutatedNode], {
+      include: ['.include'],
+      exclude: ['.exclude'],
+    });
     const innerExclude = document.querySelector('#inner-exclude')!;
     const innerInclude = document.querySelector('#inner-include')!;
 
     assert.deepEqual(scanContext, {
       include: [mutatedNode, innerInclude],
-      exclude: [innerExclude]
+      exclude: [innerExclude],
     });
   });
 
@@ -67,13 +70,16 @@ suite('getScanContext', () => {
     const { document } = dom.window;
     global.document = document;
     const mutatedNode = document.querySelector('#mutated-node')!;
-    const scanContext = getScanContext([mutatedNode], {include: ['.include'], exclude: ['.exclude']});
+    const scanContext = getScanContext([mutatedNode], {
+      include: ['.include'],
+      exclude: ['.exclude'],
+    });
     const innerExclude = document.querySelector('#inner-exclude')!;
     const innerInclude = document.querySelector('#inner-include')!;
 
     assert.deepEqual(scanContext, {
       include: [innerInclude],
-      exclude: [innerExclude]
+      exclude: [innerExclude],
     });
   });
 });