accented 0.0.0-20250424114613 → 0.0.0-20250701143712

package/src/validate-options.ts

@@ -1,47 +1,67 @@
-import type { Selector, SelectorList, ContextProp, ContextObject, AccentedOptions, Context } from './types';
 import { allowedAxeOptions } from './types.js';
+import type {
+  AccentedOptions,
+  Context,
+  ContextObject,
+  ContextProp,
+  Selector,
+  SelectorList,
+} from './types.ts';
 import { isNode, isNodeList } from './utils/dom-helpers.js';
 
 function isSelector(contextFragment: Context): contextFragment is Selector {
-  return typeof contextFragment === 'string'
-    || isNode(contextFragment)
-    || 'fromShadowDom' in contextFragment;
+  return (
+    typeof contextFragment === 'string' ||
+    isNode(contextFragment) ||
+    'fromShadowDom' in contextFragment
+  );
 }
 
 function validateSelector(selector: Selector) {
   if (typeof selector === 'string') {
     return;
-  } else if (isNode(selector)) {
+  }
+  if (isNode(selector)) {
     return;
-  } else if ('fromShadowDom' in selector) {
-    if (!Array.isArray(selector.fromShadowDom)
-      || selector.fromShadowDom.length < 2 ||
-      !selector.fromShadowDom.every(item => typeof item === 'string')
+  }
+  if ('fromShadowDom' in selector) {
+    if (
+      !Array.isArray(selector.fromShadowDom) ||
+      selector.fromShadowDom.length < 2 ||
+      !selector.fromShadowDom.every((item) => typeof item === 'string')
     ) {
-      throw new TypeError(`Accented: invalid argument. \`fromShadowDom\` must be an array of strings with at least 2 elements. It’s currently set to ${selector.fromShadowDom}.`);
+      throw new TypeError(
+        `Accented: invalid argument. \`fromShadowDom\` must be an array of strings with at least 2 elements. It’s currently set to ${selector.fromShadowDom}.`,
+      );
     }
     return;
-  } else {
-    const neverSelector: never = selector;
-    throw new TypeError(`Accented: invalid argument. The selector must be one of: string, Node, or an object with a \`fromShadowDom\` property. It’s currently set to ${neverSelector}.`);
   }
+  const neverSelector: never = selector;
+  throw new TypeError(
+    `Accented: invalid argument. The selector must be one of: string, Node, or an object with a \`fromShadowDom\` property. It’s currently set to ${neverSelector}.`,
+  );
 }
 
 function isSelectorList(contextFragment: Context): contextFragment is SelectorList {
-  return (typeof contextFragment === 'object' && isNodeList(contextFragment))
-    || (Array.isArray(contextFragment) && contextFragment.every(item => isSelector(item)));
+  return (
+    (typeof contextFragment === 'object' && isNodeList(contextFragment)) ||
+    (Array.isArray(contextFragment) && contextFragment.every((item) => isSelector(item)))
+  );
 }
 
 function validateSelectorList(selectorList: SelectorList) {
   if (isNodeList(selectorList)) {
     return;
-  } else if (Array.isArray(selectorList)) {
+  }
+  if (Array.isArray(selectorList)) {
     for (const selector of selectorList) {
       validateSelector(selector);
     }
   } else {
     const neverSelectorList: never = selectorList;
-    throw new TypeError(`Accented: invalid argument. The selector list must either be a NodeList or an array. It’s currently set to ${neverSelectorList}.`);
+    throw new TypeError(
+      `Accented: invalid argument. The selector list must either be a NodeList or an array. It’s currently set to ${neverSelectorList}.`,
+    );
   }
 }
 
@@ -56,21 +76,26 @@ function validateContextProp(context: Selector | SelectorList) {
     validateSelectorList(context);
   } else {
     const neverContext: never = context;
-    throw new TypeError(`Accented: invalid argument. The context property must either be a selector or a selector list. It’s currently set to ${neverContext}.`);
+    throw new TypeError(
+      `Accented: invalid argument. The context property must either be a selector or a selector list. It’s currently set to ${neverContext}.`,
+    );
   }
 }
 
 function isContextObject(contextFragment: Context): contextFragment is ContextObject {
-  return typeof contextFragment === 'object' && contextFragment !== null
-    && ('include' in contextFragment || 'exclude' in contextFragment);
+  return (
+    typeof contextFragment === 'object' &&
+    contextFragment !== null &&
+    ('include' in contextFragment || 'exclude' in contextFragment)
+  );
 }
 
 function validateContextObject(contextObject: ContextObject) {
-  if ('include' in contextObject) {
-    validateContextProp(contextObject.include!);
+  if ('include' in contextObject && contextObject.include !== undefined) {
+    validateContextProp(contextObject.include);
   }
-  if ('exclude' in contextObject) {
-    validateContextProp(contextObject.exclude!);
+  if ('exclude' in contextObject && contextObject.exclude !== undefined) {
+    validateContextProp(contextObject.exclude);
   }
 }
 
@@ -81,7 +106,9 @@ function validateContext(context: Context) {
     validateContextObject(context);
   } else {
     const neverContext: never = context;
-    throw new TypeError(`Accented: invalid context argument. It’s currently set to ${neverContext}.`);
+    throw new TypeError(
+      `Accented: invalid context argument. It’s currently set to ${neverContext}.`,
+    );
   }
 }
 
@@ -90,39 +117,65 @@ function validateContext(context: Context) {
 // lowercase alphanumeric names that possibly contain dashes that start with a letter.
 const nameRegex = /^[a-z]([a-z0-9]|-)+$/;
 
-export default function validateOptions(options: AccentedOptions) {
+export function validateOptions(options: AccentedOptions) {
   if (typeof options !== 'object' || options === null) {
-    throw new TypeError(`Accented: invalid argument. The options parameter must be an object if provided. It’s currently set to ${options}.`);
+    throw new TypeError(
+      `Accented: invalid argument. The options parameter must be an object if provided. It’s currently set to ${options}.`,
+    );
   }
   if (options.throttle !== undefined) {
     if (typeof options.throttle !== 'object' || options.throttle === null) {
-      throw new TypeError(`Accented: invalid argument. \`throttle\` option must be an object if provided. It’s currently set to ${options.throttle}.`);
+      throw new TypeError(
+        `Accented: invalid argument. \`throttle\` option must be an object if provided. It’s currently set to ${options.throttle}.`,
+      );
     }
-    if (options.throttle.wait !== undefined && (typeof options.throttle.wait !== 'number' || options.throttle.wait < 0)) {
-      throw new TypeError(`Accented: invalid argument. \`throttle.wait\` option must be a non-negative number if provided. It’s currently set to ${options.throttle.wait}.`);
+    if (
+      options.throttle.wait !== undefined &&
+      (typeof options.throttle.wait !== 'number' || options.throttle.wait < 0)
+    ) {
+      throw new TypeError(
+        `Accented: invalid argument. \`throttle.wait\` option must be a non-negative number if provided. It’s currently set to ${options.throttle.wait}.`,
+      );
     }
   }
   if (options.output !== undefined) {
     if (typeof options.output !== 'object' || options.output === null) {
-      throw new TypeError(`Accented: invalid argument. \`output\` option must be an object if provided. It’s currently set to ${options.output}.`);
+      throw new TypeError(
+        `Accented: invalid argument. \`output\` option must be an object if provided. It’s currently set to ${options.output}.`,
+      );
     }
     if (options.output.console !== undefined && typeof options.output.console !== 'boolean') {
-      console.warn(`Accented: invalid argument. \`output.console\` option is expected to be a boolean. It’s currently set to ${options.output.console}.`);
+      console.warn(
+        `Accented: invalid argument. \`output.console\` option is expected to be a boolean. It’s currently set to ${options.output.console}.`,
+      );
     }
   }
   if (options.callback !== undefined && typeof options.callback !== 'function') {
-    throw new TypeError(`Accented: invalid argument. \`callback\` option must be a function if provided. It’s currently set to ${options.callback}.`);
+    throw new TypeError(
+      `Accented: invalid argument. \`callback\` option must be a function if provided. It’s currently set to ${options.callback}.`,
+    );
   }
-  if (options.name !== undefined && (typeof options.name !== 'string' || !options.name.match(nameRegex))) {
-    throw new TypeError(`Accented: invalid argument. \`name\` option must be a string that starts with a lowercase letter and only contains lowercase alphanumeric characters and dashes. It’s currently set to ${options.name}.`);
+  if (
+    options.name !== undefined &&
+    (typeof options.name !== 'string' || !options.name.match(nameRegex))
+  ) {
+    throw new TypeError(
+      `Accented: invalid argument. \`name\` option must be a string that starts with a lowercase letter and only contains lowercase alphanumeric characters and dashes. It’s currently set to ${options.name}.`,
+    );
   }
   if (options.axeOptions !== undefined) {
     if (typeof options.axeOptions !== 'object' || options.axeOptions === null) {
-      throw new TypeError(`Accented: invalid argument. \`axeOptions\` option must be an object if provided. It’s currently set to ${options.axeOptions}.`);
+      throw new TypeError(
+        `Accented: invalid argument. \`axeOptions\` option must be an object if provided. It’s currently set to ${options.axeOptions}.`,
+      );
     }
-    const unsupportedKeys = Object.keys(options.axeOptions).filter(key => !(allowedAxeOptions as unknown as Array<string>).includes(key));
+    const unsupportedKeys = Object.keys(options.axeOptions).filter(
+      (key) => !(allowedAxeOptions as unknown as Array<string>).includes(key),
+    );
     if (unsupportedKeys.length > 0) {
-      throw new TypeError(`Accented: invalid argument. \`axeOptions\` contains the following unsupported keys: ${unsupportedKeys.join(', ')}. Valid options are: ${allowedAxeOptions.join(', ')}.`);
+      throw new TypeError(
+        `Accented: invalid argument. \`axeOptions\` contains the following unsupported keys: ${unsupportedKeys.join(', ')}. Valid options are: ${allowedAxeOptions.join(', ')}.`,
+      );
     }
   }
   if (options.context !== undefined) {