Refactor code-style

Refactor to simplify `.jscs.json`-file, adding the `"yandex"` preset (which produced the least-number of issues), changed some settings more to my liking, and fix newly risen warnings.
remarkjs · Dec 23, 2015 · 3dc2485 · 3dc2485
1 parent 7a5d16d
commit 3dc2485
Show file tree

Hide file tree

Showing 28 changed files with 251 additions and 311 deletions.
diff --git a/.jscs.json b/.jscs.json
@@ -8,8 +8,19 @@
     "mdast.js",
     "mdast.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,
+    "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,
-  "maximumLineLength": 78,
-  "requireCapitalizedConstructors": true,
-  "safeContextKeyword": "self",
-  "requireDotNotation": true,
-  "disallowYodaConditions": true
+  }
 }
diff --git a/lib/cli/cli.js b/lib/cli/cli.js
@@ -55,7 +55,7 @@ var COMMAND = Object.keys(pack.bin)[0];
  *
  *   parseJSON('foo: ["bar", "baz"]') // {'foo': ['bar', 'baz']}
  *
- * @param {string} value
+ * @param {string} value - Value to parse as JSON.
  * @return {Object} - Parsed `value`.
  * @throws {Error} - When the augmented options could not
  *   be parsed.
@@ -138,7 +138,9 @@ function options(flags, cache) {
  *   var plugin = parsePlugin('mdast-toc=heading:"foo"');
  *
  * @param {string} plugin - Plugin name with options.
- * @return {Object}
+ * @return {Object} - Map with a `name`, referring to
+ *   the parser name, and a `value`, which when available,
+ *   contains the plug-in options.
  */
 function parsePlugin(plugin) {
     var index = plugin.indexOf('=');

diff --git a/lib/cli/configuration.js b/lib/cli/configuration.js
@@ -64,7 +64,10 @@ extend(base.settings, defaults.stringify);
  *   merge(target, current);
  *
  * @param {Object} target - Configuration to merge into.
- * @param {Object} configuration - Configuration to merge from.
+ * @param {Object} configuration - Configuration to merge
+ *   from.
+ * @param {boolean} [recursive] - Used internally no ensure
+ *   the plug-in key is only escaped at root-level.
  * @return {Object} - `target`.
  */
 function merge(target, configuration, recursive) {
@@ -257,6 +260,8 @@ Configuration.prototype.base = base;
  *   new Configuration().getConfiguration('~/foo', console.log);
  *
  * @param {string} filePath - File location.
+ * @param {Function} callback - Callback invoked with
+ *   configuration.
  */
 Configuration.prototype.getConfiguration = function (filePath, callback) {
     var self = this;

diff --git a/lib/cli/file-pipeline/configure.js b/lib/cli/file-pipeline/configure.js
@@ -198,7 +198,7 @@ function configure(context, next) {
 
                 processor.use(plugin, option, context.fileSet);
             } catch (err) {
-                next(err)
+                next(err);
                 return false;
             }
         });

diff --git a/lib/cli/file-pipeline/copy.js b/lib/cli/file-pipeline/copy.js
@@ -56,7 +56,7 @@ var SEPERATOR = path.sep;
  *     'fileSet': fileSet
  *   });
  *
- * @param {Object} context
+ * @param {Object} context - Context object.
  */
 function copy(context) {
     var fileSet = context.fileSet;

diff --git a/lib/cli/file-pipeline/file-system.js b/lib/cli/file-pipeline/file-system.js
@@ -43,8 +43,8 @@ var writeFile = fs.writeFile;
  *     'file': file
  *   });
  *
- * @param {Object} context
- * @param {function(Error?)} done
+ * @param {Object} context - Context object.
+ * @param {function(Error?)} done - Completion handler.
  */
 function fileSystem(context, done) {
     var file = context.file;

diff --git a/lib/cli/file-pipeline/parse.js b/lib/cli/file-pipeline/parse.js
@@ -31,7 +31,7 @@ var debug = require('debug')('mdast:cli:file-pipeline:parse');
  *
  *   file.namespace('mdast').tree.type; // 'root'
  *
- * @param {Object} context
+ * @param {Object} context - Context object.
  */
 function parse(context) {
     var file = context.file;

diff --git a/lib/cli/file-pipeline/queue.js b/lib/cli/file-pipeline/queue.js
@@ -31,8 +31,8 @@ var debug = require('debug')('mdast:cli:file-pipeline:queue');
  *
  *   queue({'file': file, 'fileSet': fileSet}, console.log);
  *
- * @param {Object} context
- * @param {function(Error?)} done
+ * @param {Object} context - Context object.
+ * @param {function(Error?)} done - Completion handler.
  */
 function queue(context, done) {
     var fileSet = context.fileSet;

diff --git a/lib/cli/file-pipeline/read.js b/lib/cli/file-pipeline/read.js
@@ -42,8 +42,8 @@ var ENCODING = 'utf-8';
  *
  *   read({'file': file}, console.log);
  *
- * @param {Object} context
- * @param {function(Error?)} done
+ * @param {Object} context - Context object.
+ * @param {function(Error?)} done - Completion handler.
  */
 function read(context, done) {
     var file = context.file;

diff --git a/lib/cli/file-pipeline/stdout.js b/lib/cli/file-pipeline/stdout.js
@@ -39,7 +39,7 @@ var debug = require('debug')('mdast:cli:file-pipeline:stdout');
  *     'fileSet': fileSet
  *   });
  *
- * @param {Object} context
+ * @param {Object} context - Context object.
  */
 function stdout(context) {
     var fileSet = context.fileSet;

diff --git a/lib/cli/file-pipeline/stringify.js b/lib/cli/file-pipeline/stringify.js
@@ -32,7 +32,7 @@ var debug = require('debug')('mdast:cli:file-pipeline:stringify');
  *   parse(context);
  *   stringify(context);
  *
- * @param {Object} context
+ * @param {Object} context - Context object.
  */
 function stringify(context) {
     var cli = context.fileSet.cli;

diff --git a/lib/cli/file-pipeline/transform.js b/lib/cli/file-pipeline/transform.js
@@ -34,8 +34,8 @@ var debug = require('debug')('mdast:cli:file-pipeline:transform');
  *
  *   transform({'file': file}, console.log);
  *
- * @param {Object} context
- * @param {function(Error?)} done
+ * @param {Object} context - Context object.
+ * @param {function(Error?)} done - Completion handler.
  */
 function transform(context, done) {
     var file = context.file;

diff --git a/lib/cli/file-set-pipeline/configure.js b/lib/cli/file-set-pipeline/configure.js
@@ -26,17 +26,17 @@ var Configuration = require('../configuration');
  *     'settings': {'position': false},
  *   });
  *
- * @param {CLI} cli
+ * @param {Object} context - Context object.
  */
-function configure(cli) {
-    if (!cli.configuration) {
-        cli.configuration = new Configuration({
-            'detectRC': cli.detectRC,
-            'file': cli.configPath,
-            'settings': cli.settings,
-            'plugins': cli.plugins,
-            'output': cli.output,
-            'cwd': cli.cwd
+function configure(context) {
+    if (!context.configuration) {
+        context.configuration = new Configuration({
+            'detectRC': context.detectRC,
+            'file': context.configPath,
+            'settings': context.settings,
+            'plugins': context.plugins,
+            'output': context.output,
+            'cwd': context.cwd
         });
     }
 }

diff --git a/lib/cli/file-set-pipeline/file-system.js b/lib/cli/file-set-pipeline/file-system.js
@@ -26,32 +26,32 @@ var Finder = require('../finder');
  *     'extensions': ['markdown']
  *   });
  *
- * @param {CLI} cli - Context object.
- * @param {function(Error?)} next - Callback invoked when
+ * @param {Object} context - Context object.
+ * @param {function(Error?)} done - Callback invoked when
  *   done.
  */
-function traverse(cli, next) {
+function traverse(context, done) {
     /** Traverse. */
-    function done() {
-        cli.traverser.find(cli.globs, function (err, files) {
-            cli.files = files || [];
-            next(err);
+    function next() {
+        context.traverser.find(context.globs, function (err, files) {
+            context.files = files || [];
+            done(err);
         });
     }
 
-    if (cli.traverser) {
-        done();
+    if (context.traverser) {
+        next();
     } else {
         new Ignore({
-            'file': cli.ignorePath,
-            'detectIgnore': cli.detectIgnore
+            'file': context.ignorePath,
+            'detectIgnore': context.detectIgnore
         }).getPatterns(null, function (err, patterns) {
-            cli.traverser = new Finder({
-                'extensions': cli.extensions,
+            context.traverser = new Finder({
+                'extensions': context.extensions,
                 'ignore': patterns || []
             });
 
-            done();
+            next();
         });
     }
 }