requireDictionaryWords: Use prefixed dictionary names

Author: jacksonrayhamilton

README.md

@@ -33,7 +33,7 @@ To use, add these lines to your `.jscsrc` configuration file:
 {
     "plugins": [ "jscs-spellcheck" ],
     "requireDictionaryWords": {
-        "dictionaries": [ "english", "american" ]
+        "dictionaries": [ "english", "english/american" ]
     }
 }
 ```
@@ -54,7 +54,7 @@ Values:
  - `true`: use the `"english"` dictionary
  - `Object`:
    - `dictionaries`: (default `["english"]`) array of dictionary names including
-     `"english"`, `"american"`, `"british"` and `"canadian"`
+     `"english"`, `"english/american"`, `"english/british"` and `"english/canadian"`
    - `allowWords`: additional words allowed anywhere
    - `allowWordsInIdentifiers`: additional words allowed only in identifiers
    - `allowWordsInProperties`: additional words allowed only in properties
@@ -69,7 +69,7 @@ Values:
 "requireDictionaryWords": true
 
 "requireDictionaryWords": {
-    "dictionaries": [ "english", "american" ],
+    "dictionaries": [ "english", "english/american" ],
     "allowWords": [ "transclude" ],
     "allowWordsInProperties": [ "chmod" ],
     "allowNamesAsIdentifiers": [ "$stateParams", "util" ],
@@ -96,13 +96,13 @@ obj.src = 3;
 fileDir = 4;
 ```
 
-##### Valid for mode `"dictionaries": [ "american" ]`, invalid for `"british"`
+##### Valid for mode `"dictionaries": [ "english/american" ]`, invalid for `"english/british"`
 
 ```js
 var color = 'papayawhip';
 ```
 
-##### Valid for mode `"dictionaries": [ "british" ]`, invalid for `"american"`
+##### Valid for mode `"dictionaries": [ "english/british" ]`, invalid for `"english/american"`
 
 ```js
 var colour = 'papayawhip';

lib/rules/require-dictionary-words.js

@@ -11,7 +11,7 @@
  *  - `true`: use the `"english"` dictionary
  *  - `Object`:
  *    - `dictionaries`: (default `["english"]`) array of dictionary names including
- *      `"english"`, `"american"`, `"british"` and `"canadian"`
+ *      `"english"`, `"english/american"`, `"english/british"` and `"english/canadian"`
  *    - `allowWords`: additional words allowed anywhere
  *    - `allowWordsInIdentifiers`: additional words allowed only in identifiers
  *    - `allowWordsInProperties`: additional words allowed only in properties
@@ -26,7 +26,7 @@
  * "requireDictionaryWords": true
  *
  * "requireDictionaryWords": {
- *     "dictionaries": [ "english", "american" ],
+ *     "dictionaries": [ "english", "english/american" ],
  *     "allowWords": [ "transclude" ],
  *     "allowWordsInProperties": [ "chmod" ],
  *     "allowNamesAsIdentifiers": [ "$stateParams", "util" ],
@@ -53,13 +53,13 @@
  * fileDir = 4;
  * ```
  *
- * ##### Valid for mode `"dictionaries": [ "american" ]`, invalid for `"british"`
+ * ##### Valid for mode `"dictionaries": [ "english/american" ]`, invalid for `"english/british"`
  *
  * ```js
  * var color = 'papayawhip';
  * ```
  *
- * ##### Valid for mode `"dictionaries": [ "british" ]`, invalid for `"american"`
+ * ##### Valid for mode `"dictionaries": [ "english/british" ]`, invalid for `"english/american"`
  *
  * ```js
  * var colour = 'papayawhip';
@@ -149,13 +149,6 @@ var assert = require('assert');
 var assign = require('lodash.assign');
 var indexOf = require('lodash.indexof');
 
-var wordlistMap = {
-    english: 'wordlist-english',
-    american: 'wordlist-english',
-    british: 'wordlist-english',
-    canadian: 'wordlist-english',
-};
-
 // Breaks names like "fooBar" into ["foo", "bar"], etc.
 var reWords = (function() {
     var upper = '[A-Z\\xc0-\\xd6\\xd8-\\xde]';
@@ -267,12 +260,12 @@ module.exports.prototype = {
         }
 
         this._wordDictionaries = wordDictionaries.map(function(language) {
-            var packageName = wordlistMap.hasOwnProperty(language) ?
-                    // Special case where one package holds many wordlists.
-                    wordlistMap[language] :
-                    // General case where a package is one-to-one with a
-                    // wordlist.
-                    'wordlist-' + language;
+            // Languages such as "wordlist-english" contain both "english" and
+            // "english/american" languages.
+            var firstPartMatch = language.match(/(.*?)\//);
+            var packageName = firstPartMatch === null ?
+                    'wordlist-' + language :
+                    'wordlist-' + firstPartMatch[1];
             var wordlist;
             try {
                 wordlist = require(packageName);

package.json

@@ -42,7 +42,7 @@
   "dependencies": {
     "lodash.assign": "~3.0.0",
     "lodash.indexof": "~3.0.0",
-    "wordlist-english": "^1.0.0"
+    "wordlist-english": "^1.1.0"
   },
   "devDependencies": {
     "coveralls": "~2.11.2",

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

@@ -235,7 +235,7 @@ describe('rules/require-dictionary-words', function() {
             beforeEach(function() {
                 checker.configure({
                     requireDictionaryWords: {
-                        dictionaries: ['english', 'american']
+                        dictionaries: ['english', 'english/american']
                     }
                 });
             });