[new] - Add support for custom words in img-redundant-alt (#75)

Author: badtant

docs/rules/img-redundant-alt.md

@@ -3,8 +3,20 @@
 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*.
 
 ## Rule details
+This rule takes one optional argument of type string or array of strings. These strings can be used to specify custom words that should be checked for in the alt prop. Useful for specifying words in other languages.
 
-This rule takes no arguments. This rule will first check if `aria-hidden` is true to determine whether to enforce the rule. If the image is hidden, then rule will always succeed.
+The rule will first check if `aria-hidden` is true to determine whether to enforce the rule. If the image is hidden, then rule will always succeed.
+
+To tell this plugin to also check for custom words , specify this in your `.eslintrc` file:
+
+```json
+{
+    "rules": {
+        "jsx-a11y/img-redundant-alt": [ 2, "Bild" ], // OR
+        "jsx-a11y/img-redundant-alt": [ 2, [ "Bild", "Foto" ] ]
+    }
+}
+```
 
 ### Succeed
 ```jsx

src/rules/img-redundant-alt.js

@@ -18,19 +18,38 @@ const REDUNDANT_WORDS = [
 
 const errorMessage = 'Redundant alt attribute. Screen-readers already announce ' +
   '`img` tags as an image. You don\'t need to use the words `image`, ' +
-  '`photo,` or `picture` in the alt prop.';
+  '`photo,` or `picture` (or any specified custom words) in the alt prop.';
 
 module.exports = {
   meta: {
     docs: {},
 
     schema: [
-      { type: 'object' },
+      {
+        oneOf: [
+          { type: 'string' },
+          {
+            type: 'array',
+            items: {
+              type: 'string',
+            },
+            minItems: 1,
+            uniqueItems: true,
+          },
+        ],
+      },
     ],
   },
 
   create: context => ({
     JSXOpeningElement: node => {
+      let REDUNDANT_WORDS_EXTENDED;
+
+      if (context.options[0]) {
+        REDUNDANT_WORDS_EXTENDED = REDUNDANT_WORDS.concat(context.options[0]);
+      } else {
+        REDUNDANT_WORDS_EXTENDED = REDUNDANT_WORDS;
+      }
       const type = elementType(node);
       if (type !== 'img') {
         return;
@@ -46,7 +65,7 @@ module.exports = {
       const isVisible = isHiddenFromScreenReader(type, node.attributes) === false;
 
       if (typeof value === 'string' && isVisible) {
-        const hasRedundancy = REDUNDANT_WORDS
+        const hasRedundancy = REDUNDANT_WORDS_EXTENDED
           .some(word => Boolean(value.match(new RegExp(`(?!{)${word}(?!})`, 'gi'))));
 
         if (hasRedundancy === true) {

tests/src/rules/img-redundant-alt.js

@@ -21,11 +21,15 @@ const parserOptions = {
 // Tests
 // -----------------------------------------------------------------------------
 
+const string = ['Word'];
+const array = [['Word1', 'Word2']];
+
 const ruleTester = new RuleTester();
 
 const expectedError = {
   message: 'Redundant alt attribute. Screen-readers already announce `img` tags as an image. ' +
-    'You don\'t need to use the words `image`, `photo,` or `picture` in the alt prop.',
+    'You don\'t need to use the words `image`, `photo,` or `picture` ' +
+    '(or any specified custom words) in the alt prop.',
   type: 'JSXOpeningElement',
 };
 
@@ -113,5 +117,12 @@ ruleTester.run('img-redundant-alt', rule, {
       errors: [expectedError],
       parserOptions,
     },
+
+    // TESTS FOR STRING OPTION
+    { code: '<img alt="Word" />;', options: string, errors: [expectedError], parserOptions },
+
+    // TESTS FOR ARRAY OPTION TESTS
+    { code: '<img alt="Word1" />;', options: array, errors: [expectedError], parserOptions },
+    { code: '<img alt="Word2" />;', options: array, errors: [expectedError], parserOptions },
   ],
 });