[Docs] Use consistent spelling of 'screen reader'

lb- · ljharb · commit cb6788c56d71 · 2024-10-18T16:13:23.000+10:00
See PR #725
diff --git a/README.md b/README.md
diff --git a/__tests__/src/rules/anchor-ambiguous-text-test.js b/__tests__/src/rules/anchor-ambiguous-text-test.js
@@ -27,7 +27,7 @@ const DEFAULT_AMBIGUOUS_WORDS = [
 ];
 
 const expectedErrorGenerator = (words) => ({
-  message: `Ambiguous text within anchor. Screenreader users rely on link text for context; the words "${words.join('", "')}" are ambiguous and do not provide enough context.`,
+  message: `Ambiguous text within anchor. Screen reader users rely on link text for context; the words "${words.join('", "')}" are ambiguous and do not provide enough context.`,
   type: 'JSXOpeningElement',
 });
 
diff --git a/__tests__/src/rules/no-access-key-test.js b/__tests__/src/rules/no-access-key-test.js
@@ -19,7 +19,7 @@ import rule from '../../../src/rules/no-access-key';
 const ruleTester = new RuleTester();
 
 const expectedError = {
-  message: 'No access key attribute allowed. Inconsistencies between keyboard shortcuts and keyboard commands used by screenreaders and keyboard-only users create a11y complications.',
+  message: 'No access key attribute allowed. Inconsistencies between keyboard shortcuts and keyboard commands used by screen readers and keyboard-only users create a11y complications.',
   type: 'JSXOpeningElement',
 };
 
diff --git a/docs/rules/accessible-emoji.md b/docs/rules/accessible-emoji.md
@@ -4,7 +4,7 @@
 
 <!-- end auto-generated rule header -->
 
-Emoji have become a common way of communicating content to the end user. To a person using a screenreader, however, they may not be aware that this content is there at all. By wrapping the emoji in a `<span>`, giving it the `role="img"`, and providing a useful description in `aria-label`, the screenreader will treat the emoji as an image in the accessibility tree with an accessible name for the end user.
+Emoji have become a common way of communicating content to the end user. To a person using a screen reader, however, they may not be aware that this content is there at all. By wrapping the emoji in a `<span>`, giving it the `role="img"`, and providing a useful description in `aria-label`, the screen reader will treat the emoji as an image in the accessibility tree with an accessible name for the end user.
 
 ## Rule details
 
diff --git a/docs/rules/anchor-ambiguous-text.md b/docs/rules/anchor-ambiguous-text.md
@@ -4,7 +4,7 @@
 
 <!-- end auto-generated rule header -->
 
-Enforces `<a>` values are not exact matches for the phrases "click here", "here", "link", "a link", or "learn more". Screenreaders announce tags as links/interactive, but rely on values for context. Ambiguous anchor descriptions do not provide sufficient context for users.
+Enforces `<a>` values are not exact matches for the phrases "click here", "here", "link", "a link", or "learn more". Screen readers announce tags as links/interactive, but rely on values for context. Ambiguous anchor descriptions do not provide sufficient context for users.
 
 ## Rule options
 
diff --git a/docs/rules/click-events-have-key-events.md b/docs/rules/click-events-have-key-events.md
@@ -4,7 +4,7 @@
 
 <!-- end auto-generated rule header -->
 
-Enforce `onClick` is accompanied by at least one of the following: `onKeyUp`, `onKeyDown`, `onKeyPress`. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and screenreader users. This does not apply for interactive or hidden elements.
+Enforce `onClick` is accompanied by at least one of the following: `onKeyUp`, `onKeyDown`, `onKeyPress`. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and screen reader users. This does not apply for interactive or hidden elements.
 
 ## Rule details
 
diff --git a/docs/rules/img-redundant-alt.md b/docs/rules/img-redundant-alt.md
@@ -4,7 +4,7 @@
 
 <!-- end auto-generated rule header -->
 
-Enforce img alt attribute does not contain the word image, picture, or photo. Screenreaders already announce `img` elements as an image. There is no need to use words such as *image*, *photo*, and/or *picture*.
+Enforce img alt attribute does not contain the word image, picture, or photo. Screen readers already announce `img` elements as an image. There is no need to use words such as *image*, *photo*, and/or *picture*.
 
 ## Rule options
 
diff --git a/docs/rules/mouse-events-have-key-events.md b/docs/rules/mouse-events-have-key-events.md
@@ -4,7 +4,7 @@
 
 <!-- end auto-generated rule header -->
 
-Enforce onmouseover/onmouseout are accompanied by onfocus/onblur. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and screenreader users.
+Enforce onmouseover/onmouseout are accompanied by onfocus/onblur. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and screen reader users.
 
 ## Rule options
 
diff --git a/docs/rules/no-access-key.md b/docs/rules/no-access-key.md
@@ -4,7 +4,7 @@
 
 <!-- end auto-generated rule header -->
 
-Enforce no accessKey prop on element. Access keys are HTML attributes that allow web developers to assign keyboard shortcuts to elements. Inconsistencies between keyboard shortcuts and keyboard commands used by screenreaders and keyboard-only users create accessibility complications so to avoid complications, access keys should not be used.
+Enforce no accessKey prop on element. Access keys are HTML attributes that allow web developers to assign keyboard shortcuts to elements. Inconsistencies between keyboard shortcuts and keyboard commands used by screen readers and keyboard-only users create accessibility complications so to avoid complications, access keys should not be used.
 
 ### References
 1. [WebAIM](https://webaim.org/techniques/keyboard/accesskey#spec)
diff --git a/docs/rules/no-noninteractive-element-interactions.md b/docs/rules/no-noninteractive-element-interactions.md
@@ -122,7 +122,7 @@ Adjust the list of handler prop names in the handlers array to increase or decre
 <div onClick={() => void 0} role="presentation" />
 <input type="text" onClick={() => void 0} /> // Interactive element does not require role.
 <button onClick={() => void 0} className="foo" /> // button is interactive.
-<div onClick={() => void 0} role="button" aria-hidden /> // This is hidden from screenreader.
+<div onClick={() => void 0} role="button" aria-hidden /> // This is hidden from screen reader.
 <Input onClick={() => void 0} type="hidden" /> // This is a higher-level DOM component
 ```
 
diff --git a/src/rules/accessible-emoji.js b/src/rules/accessible-emoji.js
@@ -1,5 +1,5 @@
 /**
- * @fileoverview Enforce emojis are wrapped in <span> and provide screenreader access.
+ * @fileoverview Enforce emojis are wrapped in <span> and provide screen reader access.
  * @author Ethan Cohen
  */
 
@@ -21,7 +21,7 @@ const schema = generateObjSchema();
 export default {
   meta: {
     docs: {
-      description: 'Enforce emojis are wrapped in `<span>` and provide screenreader access.',
+      description: 'Enforce emojis are wrapped in `<span>` and provide screen reader access.',
       url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/accessible-emoji.md',
     },
     deprecated: true,
diff --git a/src/rules/anchor-ambiguous-text.js b/src/rules/anchor-ambiguous-text.js
@@ -60,7 +60,7 @@ export default ({
 
         context.report({
           node,
-          message: 'Ambiguous text within anchor. Screenreader users rely on link text for context; the words "{{wordsList}}" are ambiguous and do not provide enough context.',
+          message: 'Ambiguous text within anchor. Screen reader users rely on link text for context; the words "{{wordsList}}" are ambiguous and do not provide enough context.',
           data: {
             wordsList: words.join('", "'),
           },
diff --git a/src/rules/no-access-key.js b/src/rules/no-access-key.js
@@ -10,15 +10,15 @@
 import { getProp, getPropValue } from 'jsx-ast-utils';
 import { generateObjSchema } from '../util/schemas';
 
-const errorMessage = 'No access key attribute allowed. Inconsistencies between keyboard shortcuts and keyboard commands used by screenreaders and keyboard-only users create a11y complications.';
+const errorMessage = 'No access key attribute allowed. Inconsistencies between keyboard shortcuts and keyboard commands used by screen readers and keyboard-only users create a11y complications.';
 
 const schema = generateObjSchema();
 
 export default {
   meta: {
     docs: {
       url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-access-key.md',
-      description: 'Enforce that the `accessKey` prop is not used on any element to avoid complications with keyboard commands used by a screenreader.',
+      description: 'Enforce that the `accessKey` prop is not used on any element to avoid complications with keyboard commands used by a screen reader.',
     },
     schema: [schema],
   },
