eslint-plugin-jsdoc - npm Package Compare versions

Comparing version 3.3.1 to 3.4.0

dist/rules/requireDescriptionCompleteSentence.js

@@ -22,7 +22,14 @@ 'use strict';
 var extractSentences = function extractSentences(text) {
-  return text.split(/\.\s+|\.$/).filter(function (sentence) {
-    // Ignore sentences with only whitespaces.
+  return text
+
+  // Remove all {} tags.
+  .replace(/\{[\s\S]*?\}\s*/g, '').split(/[.?!:](?:\s+|$)/)
+
+  // Ignore sentences with only whitespaces.
+  .filter(function (sentence) {
     return !/^\s*$/.test(sentence);
-  }).map(function (sentence) {
-    // Re-add the dot.
+  })
+
+  // Re-add the dot.
+  .map(function (sentence) {
     return sentence + '.';
@@ -69,3 +76,3 @@ });
 
-      if (!_lodash2.default.endsWith(paragraph, '.')) {
+      if (!/[.:?!]$/.test(paragraph)) {
         var line = _lodash2.default.last(paragraph.split('\n'));
@@ -114,3 +121,3 @@
 
-    if (!/\.$/.test(paragraph)) {
+    if (!/[.!?]$/.test(paragraph)) {
       report('Sentence must end with a period.', fix);
@@ -142,3 +149,3 @@
   var tags = _lodash2.default.filter(jsdoc.tags, function (tag) {
-    return _lodash2.default.includes(['param', 'returns'], tag.tag);
+    return _lodash2.default.includes(['param', 'arg', 'argument', 'returns', 'return'], tag.tag);
   });
@@ -145,0 +152,0 @@

package.json

@@ -1,1 +0,1 @@
-{"author":{"email":"[e-mail]","name":"Gajus Kuizinas","url":"http://gajus.com"},"dependencies":{"comment-parser":"^0.4.2","lodash":"^4.17.4"},"description":"JSDoc linting rules for ESLint.","devDependencies":{"babel-cli":"^6.26.0","babel-plugin-add-module-exports":"^0.2.1","babel-plugin-transform-flow-strip-types":"^6.22.0","babel-preset-env":"^1.6.0","babel-preset-es2015":"^6.24.1","babel-register":"^6.26.0","chai":"^4.1.2","eslint":"^4.7.2","eslint-config-canonical":"^9.3.1","gitdown":"^2.5.1","globby":"^6.1.0","mocha":"^3.5.3","semantic-release":"^8.0.3"},"engines":{"node":">=4"},"keywords":["eslint","plugin","jsdoc"],"license":"BSD-3-Clause","main":"./dist/index.js","name":"eslint-plugin-jsdoc","peerDependencies":{"eslint":">=0.8.0"},"repository":{"type":"git","url":"https://github.com/gajus/eslint-plugin-jsdoc"},"scripts":{"add-assertions":"babel-node --presets es2015 ./bin/readme-assertions","build":"NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps","generate-readme":"gitdown ./.README/README.md --output-file ./README.md && npm run add-assertions","lint":"eslint ./src ./test","test":"mocha --recursive --compilers js:babel-register"},"version":"3.3.1"}
+{"author":{"email":"[e-mail]","name":"Gajus Kuizinas","url":"http://gajus.com"},"dependencies":{"comment-parser":"^0.4.2","lodash":"^4.17.4"},"description":"JSDoc linting rules for ESLint.","devDependencies":{"babel-cli":"^6.26.0","babel-plugin-add-module-exports":"^0.2.1","babel-plugin-transform-flow-strip-types":"^6.22.0","babel-preset-env":"^1.6.0","babel-preset-es2015":"^6.24.1","babel-register":"^6.26.0","chai":"^4.1.2","eslint":"^4.7.2","eslint-config-canonical":"^9.3.1","gitdown":"^2.5.1","globby":"^6.1.0","mocha":"^3.5.3","semantic-release":"^8.0.3"},"engines":{"node":">=4"},"keywords":["eslint","plugin","jsdoc"],"license":"BSD-3-Clause","main":"./dist/index.js","name":"eslint-plugin-jsdoc","peerDependencies":{"eslint":">=0.8.0"},"repository":{"type":"git","url":"https://github.com/gajus/eslint-plugin-jsdoc"},"scripts":{"add-assertions":"babel-node --presets es2015 ./bin/readme-assertions","build":"NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps","generate-readme":"gitdown ./.README/README.md --output-file ./README.md && npm run add-assertions","lint":"eslint ./src ./test","test":"mocha --recursive --compilers js:babel-register"},"version":"3.4.0"}

No alert changes

Improved metrics

Total package byte prevSize

110289

0.26%

Lines of code

852

0.47%

No dependency changes