Fix hasAria() docs and add hasNoAria() and lacksAria() aliases (#…

…1481)
mainmatter · Mar 10, 2022 · bcb67e0 · bcb67e0
1 parent 8d45db3
commit bcb67e0
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/lib/__tests__/has-aria.ts b/lib/__tests__/has-aria.ts
@@ -15,6 +15,8 @@ describe('assert.dom(...).hasAria()', () => {
   test('smoke test', () => {
     assert.dom('button').hasAria('pressed', 'true');
     assert.dom('button').doesNotHaveAria('hidden');
+    assert.dom('button').hasNoAria('hidden');
+    assert.dom('button').lacksAria('hidden');
 
     expect(assert.results).toEqual([
       {
@@ -29,6 +31,18 @@ describe('assert.dom(...).hasAria()', () => {
         message: 'Element button does not have attribute "aria-hidden"',
         result: true,
       },
+      {
+        actual: 'Element button does not have attribute "aria-hidden"',
+        expected: 'Element button does not have attribute "aria-hidden"',
+        message: 'Element button does not have attribute "aria-hidden"',
+        result: true,
+      },
+      {
+        actual: 'Element button does not have attribute "aria-hidden"',
+        expected: 'Element button does not have attribute "aria-hidden"',
+        message: 'Element button does not have attribute "aria-hidden"',
+        result: true,
+      },
     ]);
   });
 });
diff --git a/lib/assertions.ts b/lib/assertions.ts
@@ -445,7 +445,7 @@ export default class DOMAssertions {
    * @param {string?} message
    *
    * @example
-   * assert.dom('input.username').hasNoAttribute('disabled');
+   * assert.dom('input.username').doesNotHaveAttribute('disabled');
    *
    * @see {@link #hasAttribute}
    */
@@ -492,7 +492,7 @@ export default class DOMAssertions {
    * @example
    * assert.dom('button').hasAria('pressed', 'true');
    *
-   * @see {@link #hasNoAria}
+   * @see {@link #doesNotHaveAria}
    */
   hasAria(name: string, value?: string | RegExp | { any: true }, message?: string): DOMAssertions {
     return this.hasAttribute(`aria-${name}`, value, message);
@@ -502,6 +502,8 @@ export default class DOMAssertions {
    * Assert that the {@link HTMLElement} has no ARIA attribute with the
    * provided `name`.
    *
+   * **Aliases:** `hasNoAria`, `lacksAria`
+   *
    * @param {string} name
    * @param {string?} message
    *
@@ -514,6 +516,14 @@ export default class DOMAssertions {
     return this.doesNotHaveAttribute(`aria-${name}`, message);
   }
 
+  hasNoAria(name: string, message?: string): DOMAssertions {
+    return this.doesNotHaveAria(name, message);
+  }
+
+  lacksAria(name: string, message?: string): DOMAssertions {
+    return this.doesNotHaveAria(name, message);
+  }
+
   /**
    * Assert that the {@link HTMLElement} has a property with the provided `name`
    * and checks if the property `value` matches the provided text or regular