@testing-library/dom - npm Package Compare versions

Comparing version 6.13.0 to 6.14.0

dist/@testing-library/dom.cjs.js

@@ -10,2 +10,3 @@ 'use strict';
 var MutationObserver = _interopDefault(require('@sheerun/mutationobserver-shim'));
+var domAccessibilityApi = require('dom-accessibility-api');
 var ariaQuery = require('aria-query');
@@ -911,3 +912,5 @@ var waitForExpect = _interopDefault(require('wait-for-expect'));
     var elementsString = elements.map(function (el) {
-      return prettyDOM(el.cloneNode(false));
+      var nameString = "Name \"" + domAccessibilityApi.computeAccessibleName(el) + "\":\n";
+      var domString = prettyDOM(el.cloneNode(false));
+      return "" + nameString + domString;
     }).join('\n\n');
@@ -936,2 +939,3 @@ return role + ":\n\n" + elementsString + "\n\n" + delimiterBar;
       hidden = _ref$hidden === void 0 ? getConfig().defaultHidden : _ref$hidden,
+      name = _ref.name,
       trim = _ref.trim,
@@ -990,2 +994,11 @@ normalizer = _ref.normalizer,
     }) === false : true;
+  }).filter(function (element) {
+    if (name === undefined) {
+      // Don't care
+      return true;
+    }
+
+    return matches(domAccessibilityApi.computeAccessibleName(element), element, name, function (text) {
+      return text;
+    });
   });
@@ -1001,6 +1014,8 @@ }
       _ref2$hidden = _ref2.hidden,
-      hidden = _ref2$hidden === void 0 ? getConfig().defaultHidden : _ref2$hidden;
+      hidden = _ref2$hidden === void 0 ? getConfig().defaultHidden : _ref2$hidden,
+      name = _ref2.name;
 
   var roles = prettyRoles(container, {
-    hidden: hidden
+    hidden: hidden,
+    includeName: name !== undefined
   });
@@ -1019,3 +1034,13 @@ var roleMessage;
 
-  return ("\nUnable to find an " + (hidden === false ? 'accessible ' : '') + "element with the role \"" + role + "\"\n\n" + roleMessage).trim();
+  var nameHint = '';
+
+  if (name === undefined) {
+    nameHint = '';
+  } else if (typeof name === 'string') {
+    nameHint = " and name \"" + name + "\"";
+  } else {
+    nameHint = " and name `" + name + "`";
+  }
+
+  return ("\nUnable to find an " + (hidden === false ? 'accessible ' : '') + "element with the role \"" + role + "\"" + nameHint + "\n\n" + roleMessage).trim();
 };
@@ -1022,0 +1047,0 @@

dist/@testing-library/dom.esm.js

 import _extends from '@babel/runtime/helpers/esm/extends';
 import prettyFormat from 'pretty-format';
 import MutationObserver from '@sheerun/mutationobserver-shim';
+import { computeAccessibleName } from 'dom-accessibility-api';
 import { elementRoles } from 'aria-query';
@@ -904,3 +905,5 @@ import waitForExpect from 'wait-for-expect';
     var elementsString = elements.map(function (el) {
-      return prettyDOM(el.cloneNode(false));
+      var nameString = "Name \"" + computeAccessibleName(el) + "\":\n";
+      var domString = prettyDOM(el.cloneNode(false));
+      return "" + nameString + domString;
     }).join('\n\n');
@@ -929,2 +932,3 @@ return role + ":\n\n" + elementsString + "\n\n" + delimiterBar;
       hidden = _ref$hidden === void 0 ? getConfig().defaultHidden : _ref$hidden,
+      name = _ref.name,
       trim = _ref.trim,
@@ -983,2 +987,11 @@ normalizer = _ref.normalizer,
     }) === false : true;
+  }).filter(function (element) {
+    if (name === undefined) {
+      // Don't care
+      return true;
+    }
+
+    return matches(computeAccessibleName(element), element, name, function (text) {
+      return text;
+    });
   });
@@ -994,6 +1007,8 @@ }
       _ref2$hidden = _ref2.hidden,
-      hidden = _ref2$hidden === void 0 ? getConfig().defaultHidden : _ref2$hidden;
+      hidden = _ref2$hidden === void 0 ? getConfig().defaultHidden : _ref2$hidden,
+      name = _ref2.name;
 
   var roles = prettyRoles(container, {
-    hidden: hidden
+    hidden: hidden,
+    includeName: name !== undefined
   });
@@ -1012,3 +1027,13 @@ var roleMessage;
 
-  return ("\nUnable to find an " + (hidden === false ? 'accessible ' : '') + "element with the role \"" + role + "\"\n\n" + roleMessage).trim();
+  var nameHint = '';
+
+  if (name === undefined) {
+    nameHint = '';
+  } else if (typeof name === 'string') {
+    nameHint = " and name \"" + name + "\"";
+  } else {
+    nameHint = " and name `" + name + "`";
+  }
+
+  return ("\nUnable to find an " + (hidden === false ? 'accessible ' : '') + "element with the role \"" + role + "\"" + nameHint + "\n\n" + roleMessage).trim();
 };
@@ -1015,0 +1040,0 @@

dist/queries/role.js

@@ -9,2 +9,4 @@ "use strict";
 
+var _domAccessibilityApi = require("dom-accessibility-api");
+
 var _roleHelpers = require("../role-helpers");
@@ -18,2 +20,3 @@
   hidden = (0, _allUtils.getConfig)().defaultHidden,
+  name,
   trim,
@@ -65,2 +68,9 @@ normalizer,
     }) === false : true;
+  }).filter(element => {
+    if (name === undefined) {
+      // Don't care
+      return true;
+    }
+
+    return (0, _allUtils.matches)((0, _domAccessibilityApi.computeAccessibleName)(element), element, name, text => text);
   });
@@ -72,6 +82,8 @@ }
 const getMissingError = (container, role, {
-  hidden = (0, _allUtils.getConfig)().defaultHidden
+  hidden = (0, _allUtils.getConfig)().defaultHidden,
+  name
 } = {}) => {
   const roles = (0, _roleHelpers.prettyRoles)(container, {
-    hidden
+    hidden,
+    includeName: name !== undefined
   });
@@ -94,4 +106,14 @@ let roleMessage;
 
+  let nameHint = '';
+
+  if (name === undefined) {
+    nameHint = '';
+  } else if (typeof name === 'string') {
+    nameHint = ` and name "${name}"`;
+  } else {
+    nameHint = ` and name \`${name}\``;
+  }
+
   return `
-Unable to find an ${hidden === false ? 'accessible ' : ''}element with the role "${role}"
+Unable to find an ${hidden === false ? 'accessible ' : ''}element with the role "${role}"${nameHint}
 
@@ -98,0 +120,0 @@ ${roleMessage}`.trim();

dist/role-helpers.js

@@ -19,2 +19,4 @@ "use strict";
 
+var _domAccessibilityApi = require("dom-accessibility-api");
+
 var _prettyDom = require("./pretty-dom");
@@ -163,3 +165,7 @@
     const delimiterBar = '-'.repeat(50);
-    const elementsString = elements.map(el => (0, _prettyDom.prettyDOM)(el.cloneNode(false))).join('\n\n');
+    const elementsString = elements.map(el => {
+      const nameString = `Name "${(0, _domAccessibilityApi.computeAccessibleName)(el)}":\n`;
+      const domString = (0, _prettyDom.prettyDOM)(el.cloneNode(false));
+      return `${nameString}${domString}`;
+    }).join('\n\n');
     return `${role}:\n\n${elementsString}\n\n${delimiterBar}`;
@@ -166,0 +172,0 @@ }).join('\n');

package.json

 {
   "name": "@testing-library/dom",
-  "version": "6.13.0",
+  "version": "6.14.0",
   "description": "Simple and complete DOM testing utilities that encourage good testing practices.",
@@ -47,2 +47,3 @@ "main": "dist/index.js",
     "aria-query": "3.0.0",
+    "dom-accessibility-api": "^0.3.0",
     "pretty-format": "^24.9.0",
@@ -49,0 +50,0 @@ "wait-for-expect": "^3.0.0"

README.md

@@ -237,2 +237,3 @@ <div align="center">
     <td align="center"><a href="https://twitter.com/xgbuils"><img src="https://avatars2.githubusercontent.com/u/6483614?v=4" width="100px;" alt=""/><br /><sub><b>Xavier Garcia Buils</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=xgbuils" title="Code">💻</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=xgbuils" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/aw-davidson"><img src="https://avatars2.githubusercontent.com/u/32170938?v=4" width="100px;" alt=""/><br /><sub><b>aw-davidson</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=aw-davidson" title="Code">💻</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=aw-davidson" title="Tests">⚠️</a></td>
   </tr>
@@ -239,0 +240,0 @@ </table>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1761420

increased by4.71%

Lines of code

16062

increased by4.33%

Number of lines in readme file

295

increased by0.34%

Worsened metrics

Dependency count

7

increased by16.67%

Dependency changes

• + Addeddom-accessibility-api@^0.3.0

• + Addeddom-accessibility-api@0.3.0(transitive)