Misc: make error messages consistent: sentence case and no period

Closes gh-148

Author: aj-dev

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

@@ -84,7 +84,7 @@ function validateAnnotations(file, errors) {
 
         node.iterate(function(tag) {
             if (!(tag.id in tags)) {
-                errors.add('unavailable tag ' + tag.id, tag.loc);
+                errors.add('Unavailable tag ' + tag.id, tag.loc);
                 return;
             }
 
@@ -93,7 +93,7 @@ function validateAnnotations(file, errors) {
             switch (tags[tag.id]) {
                 case false:
                     if (isFilled) {
-                        errors.add('unexpected data in tag ' + tag.id, tag.loc);
+                        errors.add('Unexpected data in tag ' + tag.id, tag.loc);
                     }
                     break;
 
@@ -103,7 +103,7 @@ function validateAnnotations(file, errors) {
 
                 case 'some':
                     if (!isFilled) {
-                        errors.add('incomplete data in tag ' + tag.id, tag.loc);
+                        errors.add('Incomplete data in tag ' + tag.id, tag.loc);
                     }
                     break;
 

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

@@ -79,7 +79,7 @@ function validateTypesInTags(file, errors) {
                 }
                 if (!tag.type.valid) {
                     // throw an error if not valid
-                    errors.add('expects valid type instead of ' + tag.type.value, tag.type.loc);
+                    errors.add('Expects valid type instead of ' + tag.type.value, tag.type.loc);
                 }
                 if (strictNativeCase || capitalizedNativeCase) {
                     tag.type.iterate(function(node) {
@@ -99,7 +99,7 @@ function validateTypesInTags(file, errors) {
                         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);
+                            errors.add('Invalid case of type `' + type + '`', tag.type.loc);
                         }
                     });
                 }

lib/rules/validate-jsdoc/require-description-complete-sentence.js

@@ -59,7 +59,7 @@ function requireDescriptionCompleteSentence(node, err) {
     if (START_DESCRIPTION.test(doc.description)) {
         var matches = returnAllMatches(doc.description, START_DESCRIPTION);
         matches.map(function(match) {
-            match.message = 'Description must start with an upper case letter.';
+            match.message = 'Description must start with an upper case letter';
             match.index = match.start;
         });
         errors = errors.concat(matches);
@@ -68,7 +68,7 @@ function requireDescriptionCompleteSentence(node, err) {
     if (RE_NEW_LINE_START_WITH_UPPER_CASE.test(doc.description)) {
         var matches1 = returnAllMatches(doc.description, RE_NEW_LINE_START_WITH_UPPER_CASE);
         matches1.map(function(match) {
-            match.message = 'Sentence must start with an upper case letter.';
+            match.message = 'Sentence must start with an upper case letter';
             match.index = match.end - 1;
         });
         errors = errors.concat(matches1);
@@ -77,7 +77,7 @@ function requireDescriptionCompleteSentence(node, err) {
     if (RE_END_WITH_PERIOD.test(doc.description)) {
         var matches2 = returnAllMatches(doc.description, RE_END_WITH_PERIOD);
         matches2.map(function(match) {
-            match.message = 'Sentence must end with a period.';
+            match.message = 'Sentence must end with a period';
             match.index = match.start;
         });
         errors = errors.concat(matches2);
@@ -87,7 +87,7 @@ function requireDescriptionCompleteSentence(node, err) {
         var matches3 = returnAllMatches(doc.description, RE_NEW_LINE_UPPERCASE);
         matches3.map(function(match) {
             match.message = 'You started a new line with an upper case letter but ' +
-                'previous line does not end with a period.';
+                'previous line does not end with a period';
             match.index = match.end - 1;
         });
         errors = errors.concat(matches3);

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

@@ -10,7 +10,7 @@ describe('lib/rules/validate-jsdoc/check-annotations', function() {
             /* jshint ignore:start */
             {
                 it: 'should throw unavailable tag',
-                errors: {message: 'unavailable tag ppublic'},
+                errors: {message: 'Unavailable tag ppublic'},
                 code: function() {
                     /**
                      * @ppublic
@@ -35,7 +35,7 @@ describe('lib/rules/validate-jsdoc/check-annotations', function() {
             },
             {
                 it: 'should throw @access without data',
-                errors: {message: 'incomplete data in tag access'},
+                errors: {message: 'Incomplete data in tag access'},
                 code: function() {
                     /** @access */
                 }
@@ -68,7 +68,7 @@ describe('lib/rules/validate-jsdoc/check-annotations', function() {
             },
             {
                 it: 'should throw unavailable @arg',
-                errors: {message: 'unavailable tag arg'},
+                errors: {message: 'Unavailable tag arg'},
                 code: function() {
                     /**
                      * @arg