new rule: requireHyphenBeforeDescription

Author: hzoo

lib/rules/validate-jsdoc/index.js

@@ -6,6 +6,7 @@ var validatorsByName = module.exports = {
     checkParamNames: require('./check-param-names'),
     checkRedundantParams: require('./check-redundant-params'),
     requireParamTypes: require('./require-param-types'),
+    requireHyphenBeforeDescription: require('./require-hyphen-before-description'),
 
     checkReturnTypes: require('./check-return-types'),
     requireReturnTypes: require('./require-return-types'),

lib/rules/validate-jsdoc/require-hyphen-before-description.js

@@ -0,0 +1,22 @@
+module.exports = requireHyphenBeforeDescription;
+module.exports.tags = ['param', 'arg', 'argument'];
+module.exports.scopes = ['function'];
+module.exports.options = {
+    requireHyphenBeforeDescription: {allowedValues: [true]}
+};
+
+/**
+ * checking returns types
+ * @param {(FunctionDeclaration|FunctionExpression)} node
+ * @param {DocTag} tag
+ * @param {Function} err
+ */
+function requireHyphenBeforeDescription(node, tag, err) {
+    if (!tag.description) {
+        return;
+    }
+
+    if (tag.description.substring(0, 2) !== '- ') {
+        err('Missing hyphen before description', tag.loc);
+    }
+}

test/lib/rules/validate-jsdoc/require-hyphen-before-description.js

@@ -0,0 +1,66 @@
+describe('lib/rules/validate-jsdoc/require-hyphen-before-description', function () {
+    var checker = global.checker({
+        additionalRules: ['lib/rules/validate-jsdoc.js']
+    });
+
+    describe('configured', function() {
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({requireHyphenBeforeDescription: undefined});
+            }).to.throws(/accepted value/i);
+        });
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({requireHyphenBeforeDescription: {}});
+            }).to.throws(/accepted value/i);
+        });
+
+    });
+
+    describe('with true', function() {
+        checker.rules({requireHyphenBeforeDescription: true});
+
+        checker.cases([
+            /* jshint ignore:start */
+            {
+                it: 'should not throw',
+                code: function() {
+                    function yay(yey) {
+                    }
+
+                    /**
+                     * @param {number} yay
+                     */
+                    function yey(yay) {
+                    }
+                }
+
+            }, {
+                it: 'should report invalid description (without a hyphen)',
+                code: function () {
+                    /**
+                     * @param {number} yay description without hyphen
+                     */
+                    function yey(yay) {
+                    }
+                },
+                errors: 1
+            }, {
+                it: 'should not report valid description (with hyphen)',
+                code: function () {
+                    /**
+                     * @param {number} yay - description without hyphen
+                     */
+                    function yey(yay) {
+                    }
+                }
+
+            }
+            /* jshint ignore:end */
+        ]);
+
+    });
+
+});