Merge pull request #60 from zxqfox/feature/capitalized-natives

checkTypes: add capitalizedNativeCase mode

Author: qfox

README.md

@@ -374,9 +374,11 @@ Reports invalid types for bunch of tags
 
 In `strictNativeCase` mode ensures that case of natives is the same as in this list: `boolean`, `number`, `string`, `null`, `Object`, `Array`, `Date`, `RegExp`.
 
+In `capitalizedNativeCase` mode ensures that all types are uppercased except function closure format: `{function(...)}`
+
 Type: `Boolean` or `String`
 
-Values: `true` or `"strictNativeCase"`
+Values: `true` or `"strictNativeCase"` or `"capitalizedNativeCase"`
 
 Context: `*`
 

lib/jsdoc.js

@@ -330,7 +330,11 @@ function _iterateDocTypes(node, cb) {
                 subnode.parentNode = node.selfNode;
             }
             return _iterateDocTypes(subnode, cb);
-        });
+        }) || [];
+        if (node.nullable) {
+            var subnode = {typeName: 'null', parentNode: node};
+            res.concat(cb(subnode));
+        }
         break;
 
     case node instanceof TypeBuilder.TypeName:

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

@@ -3,7 +3,7 @@ var jsdoc = require('../../jsdoc');
 module.exports = validateTypesInTags;
 module.exports.scopes = ['file'];
 module.exports.options = {
-    checkTypes: {allowedValues: [true, 'strictNativeCase']}
+    checkTypes: {allowedValues: [true, 'strictNativeCase', 'capitalizedNativeCase']}
 };
 
 var allowedTags = {
@@ -53,6 +53,8 @@ var strictNatives = {
  */
 function validateTypesInTags(file, errors) {
     var strictNativeCase = this._options.checkTypes === 'strictNativeCase';
+    var capitalizedNativeCase = this._options.checkTypes === 'capitalizedNativeCase';
+
     var comments = file.getComments();
     comments.forEach(function(commentNode) {
         if (commentNode.type !== 'Block' || commentNode.value[0] !== '*') {
@@ -74,7 +76,7 @@ function validateTypesInTags(file, errors) {
                 // throw an error if not valid
                 errors.add('expects valid type instead of ' + tag.type.value, tag.type.loc);
             }
-            if (strictNativeCase) {
+            if (strictNativeCase || capitalizedNativeCase) {
                 tag.type.iterate(function(node) {
                     // it shouldn't be!
                     if (!node.typeName) {
@@ -85,7 +87,13 @@ function validateTypesInTags(file, errors) {
                     // is native?
                     var type = node.typeName;
                     var lowerType = type.toLowerCase();
-                    if (lowerType in strictNatives && type !== strictNatives[lowerType]) {
+                    //console.log(capitalizedNativeCase, type, lowerType, strictNatives.hasOwnProperty(type));
+                    if (!strictNatives.hasOwnProperty(lowerType)) {
+                        return;
+                    }
+                    var normType = strictNatives[lowerType];
+                    if (strictNativeCase && type !== normType ||
+                        capitalizedNativeCase && type !== (normType[0].toUpperCase() + normType.substr(1))) {
                         errors.add('invalid case of type `' + type + '`', tag.type.loc);
                     }
                 });

test/lib/jsdoc.js

@@ -56,10 +56,12 @@ describe('jsdoc', function() {
     describe('type', function() {
         var bool1;
         var varnum;
+        var nullie;
 
         before(function() {
             bool1 = new Type('boolean', new Location(3, 4));
             varnum = new Type('...number', new Location(10, 20));
+            nullie = new Type('Null|null', new Location(2, 5));
         });
 
         it('should store data', function() {
@@ -76,6 +78,18 @@ describe('jsdoc', function() {
             expect(bool1.match({type: 'Literal', value: null})).to.eq(false);
         });
 
+        it('should parse null', function() {
+            var passed = '';
+            nullie.iterate(function(type) {
+                if (type.typeName === 'Null') {
+                    passed += 1;
+                }
+                if (type.typeName === 'null') {
+                    passed += 2;
+                }
+            });
+            expect(passed).to.eq('12');
+        });
     });
 
     describe('tag', function() {

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

@@ -236,4 +236,79 @@ describe('lib/rules/validate-jsdoc/check-types', function() {
 
     });
 
+    describe('with capitalzedNativeCase', function() {
+        checker.rules({checkTypes: 'capitalizedNativeCase'});
+
+        checker.cases([
+            /* jshint ignore:start *//* jscs: disable */
+            {
+                it: 'should not report strict natives',
+                code: function() {
+                    /**
+                     * @param {Number}
+                     * @param {String}
+                     * @param {Boolean}
+                     * @param {Null}
+                     * @param {Array}
+                     * @param {Object}
+                     * @param {Date}
+                     * @param {Function}
+                     */
+                    function _f () {}
+                }
+            }, {
+                it: 'should not report joined native types',
+                code: function() {
+                    /**
+                     * @param {Number|String|Boolean|Null|Array|Object|Date}
+                     */
+                    function _f () {}
+                }
+            }, {
+                it: 'should not report function arguments',
+                code: function() {
+                    /**
+                     * @param {function(Number, Array)}
+                     */
+                    function _f () {}
+                }
+            }, {
+                it: 'should report lowercased natives',
+                errors: 6,
+                code: function() {
+                    /**
+                     * @param {number}
+                     * @param {string}
+                     * @param {boolean}
+                     * @param {array}
+                     * @param {object}
+                     * @param {date}
+                     */
+                    function _f () {}
+                }
+            }, {
+                it: 'should report joined lowercased natives',
+                errors: 7,
+                code: function() {
+                    /**
+                     * @param {number|string|boolean|null}
+                     * @param {array|object|date}
+                     */
+                    function _f () {}
+                }
+            }, {
+                it: 'should report joined strict wrong cased natives',
+                code: function() {
+                    /**
+                     * @param {number|string|boolean|null|array|object|date|regexp|function}
+                     */
+                    function _f () {}
+                },
+                errors: 9
+            }
+            /* jshint ignore:end *//* jscs: enable */
+        ]);
+
+    });
+
 });