requireDictionaryWords: Rename options

Author: jacksonrayhamilton

lib/rules/require-dictionary-words.js

@@ -12,11 +12,11 @@
  *  - `Object`:
  *    - `dictionaries`: (default `["english"]`) array of dictionary names including
  *      `"english"`, `"american"`, `"british"` and `"canadian"`
- *    - `allowWordsInIdentifiersAndProperties`: additional words allowed anywhere
+ *    - `allowWords`: additional words allowed anywhere
  *    - `allowWordsInProperties`: additional words allowed only as properties
- *    - `allowNamesForIdentifiersAndProperties`: names ignored by spellcheck
- *    - `allowNamesForProperties`: names ignored by spellcheck when used as properties
- *    - `excluded`: words to exclude from the dictionaries
+ *    - `allowNames`: names ignored by spellcheck
+ *    - `allowNamesAsProperties`: names ignored by spellcheck when used as properties
+ *    - `excludeWords`: words to exclude from the dictionaries
  *
  * #### Example
  *
@@ -25,11 +25,11 @@
  *
  * "requireDictionaryWords": {
  *     "dictionaries": [ "english", "american" ],
- *     "allowWordsInIdentifiersAndProperties": [ "transclude" ],
+ *     "allowWords": [ "transclude" ],
  *     "allowWordsInProperties": [ "chmod" ],
- *     "allowNamesForIdentifiersAndProperties": [ "$stateParams", "util" ],
- *     "allowNamesForProperties": [ "src" ],
- *     "excluded": [ "i" ]
+ *     "allowNames": [ "$stateParams", "util" ],
+ *     "allowNamesAsProperties": [ "src" ],
+ *     "excludeWords": [ "i" ]
  * }
  * ```
  *
@@ -63,7 +63,7 @@
  * var colour = 'papayawhip';
  * ```
  *
- * ##### Valid for mode `"allowWordsInIdentifiersAndProperties": [ "transclude" ]`
+ * ##### Valid for mode `"allowWords": [ "transclude" ]`
  *
  * ```js
  * var transclude = function() {};
@@ -85,33 +85,33 @@
  * var chmod = 0777;
  * ```
  *
- * ##### Valid for mode `"allowNamesForIdentifiersAndProperties": [ "$stateParams", "util" ]`
+ * ##### Valid for mode `"allowNames": [ "$stateParams", "util" ]`
  *
  * ```js
  * var util = require('util');
  * function Controller($stateParams) {}
  * ```
  *
- * ##### Invalid for mode `"allowNamesForIdentifiersAndProperties": [ "$stateParams", "util" ]`
+ * ##### Invalid for mode `"allowNames": [ "$stateParams", "util" ]`
  *
  * ```js
  * var stringUtil = {};
  * var params = {};
  * ```
  *
- * ##### Valid for mode `"allowNamesForProperties": [ "src" ]`
+ * ##### Valid for mode `"allowNamesAsProperties": [ "src" ]`
  *
  * ```js
  * element.src = 'https://youtu.be/dQw4w9WgXcQ';
  * ```
  *
- * ##### Invalid for mode `"allowNamesForProperties": [ "src" ]`
+ * ##### Invalid for mode `"allowNamesAsProperties": [ "src" ]`
  *
  * ```js
  * var data = { videoSrc: 'youtube' };
  * ```
  *
- * ##### Invalid for mode `"excluded": [ "i" ]`
+ * ##### Invalid for mode `"excludeWords": [ "i" ]`
  *
  * ```js
  * for (var i = 0; i < array.length; i++) {}
@@ -205,11 +205,11 @@ module.exports.prototype = {
         );
 
         var wordDictionaries = ['english'];
-        var identifierAndPropertyWords;
-        var propertyWords;
-        var identifierAndPropertyNames;
-        var propertyNames;
-        var excluded;
+        var allowedWords;
+        var allowedPropertyWords;
+        var allowedNames;
+        var allowedPropertyNames;
+        var excludedWords;
 
         function arrayOption(option) {
             var value = options[option];
@@ -225,11 +225,11 @@ module.exports.prototype = {
 
         if (wasObject) {
             wordDictionaries = arrayOption('dictionaries') || wordDictionaries;
-            identifierAndPropertyWords = arrayOption('allowWordsInIdentifiersAndProperties');
-            propertyWords = arrayOption('allowWordsInProperties');
-            identifierAndPropertyNames = arrayOption('allowNamesForIdentifiersAndProperties');
-            propertyNames = arrayOption('allowNamesForProperties');
-            excluded = arrayOption('excluded');
+            allowedWords = arrayOption('allowWords');
+            allowedPropertyWords = arrayOption('allowWordsInProperties');
+            allowedNames = arrayOption('allowNames');
+            allowedPropertyNames = arrayOption('allowNamesAsProperties');
+            excludedWords = arrayOption('excludeWords');
         }
 
         this._wordDictionaries = wordDictionaries.map(function(language) {
@@ -251,26 +251,26 @@ module.exports.prototype = {
             }
             return wordlist[language];
         });
-        if (identifierAndPropertyWords) {
-            this._wordDictionaries.push(identifierAndPropertyWords);
+        if (allowedWords) {
+            this._wordDictionaries.push(allowedWords);
         }
 
         this._propertyWordDictionaries = this._wordDictionaries.slice();
-        if (propertyWords) {
-            this._propertyWordDictionaries.push(propertyWords);
+        if (allowedPropertyWords) {
+            this._propertyWordDictionaries.push(allowedPropertyWords);
         }
 
         this._nameDictionaries = [];
-        if (identifierAndPropertyNames) {
-            this._nameDictionaries.push(identifierAndPropertyNames);
+        if (allowedNames) {
+            this._nameDictionaries.push(allowedNames);
         }
 
         this._propertyNameDictionaries = this._nameDictionaries.slice();
-        if (propertyNames) {
-            this._propertyNameDictionaries.push(propertyNames);
+        if (allowedPropertyNames) {
+            this._propertyNameDictionaries.push(allowedPropertyNames);
         }
 
-        this._excluded = excluded;
+        this._excludedWords = excludedWords;
     },
 
     getOptionName: function() {
@@ -284,7 +284,7 @@ module.exports.prototype = {
             if (!dictionariesHaveWord(nameDictionaries, name)) {
                 checkWords(
                     wordDictionaries,
-                    _this._excluded,
+                    _this._excludedWords,
                     errors,
                     name,
                     start

test/specs/rules/require-dictionary-words.js

@@ -83,11 +83,11 @@ describe('rules/require-dictionary-words', function() {
         });
     });
 
-    describe('allowWordsInIdentifiersAndProperties', function() {
+    describe('allowWords', function() {
         beforeEach(function() {
             checker.configure({
                 requireDictionaryWords: {
-                    allowWordsInIdentifiersAndProperties: ['asdf', 'jkl']
+                    allowWords: ['asdf', 'jkl']
                 }
             });
         });
@@ -100,11 +100,11 @@ describe('rules/require-dictionary-words', function() {
         });
     });
 
-    describe('allowNamesForIdentifiersAndProperties', function() {
+    describe('allowNames', function() {
         beforeEach(function() {
             checker.configure({
                 requireDictionaryWords: {
-                    allowNamesForIdentifiersAndProperties: ['asdf', 'jkl']
+                    allowNames: ['asdf', 'jkl']
                 }
             });
         });
@@ -140,11 +140,11 @@ describe('rules/require-dictionary-words', function() {
         });
     });
 
-    describe('allowNamesForProperties', function() {
+    describe('allowNamesAsProperties', function() {
         beforeEach(function() {
             checker.configure({
                 requireDictionaryWords: {
-                    allowNamesForProperties: ['asdf', 'jkl']
+                    allowNamesAsProperties: ['asdf', 'jkl']
                 }
             });
         });
@@ -163,11 +163,11 @@ describe('rules/require-dictionary-words', function() {
         });
     });
 
-    describe('excluded', function() {
+    describe('excludeWords', function() {
         beforeEach(function() {
             checker.configure({
                 requireDictionaryWords: {
-                    excluded: ['good']
+                    excludeWords: ['good']
                 }
             });
         });