Update code-style guidelines

Author: wooorm

.eslintrc

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

.jscs.json

@@ -1,16 +1,25 @@
 {
   "excludeFiles": [
-    "build/",
     "components/",
     "coverage/",
     "node_modules/",
-    "build.js",
     "example.js",
     "mdast-util-heading-range.js",
     "mdast-util-heading-range.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,
@@ -20,126 +29,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,5 +1,15 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module mdast:util:heading-range
+ * @fileoverview Markdown heading as ranges in mdast.
+ */
+
 'use strict';
 
+/* eslint-env commonjs */
+
 /*
  * Dependencies.
  */
@@ -16,7 +26,7 @@ var splice = [].splice;
  * Transform a string into an applicable expression.
  *
  * @param {string} value - Value to transform.
- * @return {RegExp}
+ * @return {RegExp} - Expression.
  */
 function toExpression(value) {
     return new RegExp('^(' + value + ')$', 'i');
@@ -26,14 +36,14 @@ function toExpression(value) {
  * Wrap an expression into an assertion function.
  *
  * @param {RegExp} expression - Expression to test.
- * @return {Function}
+ * @return {Function} - Assertion.
  */
 function wrapExpression(expression) {
     /**
      * Assert `value` matches the bound `expression`.
      *
      * @param {string} value - Value to check.
-     * @return {boolean}
+     * @return {boolean} - Whether `value` matches.
      */
     function assertion(value) {
         return expression.test(value);
@@ -46,7 +56,7 @@ function wrapExpression(expression) {
  * Check if `node` is a heading.
  *
  * @param {Node} node - Node to check.
- * @return {boolean}
+ * @return {boolean} - Whether `node` is a heading.
  */
 function isHeading(node) {
     return node && node.type === 'heading';
@@ -58,8 +68,8 @@ function isHeading(node) {
  * @param {Node} node - Node to check.
  * @param {number?} depth - Depth to search for.
  * @param {function(string): boolean} test - Tester.
- *
- * @return {boolean}
+ * @return {boolean} - Whether `node` is an opening
+ *   heading.
  */
 function isOpeningHeading(node, depth, test) {
     return depth === null && isHeading(node) && test(toString(node), node);
@@ -70,7 +80,8 @@ function isOpeningHeading(node, depth, test) {
  *
  * @param {Node} node - Node to check.
  * @param {number?} depth - Depth of the opening heading.
- * @return {boolean}
+ * @return {boolean} - Whether `node` is a closing
+ *   heading.
  */
 function isClosingHeading(node, depth) {
     return depth && isHeading(node) && node.depth <= depth;
@@ -154,7 +165,7 @@ function search(root, test, callback) {
  *   search for.
  * @param {Function} callback - Callback invoked when
  *   found.
- * @return {function(node)}
+ * @return {function(node)} - Attacher.
  */
 function wrapper(heading, callback) {
     var test = heading;

mdast-util-heading-range.js

@@ -1,6 +1,16 @@
 (function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.mdastUtilHeadingRange = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module mdast:util:heading-range
+ * @fileoverview Markdown heading as ranges in mdast.
+ */
+
 'use strict';
 
+/* eslint-env commonjs */
+
 /*
  * Dependencies.
  */
@@ -17,7 +27,7 @@ var splice = [].splice;
  * Transform a string into an applicable expression.
  *
  * @param {string} value - Value to transform.
- * @return {RegExp}
+ * @return {RegExp} - Expression.
  */
 function toExpression(value) {
     return new RegExp('^(' + value + ')$', 'i');
@@ -27,14 +37,14 @@ function toExpression(value) {
  * Wrap an expression into an assertion function.
  *
  * @param {RegExp} expression - Expression to test.
- * @return {Function}
+ * @return {Function} - Assertion.
  */
 function wrapExpression(expression) {
     /**
      * Assert `value` matches the bound `expression`.
      *
      * @param {string} value - Value to check.
-     * @return {boolean}
+     * @return {boolean} - Whether `value` matches.
      */
     function assertion(value) {
         return expression.test(value);
@@ -47,7 +57,7 @@ function wrapExpression(expression) {
  * Check if `node` is a heading.
  *
  * @param {Node} node - Node to check.
- * @return {boolean}
+ * @return {boolean} - Whether `node` is a heading.
  */
 function isHeading(node) {
     return node && node.type === 'heading';
@@ -59,8 +69,8 @@ function isHeading(node) {
  * @param {Node} node - Node to check.
  * @param {number?} depth - Depth to search for.
  * @param {function(string): boolean} test - Tester.
- *
- * @return {boolean}
+ * @return {boolean} - Whether `node` is an opening
+ *   heading.
  */
 function isOpeningHeading(node, depth, test) {
     return depth === null && isHeading(node) && test(toString(node), node);
@@ -71,7 +81,8 @@ function isOpeningHeading(node, depth, test) {
  *
  * @param {Node} node - Node to check.
  * @param {number?} depth - Depth of the opening heading.
- * @return {boolean}
+ * @return {boolean} - Whether `node` is a closing
+ *   heading.
  */
 function isClosingHeading(node, depth) {
     return depth && isHeading(node) && node.depth <= depth;
@@ -155,7 +166,7 @@ function search(root, test, callback) {
  *   search for.
  * @param {Function} callback - Callback invoked when
  *   found.
- * @return {function(node)}
+ * @return {function(node)} - Attacher.
  */
 function wrapper(heading, callback) {
     var test = heading;

test.js

@@ -3,7 +3,7 @@
  * @copyright 2015 Titus Wormer
  * @license MIT
  * @module mdast:util:heading-range:script
- * @fileoverview Markdown heading as ranges in mdast.
+ * @fileoverview Test suite for `mdast-util-heading-range`.
  */
 
 'use strict';
@@ -24,7 +24,7 @@ var heading = require('./');
  * @param {Object} t - Test.
  * @param {string} value - Value to process.
  * @param {*} options - configuration.
- * @return {string}
+ * @return {string} - Processed value.
  */
 function process(t, value, options) {
     return remark().use(function (processor, name) {
@@ -322,7 +322,8 @@ test('mdast-util-heading-range()', function (t) {
     remark().use(function (processor) {
         processor.use(heading('foo', function (start, nodes, end) {
             t.equal(nodes.length, 3);
-            return [start].concat(nodes, end)
+
+            return [start].concat(nodes, end);
         }));
     }).process([
         '# Alpha',