eslint-plugin-jsdoc - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1

dist/iterateJsdoc.js

@@ -21,4 +21,4 @@ 'use strict';
         checkJsdoc = function (functionNode) {
-            var jsdocNode = undefined,
-                jsdoc = undefined;
+            var jsdoc = undefined,
+                jsdocNode = undefined;
 
@@ -25,0 +25,0 @@ jsdocNode = sourceCode.getJSDocComment(functionNode);

dist/jsdocUtils.js

@@ -26,2 +26,3 @@ 'use strict';
     });
+
     jsdocParameterNames = (0, _map2.default)(jsdocParameterNames, 'name');
@@ -28,0 +29,0 @@

dist/rules/checkParamNames.js

@@ -37,6 +37,6 @@ 'use strict';
 
-    return (0, _some2.default)(jsdocParameterNames, function (jsdocParameterName, i) {
+    return (0, _some2.default)(jsdocParameterNames, function (jsdocParameterName, index) {
         var functionParameterName = undefined;
 
-        functionParameterName = functionParameterNames[i];
+        functionParameterName = functionParameterNames[index];
 
@@ -59,7 +59,4 @@ if (!functionParameterName) {
     var jsdocParameterNamesDeep = undefined,
-        lastRealParameter = undefined,
-        parameterCount = undefined;
+        lastRealParameter = undefined;
 
-    parameterCount = -1;
-
     jsdocParameterNamesDeep = _jsdocUtils2.default.getJsdocParameterNamesDeep(jsdoc);
@@ -96,4 +93,2 @@
     var functionParameterNames = undefined,
-        jsdocParameterNames = undefined,
-        jsdocParameterNamesDeep = undefined,
         isError = undefined;
@@ -100,0 +95,0 @@

dist/rules/checkTypes.js

@@ -29,4 +29,4 @@ 'use strict';
 
-var targetTags = undefined,
-    strictNativeTypes = undefined;
+var strictNativeTypes = undefined,
+    targetTags = undefined;
 
@@ -33,0 +33,0 @@ targetTags = ['class', 'constant', 'enum', 'member', 'module', 'namespace', 'param', 'property', 'returns', 'throws', 'type', 'typedef'];

dist/rules/newlineAfterDescription.js

@@ -15,6 +15,2 @@ 'use strict';
 
-var _jsdocUtils = require('./../jsdocUtils');
-
-var _jsdocUtils2 = _interopRequireDefault(_jsdocUtils);
-
 var _iterateJsdoc = require('./../iterateJsdoc');
@@ -21,0 +17,0 @@

dist/rules/requireDescriptionCompleteSentence.js

@@ -7,2 +7,10 @@ 'use strict';
 
+var _includes = require('lodash/collection/includes');
+
+var _includes2 = _interopRequireDefault(_includes);
+
+var _filter = require('lodash/collection/filter');
+
+var _filter2 = _interopRequireDefault(_filter);
+
 var _isBoolean = require('lodash/lang/isBoolean');
@@ -16,6 +24,2 @@
 
-var _jsdocUtils = require('./../jsdocUtils');
-
-var _jsdocUtils2 = _interopRequireDefault(_jsdocUtils);
-
 var _iterateJsdoc = require('./../iterateJsdoc');
@@ -28,4 +32,4 @@
 var extractParagraphs = undefined,
-    validateDescription = undefined,
-    isNewLinePrecededByAPeriod = undefined;
+    isNewLinePrecededByAPeriod = undefined,
+    validateDescription = undefined;
 
@@ -37,4 +41,4 @@ extractParagraphs = function (text) {
 isNewLinePrecededByAPeriod = function (text) {
-    var lines = undefined,
-        lastLineEndsSentence = undefined;
+    var lastLineEndsSentence = undefined,
+        lines = undefined;
 
@@ -53,4 +57,3 @@ lines = text.split('\n');
 validateDescription = function (description, report) {
-    var isError = undefined,
-        paragraphs = undefined;
+    var paragraphs = undefined;
 
@@ -63,5 +66,5 @@ if (!description) {
 
-    return (0, _some2.default)(paragraphs, function (paragraph, i) {
+    return (0, _some2.default)(paragraphs, function (paragraph, index) {
         if (!/^[A-Z]/.test(paragraph)) {
-            if (i === 0) {
+            if (index === 0) {
                 report('Description must start with an uppercase character.');
@@ -90,5 +93,25 @@ } else {
 exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
-    validateDescription(jsdoc.description, report);
+    var tags = undefined;
+
+    if (validateDescription(jsdoc.description, report)) {
+        return;
+    }
+
+    tags = (0, _filter2.default)(jsdoc.tags, function (tag) {
+        return (0, _includes2.default)(['param', 'returns'], tag.tag);
+    });
+
+    (0, _some2.default)(tags, function (tag) {
+        var description = undefined;
+
+        description = tag.description;
+
+        if (tag.tag === 'returns') {
+            description = tag.name;
+        }
+
+        return validateDescription(description, report);
+    });
 });
 module.exports = exports['default'];
 //# sourceMappingURL=requireDescriptionCompleteSentence.js.map

dist/rules/requireHyphenBeforeDescription.js

@@ -19,6 +19,2 @@ 'use strict';
 
-var _jsdocUtils = require('./../jsdocUtils');
-
-var _jsdocUtils2 = _interopRequireDefault(_jsdocUtils);
-
 var _iterateJsdoc = require('./../iterateJsdoc');
@@ -25,0 +21,0 @@

dist/rules/requireParam.js

@@ -32,6 +32,6 @@ 'use strict';
 
-    (0, _some2.default)(functionParameterNames, function (functionParameterName, i) {
+    (0, _some2.default)(functionParameterNames, function (functionParameterName, index) {
         var jsdocParameterName = undefined;
 
-        jsdocParameterName = jsdocParameterNames[i];
+        jsdocParameterName = jsdocParameterNames[index];
 
@@ -38,0 +38,0 @@ if (!jsdocParameterName) {

dist/rules/requireParamDescription.js

@@ -15,6 +15,2 @@ 'use strict';
 
-var _jsdocUtils = require('./../jsdocUtils');
-
-var _jsdocUtils2 = _interopRequireDefault(_jsdocUtils);
-
 var _iterateJsdoc = require('./../iterateJsdoc');
@@ -21,0 +17,0 @@

package.json

 {
   "name": "eslint-plugin-jsdoc",
   "description": "JSDoc linting rules for ESLint.",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "main": "./dist/index.js",
@@ -6,0 +6,0 @@ "repository": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

69605

increased by0.84%

Lines of code

575

increased by0.88%

No dependency changes