jscsrc: add requireNewlineAfterDescription rule

Author: Alexej Yaroshevich

.jscsrc

@@ -30,6 +30,7 @@
         "checkRedundantReturns": true,
         "requireReturnTypes": true,
         "checkTypes": "strictNativeCase",
-        "checkRedundantAccess": true
+        "checkRedundantAccess": true,
+        "requireNewlineAfterDescription": true
     }
 }

lib/esprima-helpers.js

@@ -10,6 +10,7 @@ var scopeNodeTypes = [
 
 /**
  * Search for the closest scope node tree for Node
+ *
  * @param {{type: string}} n
  * @returns {EsprimaNode}
  */

lib/jsdoc.js

@@ -41,6 +41,7 @@ module.exports = {
 
 /**
  * jsdoc comment object
+ *
  * @param {string} value
  * @param {{start: DocLocation}} loc
  * @constructor
@@ -103,6 +104,7 @@ function DocComment(value, loc) {
 
 /**
  * Simple jsdoc tag object
+ *
  * @param {Object} tag object from comment parser, fields: tag, line, value, name, type, description
  * @param {DocLocation} loc
  * @constructor
@@ -133,6 +135,7 @@ function DocTag(tag, loc) {
 
 /**
  * Parses jsdoctype string and provides several methods to work with it
+ *
  * @param {string} type
  * @param {DocLocation} loc
  * @constructor
@@ -156,7 +159,8 @@ function DocType(type, loc) {
     }
 
     /**
-     * match type
+     * Match type
+     *
      * @param {EsprimaNode} node
      * @returns {boolean}
      */
@@ -178,6 +182,7 @@ function DocType(type, loc) {
 
 /**
  * DocLocation
+ *
  * @constructor
  * @param {number} line
  * @param {number} column
@@ -193,6 +198,7 @@ function DocLocation(line, column, rel) {
 
 /**
  * Shift location by line and column
+ *
  * @param {number|Object} line
  * @param {number} [column]
  * @returns {DocLocation}
@@ -207,6 +213,7 @@ DocLocation.prototype.shift = function(line, column) {
 
 /**
  * Comment parsing helper
+ *
  * @param {string} comment
  * @returns {Object}
  * @private
@@ -229,6 +236,7 @@ function _parseComment(comment) {
 
 /**
  * analogue of str.match(/@(\S+)(?:\s+\{([^\}]+)\})?(?:\s+(\S+))?(?:\s+([^$]+))?/);
+ *
  * @param {string} str raw jsdoc string
  * @returns {?Object} parsed tag node
  */
@@ -444,6 +452,7 @@ function _iterateDocTypes(node, cb) {
 
 /**
  * Converts AST jsDoc node to simple object
+ *
  * @param {Object} node
  * @returns {!Array.<SimplifiedType>}
  * @see https://github.com/Kuniwak/jsdoctypeparser
@@ -463,6 +472,7 @@ var jsPrimitives = 'string number boolean null undefined Object Function Array D
 
 /**
  * Compare parsed jsDocTypes with esprima node
+ *
  * @param {SimplifiedType[]} variants - result of jsDocParseType
  * @param {Object} argument - esprima source code node
  */

lib/rules/validate-jsdoc.js

@@ -6,6 +6,7 @@ var validators = require('./validate-jsdoc/index');
 
 /**
  * Rule constructor
+ *
  * @this {module:jscs/Rule}
  * @constructor
  */
@@ -15,6 +16,7 @@ module.exports.prototype = {
 
     /**
      * Load all rules and init them
+     *
      * @param {Object} options
      * @throws {Error} If options is not an Object
      */
@@ -137,7 +139,8 @@ module.exports.prototype = {
                 });
 
                 /**
-                 * send error to jscs
+                 * Send error to jscs
+                 *
                  * @param {string} text
                  * @param {number|DocLocation} relLine
                  * @param {number} [relColumn]
@@ -157,6 +160,7 @@ module.exports.prototype = {
 
                 /**
                  * Generates function with location fixing logic to send error to jscs
+                 *
                  * @param {function(string, number|Object, ?number)} err
                  * @param {DocTag} tag
                  * @returns {function(string, number|Object, ?number)}
@@ -175,7 +179,8 @@ module.exports.prototype = {
     },
 
     /**
-     * caching scope search. todo: move to patchNodesInFile
+     * Caching scope search. todo: move to patchNodesInFile
+     *
      * @param {Object} node
      */
     _getReturnStatementsForNode: function(node) {
@@ -199,6 +204,7 @@ module.exports.prototype = {
 
 /**
  * Extends each node with helper properties
+ *
  * @param {Object} file
  */
 function patchNodesInFile(file) {
@@ -218,6 +224,7 @@ function patchNodesInFile(file) {
 
     /**
      * Fetchs jsdoc block for this
+     *
      * @this {module:esprima/Node}
      * @returns {DocComment}
      */
@@ -231,6 +238,7 @@ function patchNodesInFile(file) {
 
     /**
      * Finds DocComment in file before passed line number
+     *
      * @param {number} line
      * @returns {?module:esprima/Node}
      */

lib/rules/validate-jsdoc/check-annotations.js

@@ -65,7 +65,8 @@ validateAnnotations.configure = function(options) {
 };
 
 /**
- * validator for annotations
+ * Validator for annotations
+ *
  * @param {JSCS.JSFile} file
  * @param {JSCS.Errors} errors
  */

lib/rules/validate-jsdoc/check-param-names.js

@@ -5,7 +5,8 @@ module.exports.options = {
 };
 
 /**
- * validator for check-param-names
+ * Validator for check-param-names
+ *
  * @param {(FunctionDeclaration|FunctionExpression)} node
  * @param {Function} err
  */
@@ -31,7 +32,8 @@ function validateCheckParamNames(node, err) {
 
     node.jsdoc.iterateByType(['param', 'arg', 'argument'],
         /**
-         * tag checker
+         * Tag checker
+         *
          * @param {DocType} tag
          * @param {number} i index
          */

lib/rules/validate-jsdoc/check-redundant-access.js

@@ -6,7 +6,8 @@ module.exports.options = {
 };
 
 /**
- * validator for @access
+ * Validator for @access
+ *
  * @param {(FunctionDeclaration|FunctionExpression)} node
  * @param {Function} err
  */

lib/rules/validate-jsdoc/check-redundant-params.js

@@ -5,7 +5,8 @@ module.exports.options = {
 };
 
 /**
- * validator for check-param-names
+ * Validator for check-param-names
+ *
  * @param {(FunctionDeclaration|FunctionExpression)} node
  * @param {Function} err
  */
@@ -18,7 +19,8 @@ function validateCheckParamNames(node, err) {
 
     node.jsdoc.iterateByType(['param', 'arg', 'argument'],
         /**
-         * tag checker
+         * Tag checker
+         *
          * @param {DocType} tag
          * @param {number} i index
          */

lib/rules/validate-jsdoc/check-redundant-returns.js

@@ -6,7 +6,8 @@ module.exports.options = {
 };
 
 /**
- * checking returns types
+ * Checking returns types
+ *
  * @param {(FunctionDeclaration|FunctionExpression)} node
  * @param {DocTag} tag
  * @param {Function} err

lib/rules/validate-jsdoc/check-return-types.js

@@ -6,7 +6,8 @@ module.exports.options = {
 };
 
 /**
- * checking returns types
+ * Checking returns types
+ *
  * @param {(FunctionDeclaration|FunctionExpression)} node
  * @param {DocTag} tag
  * @param {Function} err