Update eslint, jscs style guidelines

Author: wooorm

.eslintrc

@@ -1,9 +1,5 @@
 {
   "extends": "eslint:recommended",
-  "env": {
-    "node": true,
-    "browser": true
-  },
   "rules": {
     "quotes": [2, "single"]
   }

.jscs.json

@@ -8,8 +8,19 @@
     "retext-equality.js",
     "retext-equality.min.js"
   ],
+  "preset": "yandex",
+  "requireQuotedKeysInObjects": true,
+  "disallowQuotedKeysInObjects": false,
+  "maximumLineLength": {
+    "value": 79,
+    "allExcept": [
+      "regex",
+      "urlComments"
+    ]
+  },
   "jsDoc": {
     "checkAnnotations": "jsdoc3",
+    "checkParamExistence": true,
     "checkParamNames": true,
     "checkRedundantAccess": true,
     "checkRedundantParams": true,
@@ -19,126 +30,9 @@
     "enforceExistence": true,
     "requireHyphenBeforeDescription": true,
     "requireNewlineAfterDescription": true,
-    "requireParamTypes": true,
     "requireParamDescription": true,
+    "requireParamTypes": true,
+    "requireReturnDescription": true,
     "requireReturnTypes": true
-  },
-  "requireCurlyBraces": [
-    "if",
-    "else",
-    "for",
-    "while",
-    "do",
-    "try",
-    "catch"
-  ],
-  "requireSpaceAfterKeywords": [
-    "if",
-    "else",
-    "for",
-    "while",
-    "do",
-    "switch",
-    "return",
-    "try",
-    "catch"
-  ],
-  "requireSpaceBeforeBlockStatements": true,
-  "requireParenthesesAroundIIFE": true,
-  "requireSpacesInConditionalExpression": true,
-  "requireSpacesInFunctionExpression": {
-    "beforeOpeningCurlyBrace": true
-  },
-  "requireSpacesInAnonymousFunctionExpression": {
-    "beforeOpeningRoundBrace": true,
-    "beforeOpeningCurlyBrace": true
-  },
-  "requireSpacesInNamedFunctionExpression": {
-    "beforeOpeningRoundBrace": true,
-    "beforeOpeningCurlyBrace": true
-  },
-  "requireBlocksOnNewline": true,
-  "disallowEmptyBlocks": true,
-  "disallowSpacesInsideObjectBrackets": true,
-  "disallowSpacesInsideArrayBrackets": true,
-  "disallowSpacesInsideParentheses": true,
-  "requireSpacesInsideObjectBrackets": "all",
-  "disallowDanglingUnderscores": true,
-  "disallowSpaceAfterObjectKeys": true,
-  "requireCommaBeforeLineBreak": true,
-  "requireOperatorBeforeLineBreak": [
-    "?",
-    "+",
-    "-",
-    "/",
-    "*",
-    "=",
-    "==",
-    "===",
-    "!=",
-    "!==",
-    ">",
-    ">=",
-    "<",
-    "<="
-  ],
-  "requireSpaceBeforeBinaryOperators": [
-    "+",
-    "-",
-    "/",
-    "*",
-    "=",
-    "==",
-    "===",
-    "!=",
-    "!=="
-  ],
-  "requireSpaceAfterBinaryOperators": [
-    "+",
-    "-",
-    "/",
-    "*",
-    "=",
-    "==",
-    "===",
-    "!=",
-    "!=="
-  ],
-  "disallowSpaceAfterPrefixUnaryOperators": [
-    "++",
-    "--",
-    "+",
-    "-",
-    "~",
-    "!"
-  ],
-  "disallowSpaceBeforePostfixUnaryOperators": [
-    "++",
-    "--"
-  ],
-  "disallowImplicitTypeConversion": [
-    "numeric",
-    "boolean",
-    "binary",
-    "string"
-  ],
-  "requireCamelCaseOrUpperCaseIdentifiers": true,
-  "disallowKeywords": [
-    "with"
-  ],
-  "disallowMultipleLineStrings": true,
-  "disallowMultipleLineBreaks": true,
-  "validateLineBreaks": "LF",
-  "validateQuoteMarks": "'",
-  "disallowMixedSpacesAndTabs": true,
-  "disallowTrailingWhitespace": true,
-  "disallowTrailingComma": true,
-  "disallowKeywordsOnNewLine": [
-    "else"
-  ],
-  "requireLineFeedAtFileEnd": true,
-  "requireCapitalizedConstructors": true,
-  "safeContextKeyword": "self",
-  "requireDotNotation": true,
-  "disallowYodaConditions": true
+  }
 }

index.js

@@ -1,3 +1,14 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module retext:equality
+ * @fileoverview Warn about possible insensitive,
+ *   inconsiderate language with Retext.
+ */
+
 'use strict';
 
+/* eslint-env commonjs */
+
 module.exports = require('./lib/equality.js');

lib/equality.js

@@ -9,6 +9,8 @@
 
 'use strict';
 
+/* eslint-env commonjs */
+
 /*
  * Dependencies.
  */
@@ -80,7 +82,7 @@ function byValue(object, value) {
  * Get a string value from a node.
  *
  * @param {NLCSTNode} node - NLCST node.
- * @return {string}
+ * @return {string} - Normalized and stringified `node`.
  */
 function toString(node) {
     return nlcstToString(node).replace(/['’-]/g, '');
@@ -90,7 +92,7 @@ function toString(node) {
  * Get the value of multiple nodes
  *
  * @param {Array.<NLCSTNode>} node - NLCST nodes.
- * @return {string}
+ * @return {string} - Value of `node`.
  */
 function valueOf(node) {
     return nlcstToString({
@@ -526,7 +528,7 @@ function factory(file) {
                 return;
             }
 
-            value = toString(child).toLowerCase()
+            value = toString(child).toLowerCase();
             patterns = byWord.hasOwnProperty(value) ? byWord[value] : null;
             length = patterns ? patterns.length : 0;
             index = -1;
@@ -560,6 +562,7 @@ function factory(file) {
  * Transformer.
  *
  * @param {NLCSTNode} cst - Syntax tree.
+ * @param {VFile} file - Virtual file.
  */
 function transformer(cst, file) {
     visit(cst, 'ParagraphNode', factory(file));

script/extract.js

@@ -8,6 +8,8 @@
 
 'use strict';
 
+/* eslint-env node */
+
 /*
  * Dependencies.
  */
@@ -77,7 +79,10 @@ var data = [
 
     var dups = duplicated(allData);
     if (dups.length !== 0) {
-        throw new Error('"' + name + '.yml" has duplicated value(s): \n' + dups.join('\n'));
+        throw new Error(
+            '"' + name + '.yml" has duplicated value(s): \n' +
+            dups.join('\n')
+        );
     }
 
     return yamlData;
@@ -120,7 +125,7 @@ data.forEach(function (entry) {
     }).filter(function (value, index, parent) {
         return parent.indexOf(value, index + 1) === -1;
     });
-})
+});
 
 /*
  * Patch.
@@ -146,14 +151,14 @@ data.forEach(function (entry) {
                     Object.keys(entry.inconsiderate).join(', ')
                 );
             }
-        })
+        });
     }
 });
 
 /*
  * Write.
  */
 
-data = stringify(data, 0, 2) + '\n'
+data = stringify(data, 0, 2) + '\n';
 
 write(join(__dirname, '..', 'lib', 'patterns.json'), data);

test.js

@@ -1,6 +1,7 @@
 'use strict';
 
-/* eslint-env mocha */
+/* eslint-env node */
+/* jscs:disable maximumLineLength */
 
 /*
  * Dependencies.
@@ -16,6 +17,9 @@ var equality = require('./');
 
 /**
  * Helper to get warnings from `equality` in `doc`.
+ *
+ * @param {string} doc - Document to process.
+ * @return {Array.<VFileMessage>} - Virtual messages.
  */
 function process(doc) {
     var messages;