eslint-plugin-jsdoc - npm Package Compare versions

Comparing version 2.1.4 to 2.2.0

dist/iterateJsdoc.js

@@ -7,2 +7,6 @@ 'use strict';
 
+var _get = require('lodash/object/get');
+
+var _get2 = _interopRequireDefault(_get);
+
 var _commentParser = require('comment-parser');
@@ -12,14 +16,53 @@
 
+var _jsdocUtils = require('./jsdocUtils');
+
+var _jsdocUtils2 = _interopRequireDefault(_jsdocUtils);
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+var curryUtils = undefined;
+
+curryUtils = function (functionNode, jsdoc, tagNamePreference) {
+    var utils = undefined;
+
+    utils = {};
+
+    utils.getFunctionParameterNames = function () {
+        return _jsdocUtils2.default.getFunctionParameterNames(functionNode);
+    };
+
+    utils.getJsdocParameterNamesDeep = function () {
+        return _jsdocUtils2.default.getJsdocParameterNamesDeep(jsdoc, utils.getPreferredTagName('param'));
+    };
+
+    utils.getJsdocParameterNames = function () {
+        return _jsdocUtils2.default.getJsdocParameterNames(jsdoc, utils.getPreferredTagName('param'));
+    };
+
+    utils.getPreferredTagName = function (name) {
+        return _jsdocUtils2.default.getPreferredTagName(name, tagNamePreference);
+    };
+
+    utils.isValidTag = function (name) {
+        return _jsdocUtils2.default.isValidTag(name);
+    };
+
+    return utils;
+};
+
 exports.default = function (iterator) {
     return function (context) {
         var checkJsdoc = undefined,
-            sourceCode = undefined;
+            sourceCode = undefined,
+            tagNamePreference = undefined;
 
         sourceCode = context.getSourceCode();
 
+        tagNamePreference = (0, _get2.default)(context, 'settings.jsdoc.tagNamePreference') || {};
+
         checkJsdoc = function (functionNode) {
             var jsdoc = undefined,
-                jsdocNode = undefined;
+                jsdocNode = undefined,
+                report = undefined,
+                utils = undefined;
 
@@ -34,5 +77,16 @@ jsdocNode = sourceCode.getJSDocComment(functionNode);
 
-            iterator(functionNode, jsdocNode, jsdoc, function (message) {
+            report = function (message) {
                 context.report(jsdocNode, message);
-            }, context);
+            };
+
+            utils = curryUtils(functionNode, jsdoc, tagNamePreference);
+
+            iterator({
+                context: context,
+                functionNode: functionNode,
+                jsdoc: jsdoc,
+                jsdocNode: jsdocNode,
+                report: report,
+                utils: utils
+            });
         };
@@ -39,0 +93,0 @@

dist/jsdocUtils.js

@@ -7,2 +7,22 @@ 'use strict';
 
+var _flatten = require('lodash/array/flatten');
+
+var _flatten2 = _interopRequireDefault(_flatten);
+
+var _keys = require('lodash/object/keys');
+
+var _keys2 = _interopRequireDefault(_keys);
+
+var _findKey = require('lodash/object/findKey');
+
+var _findKey2 = _interopRequireDefault(_findKey);
+
+var _values = require('lodash/object/values');
+
+var _values2 = _interopRequireDefault(_values);
+
+var _includes = require('lodash/collection/includes');
+
+var _includes2 = _interopRequireDefault(_includes);
+
 var _filter = require('lodash/collection/filter');
@@ -20,2 +40,6 @@
 
+var _tagNames = require('./tagNames');
+
+var _tagNames2 = _interopRequireDefault(_tagNames);
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -25,3 +49,5 @@
     getJsdocParameterNames = undefined,
-    getJsdocParameterNamesDeep = undefined;
+    getJsdocParameterNamesDeep = undefined,
+    getPreferredTagName = undefined,
+    isValidTag = undefined;
 
@@ -42,7 +68,10 @@ getFunctionParameterNames = function (functionNode) {
 
-getJsdocParameterNamesDeep = function (jsdoc) {
+/**
+ * Gets all parameter names, including those that refer to a path, e.g. "@param foo; @param foo.bar".
+ */
+getJsdocParameterNamesDeep = function (jsdoc, targetTagName) {
     var jsdocParameterNames = undefined;
 
     jsdocParameterNames = (0, _filter2.default)(jsdoc.tags, {
-        tag: 'param'
+        tag: targetTagName
     });
@@ -55,6 +84,6 @@
 
-getJsdocParameterNames = function (jsdoc) {
+getJsdocParameterNames = function (jsdoc, targetTagName) {
     var jsdocParameterNames = undefined;
 
-    jsdocParameterNames = getJsdocParameterNamesDeep(jsdoc);
+    jsdocParameterNames = getJsdocParameterNamesDeep(jsdoc, targetTagName);
 
@@ -68,8 +97,38 @@ jsdocParameterNames = (0, _filter2.default)(jsdocParameterNames, function (name) {
 
+getPreferredTagName = function (name) {
+    var tagPreference = arguments.length <= 1 || arguments[1] === undefined ? {} : arguments[1];
+
+    var preferredTagName = undefined;
+
+    if ((0, _includes2.default)((0, _values2.default)(tagPreference), name)) {
+        return name;
+    }
+
+    preferredTagName = (0, _findKey2.default)(_tagNames2.default, function (aliases) {
+        return (0, _includes2.default)(aliases, name);
+    });
+
+    if (preferredTagName) {
+        return preferredTagName;
+    }
+
+    return (0, _has2.default)(tagPreference, name) ? tagPreference[name] : name;
+};
+
+isValidTag = function (name) {
+    var validTagNames = undefined;
+
+    validTagNames = (0, _keys2.default)(_tagNames2.default).concat((0, _flatten2.default)((0, _values2.default)(_tagNames2.default)));
+
+    return (0, _includes2.default)(validTagNames, name);
+};
+
 exports.default = {
     getFunctionParameterNames: getFunctionParameterNames,
     getJsdocParameterNames: getJsdocParameterNames,
-    getJsdocParameterNamesDeep: getJsdocParameterNamesDeep
+    getJsdocParameterNamesDeep: getJsdocParameterNamesDeep,
+    getPreferredTagName: getPreferredTagName,
+    isValidTag: isValidTag
 };
 module.exports = exports['default'];
 //# sourceMappingURL=jsdocUtils.js.map

dist/rules/checkParamNames.js

@@ -15,6 +15,2 @@ 'use strict';
 
-var _jsdocUtils = require('./../jsdocUtils');
-
-var _jsdocUtils2 = _interopRequireDefault(_jsdocUtils);
-
 var _iterateJsdoc = require('./../iterateJsdoc');
@@ -29,7 +25,3 @@
 
-validateParameterNames = function (functionParameterNames, jsdoc, report) {
-    var jsdocParameterNames = undefined;
-
-    jsdocParameterNames = _jsdocUtils2.default.getJsdocParameterNames(jsdoc);
-
+validateParameterNames = function (targetTagName, functionParameterNames, jsdocParameterNames, report) {
     return (0, _some2.default)(jsdocParameterNames, function (jsdocParameterName, index) {
@@ -41,3 +33,3 @@ var functionParameterName = undefined;
         if (!functionParameterName) {
-            report('@param "' + jsdocParameterName + '" does not match an existing function parameter.');
+            report('@' + targetTagName + ' "' + jsdocParameterName + '" does not match an existing function parameter.');
 
@@ -48,3 +40,3 @@ return true;
         if (functionParameterName !== jsdocParameterName) {
-            report('Expected @param names to be "' + functionParameterNames.join(', ') + '". Got "' + jsdocParameterNames.join(', ') + '".');
+            report('Expected @' + targetTagName + ' names to be "' + functionParameterNames.join(', ') + '". Got "' + jsdocParameterNames.join(', ') + '".');
 
@@ -56,9 +48,6 @@ return true;
 
-validateParameterNamesDeep = function (functionParameterNames, jsdoc, report) {
-    var jsdocParameterNamesDeep = undefined,
-        lastRealParameter = undefined;
+validateParameterNamesDeep = function (targetTagName, jsdocParameterNames, report) {
+    var lastRealParameter = undefined;
 
-    jsdocParameterNamesDeep = _jsdocUtils2.default.getJsdocParameterNamesDeep(jsdoc);
-
-    return (0, _some2.default)(jsdocParameterNamesDeep, function (jsdocParameterName) {
+    return (0, _some2.default)(jsdocParameterNames, function (jsdocParameterName) {
         var isPropertyPath = undefined;
@@ -72,3 +61,3 @@
             if (!lastRealParameter) {
-                report('@param path declaration ("' + jsdocParameterName + '") appears before any real parameter.');
+                report('@' + targetTagName + ' path declaration ("' + jsdocParameterName + '") appears before any real parameter.');
 
@@ -81,3 +70,3 @@ return true;
             if (pathRootNodeName !== lastRealParameter) {
-                report('@param path declaration ("' + jsdocParameterName + '") root node name ("' + pathRootNodeName + '") does not match previous real parameter name ("' + lastRealParameter + '").');
+                report('@' + targetTagName + ' path declaration ("' + jsdocParameterName + '") root node name ("' + pathRootNodeName + '") does not match previous real parameter name ("' + lastRealParameter + '").');
 
@@ -92,9 +81,18 @@ return true;
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var report = _ref.report;
+    var utils = _ref.utils;
+
     var functionParameterNames = undefined,
-        isError = undefined;
+        isError = undefined,
+        jsdocParameterNames = undefined,
+        jsdocParameterNamesDeep = undefined,
+        targetTagName = undefined;
 
-    functionParameterNames = _jsdocUtils2.default.getFunctionParameterNames(functionNode);
+    functionParameterNames = utils.getFunctionParameterNames();
+    jsdocParameterNames = utils.getJsdocParameterNames();
+    jsdocParameterNamesDeep = utils.getJsdocParameterNamesDeep();
+    targetTagName = utils.getPreferredTagName('param');
 
-    isError = validateParameterNames(functionParameterNames, jsdoc, report);
+    isError = validateParameterNames(targetTagName, functionParameterNames, jsdocParameterNames, report);
 
@@ -105,5 +103,5 @@ if (isError) {
 
-    validateParameterNamesDeep(functionParameterNames, jsdoc, report);
+    validateParameterNamesDeep(targetTagName, jsdocParameterNamesDeep, report);
 });
 module.exports = exports['default'];
 //# sourceMappingURL=checkParamNames.js.map

dist/rules/checkTagNames.js

@@ -7,6 +7,2 @@ 'use strict';
 
-var _includes = require('lodash/collection/includes');
-
-var _includes2 = _interopRequireDefault(_includes);
-
 var _forEach = require('lodash/collection/forEach');
@@ -22,9 +18,17 @@
 
-var validTags = undefined;
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var jsdoc = _ref.jsdoc;
+    var report = _ref.report;
+    var utils = _ref.utils;
 
-validTags = ['abstract', 'access', 'alias', 'augments', 'author', 'borrows', 'callback', 'class', 'classdesc', 'constant', 'constructs', 'copyright', 'default', 'deprecated', 'description', 'enum', 'event', 'example', 'exports', 'external', 'file', 'fires', 'function', 'global', 'ignore', 'implements', 'inheritdoc', 'inner', 'instance', 'interface', 'kind', 'lends', 'license', 'listens', 'member', 'memberof', 'mixes', 'mixin', 'module', 'name', 'namespace', 'override', 'param', 'private', 'property', 'protected', 'public', 'readonly', 'requires', 'returns', 'see', 'since', 'static', 'summary', 'this', 'throws', 'todo', 'tutorial', 'type', 'typedef', 'variation', 'version'];
+    (0, _forEach2.default)(jsdoc.tags, function (jsdocTag) {
+        if (utils.isValidTag(jsdocTag.tag)) {
+            var preferredTagName = undefined;
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
-    (0, _forEach2.default)(jsdoc.tags, function (jsdocTag) {
-        if (!(0, _includes2.default)(validTags, jsdocTag.tag)) {
+            preferredTagName = utils.getPreferredTagName(jsdocTag.tag);
+
+            if (preferredTagName !== jsdocTag.tag) {
+                report('Invalid JSDoc tag (preference). Replace "' + jsdocTag.tag + '" JSDoc tag with "' + preferredTagName + '".');
+            }
+        } else {
             report('Invalid JSDoc tag name "' + jsdocTag.tag + '".');
@@ -31,0 +35,0 @@ }

dist/rules/checkTypes.js

@@ -30,2 +30,3 @@ 'use strict';
 var strictNativeTypes = undefined,
+    targetTagAliases = undefined,
     targetTags = undefined;
@@ -35,5 +36,12 @@
 
+targetTagAliases = ['constructor', 'const', 'var', 'arg', 'argument', 'prop', 'return', 'exception'];
+
+targetTags = targetTags.concat(targetTagAliases);
+
 strictNativeTypes = ['boolean', 'number', 'string', 'Array', 'Object', 'RegExp', 'Date', 'Function'];
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var jsdoc = _ref.jsdoc;
+    var report = _ref.report;
+
     var jsdocTags = undefined;
@@ -40,0 +48,0 @@

dist/rules/newlineAfterDescription.js

@@ -21,3 +21,7 @@ 'use strict';
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report, context) {
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var jsdoc = _ref.jsdoc;
+    var report = _ref.report;
+    var context = _ref.context;
+
     var always = undefined,
@@ -24,0 +28,0 @@ descriptionEndsWithANewline = undefined;

dist/rules/requireDescriptionCompleteSentence.js

@@ -90,3 +90,6 @@ 'use strict';
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var jsdoc = _ref.jsdoc;
+    var report = _ref.report;
+
     var tags = undefined;
@@ -93,0 +96,0 @@

dist/rules/requireHyphenBeforeDescription.js

@@ -25,3 +25,6 @@ 'use strict';
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var jsdoc = _ref.jsdoc;
+    var report = _ref.report;
+
     var jsdocTags = undefined;
@@ -28,0 +31,0 @@

dist/rules/requireParam.js

@@ -11,10 +11,2 @@ 'use strict';
 
-var _map = require('lodash/collection/map');
-
-var _map2 = _interopRequireDefault(_map);
-
-var _jsdocUtils = require('./../jsdocUtils');
-
-var _jsdocUtils2 = _interopRequireDefault(_jsdocUtils);
-
 var _iterateJsdoc = require('./../iterateJsdoc');
@@ -26,8 +18,11 @@
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var report = _ref.report;
+    var utils = _ref.utils;
+
     var functionParameterNames = undefined,
         jsdocParameterNames = undefined;
 
-    functionParameterNames = (0, _map2.default)(functionNode.params, 'name');
-    jsdocParameterNames = _jsdocUtils2.default.getJsdocParameterNames(jsdoc);
+    functionParameterNames = utils.getFunctionParameterNames();
+    jsdocParameterNames = utils.getJsdocParameterNames();
 
@@ -40,3 +35,3 @@ (0, _some2.default)(functionParameterNames, function (functionParameterName, index) {
         if (!jsdocParameterName) {
-            report('Missing JSDoc @param "' + functionParameterName + '" declaration.');
+            report('Missing JSDoc @' + utils.getPreferredTagName('param') + ' "' + functionParameterName + '" declaration.');
 
@@ -43,0 +38,0 @@ return true;

dist/rules/requireParamDescription.js

@@ -21,7 +21,14 @@ 'use strict';
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
-    var jsdocParameters = undefined;
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var jsdoc = _ref.jsdoc;
+    var report = _ref.report;
+    var utils = _ref.utils;
 
+    var jsdocParameters = undefined,
+        targetTagName = undefined;
+
+    targetTagName = utils.getPreferredTagName('param');
+
     jsdocParameters = (0, _filter2.default)(jsdoc.tags, {
-        tag: 'param'
+        tag: targetTagName
     });
@@ -31,3 +38,3 @@
         if (!jsdocParameter.description) {
-            report('Missing JSDoc @param "' + jsdocParameter.name + '" description.');
+            report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" description.');
         }
@@ -34,0 +41,0 @@ });

dist/rules/requireParamType.js

@@ -21,7 +21,14 @@ 'use strict';
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
-    var jsdocParameters = undefined;
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var jsdoc = _ref.jsdoc;
+    var report = _ref.report;
+    var utils = _ref.utils;
 
+    var jsdocParameters = undefined,
+        targetTagName = undefined;
+
+    targetTagName = utils.getPreferredTagName('param');
+
     jsdocParameters = (0, _filter2.default)(jsdoc.tags, {
-        tag: 'param'
+        tag: targetTagName
     });
@@ -31,3 +38,3 @@
         if (!jsdocParameter.type) {
-            report('Missing JSDoc @param "' + jsdocParameter.name + '" type.');
+            report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" type.');
         }
@@ -34,0 +41,0 @@ });

dist/rules/requireReturnsDescription.js

@@ -21,7 +21,14 @@ 'use strict';
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
-    var jsdocTags = undefined;
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var jsdoc = _ref.jsdoc;
+    var report = _ref.report;
+    var utils = _ref.utils;
 
+    var jsdocTags = undefined,
+        targetTagName = undefined;
+
+    targetTagName = utils.getPreferredTagName('returns');
+
     jsdocTags = (0, _filter2.default)(jsdoc.tags, {
-        tag: 'returns'
+        tag: targetTagName
     });
@@ -36,3 +43,3 @@
         if (!description) {
-            report('Missing JSDoc @returns description.');
+            report('Missing JSDoc @' + targetTagName + ' description.');
         }
@@ -39,0 +46,0 @@ });

dist/rules/requireReturnsType.js

@@ -21,7 +21,14 @@ 'use strict';
 
-exports.default = (0, _iterateJsdoc2.default)(function (functionNode, jsdocNode, jsdoc, report) {
-    var jsdocTags = undefined;
+exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
+    var jsdoc = _ref.jsdoc;
+    var report = _ref.report;
+    var utils = _ref.utils;
 
+    var jsdocTags = undefined,
+        targetTagName = undefined;
+
+    targetTagName = utils.getPreferredTagName('returns');
+
     jsdocTags = (0, _filter2.default)(jsdoc.tags, {
-        tag: 'returns'
+        tag: targetTagName
     });
@@ -31,3 +38,3 @@
         if (!jsdocTag.type) {
-            report('Missing JSDoc @returns type.');
+            report('Missing JSDoc @' + targetTagName + ' type.');
         }
@@ -34,0 +41,0 @@ });

package.json

 {
   "name": "eslint-plugin-jsdoc",
   "description": "JSDoc linting rules for ESLint.",
-  "version": "2.1.4",
+  "version": "2.2.0",
   "main": "./dist/index.js",
@@ -43,2 +43,3 @@ "repository": {
     "babel-preset-es2015": "^6.3.13",
+    "chai": "^3.4.1",
     "eslint": "^1.10.3",
@@ -48,4 +49,4 @@ "gitdown": "^2.4.0",
     "mocha": "^2.3.4",
-    "pragmatist": "^2.3.9"
+    "pragmatist": "^2.3.13"
   }
 }

README.md

 <h1 id="eslint-plugin-jsdoc">eslint-plugin-jsdoc</h1>
 
-[![NPM version](http://img.shields.io/npm/v/eslint-plugin-jsdoc.svg?style=flat)](https://www.npmjs.org/package/eslint-plugin-jsdoc)
-[![Travis build status](http://img.shields.io/travis/gajus/eslint-plugin-jsdoc/master.svg?style=flat)](https://travis-ci.org/gajus/eslint-plugin-jsdoc)
+[![NPM version](http://img.shields.io/npm/v/eslint-plugin-jsdoc.svg?style=flat-square)](https://www.npmjs.org/package/eslint-plugin-jsdoc)
+[![Travis build status](http://img.shields.io/travis/gajus/eslint-plugin-jsdoc/master.svg?style=flat-square)](https://travis-ci.org/gajus/eslint-plugin-jsdoc)
 
@@ -12,2 +12,4 @@ JSDoc linting rules for ESLint.
     * [Configuration](#eslint-plugin-jsdoc-configuration)
+    * [Settings](#eslint-plugin-jsdoc-settings)
+        * [Alias Preference](#eslint-plugin-jsdoc-settings-alias-preference)
     * [Rules](#eslint-plugin-jsdoc-rules)
@@ -97,2 +99,22 @@ * [`check-param-names`](#eslint-plugin-jsdoc-rules-check-param-names)
 
+<h2 id="eslint-plugin-jsdoc-settings">Settings</h2>
+
+<h3 id="eslint-plugin-jsdoc-settings-alias-preference">Alias Preference</h3>
+
+Use `settings.jsdoc.tagNamePreference` to configure a preferred alias name for a JSDoc tag. The format of the configuration is: `<primary tag name>: <preferred alias name>`, e.g.
+
+```json
+{
+    "rules": {},
+    "settings": {
+        "jsdoc": {
+            "tagNamePreference": {
+                "param": "arg",
+                "returns": "return"
+            }
+        }
+    }
+}
+```
+
 <h2 id="eslint-plugin-jsdoc-rules">Rules</h2>
@@ -104,2 +126,3 @@
 
+|||
 |---|---|
@@ -115,2 +138,16 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
  */
+function quux (foo = 'FOO') {
+
+}
+
+/**
+ * @arg Foo
+ */
+function quux (foo = 'FOO') {
+
+}
+
+/**
+ * @param Foo
+ */
 function quux (foo) {
@@ -268,2 +305,3 @@
 
+|||
 |---|---|
@@ -289,2 +327,16 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 }
+
+/**
+ * @arg foo
+ */
+function quux (foo) {
+
+}
+
+/**
+ * @param foo
+ */
+function quux (foo) {
+
+}
 ```
@@ -301,2 +353,9 @@
 }
+
+/**
+ * @arg foo
+ */
+function quux (foo) {
+
+}
 ```
@@ -321,5 +380,6 @@
 
+|||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
-|Tags|`class`, `constant`, `enum`, `member`, `module`, `namespace`, `param`, `property`, `returns`, `throws`, `type`, `typede`|
+|Tags|`class`, `constant`, `enum`, `member`, `module`, `namespace`, `param`, `property`, `returns`, `throws`, `type`, `typedef`|
 
@@ -335,2 +395,9 @@ The following patterns are considered problems:
 }
+
+/**
+ * @arg {Number} foo
+ */
+function quux (foo) {
+
+}
 ```
@@ -349,2 +416,11 @@
 }
+
+/**
+ * @arg {number} foo
+ * @arg {Bar} bar
+ * @arg {*} baz
+ */
+function quux (foo, bar, baz) {
+
+}
 ```
@@ -359,2 +435,3 @@
 
+|||
 |---|---|
@@ -434,2 +511,3 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 
+|||
 |---|---|
@@ -472,2 +550,20 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 }
+
+/**
+ * Foo.
+ *
+ * @param foo foo.
+ */
+function quux (foo) {
+
+}
+
+/**
+ * Foo.
+ *
+ * @returns foo.
+ */
+function quux (foo) {
+
+}
 ```
@@ -479,2 +575,9 @@
 /**
+ * @param foo - Foo.
+ */
+function quux () {
+
+}
+
+/**
  * Foo.
@@ -517,2 +620,3 @@ */
 
+|||
 |---|---|
@@ -531,2 +635,9 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 }
+
+/**
+ * @arg foo
+ */
+function quux (foo) {
+
+}
 ```
@@ -557,2 +668,3 @@
 
+|||
 |---|---|
@@ -573,2 +685,9 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 /**
+ *
+ */
+function quux (foo) {
+
+}
+
+/**
  * @param foo
@@ -590,2 +709,9 @@ */
 }
+
+/**
+ * @arg foo
+ */
+function quux (foo) {
+
+}
 ```
@@ -598,2 +724,3 @@
 
+|||
 |---|---|
@@ -612,2 +739,9 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 }
+
+/**
+ * @arg foo
+ */
+function quux (foo) {
+
+}
 ```
@@ -638,2 +772,3 @@
 
+|||
 |---|---|
@@ -652,2 +787,9 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 }
+
+/**
+ * @arg foo
+ */
+function quux (foo) {
+
+}
 ```
@@ -678,2 +820,3 @@
 
+|||
 |---|---|
@@ -692,2 +835,9 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 }
+
+/**
+ * @return
+ */
+function quux (foo) {
+
+}
 ```
@@ -718,2 +868,3 @@
 
+|||
 |---|---|
@@ -739,2 +890,9 @@ |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 }
+
+/**
+ * @return Foo.
+ */
+function quux () {
+
+}
 ```
@@ -741,0 +899,0 @@

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

85751

increased by20.13%

Number of package files

34

increased by6.25%

Lines of code

775

increased by30.47%

Number of lines in readme file

885

increased by21.73%

Worsened metrics

Dev dependency count

8

increased by14.29%

No dependency changes