eslint-plugin-jsdoc 39.4.0 → 39.5.1

package/README.md

@@ -72,6 +72,7 @@ JSDoc linting rules for ESLint.
         * [`require-yields-check`](#user-content-eslint-plugin-jsdoc-rules-require-yields-check)
         * [`sort-tags`](#user-content-eslint-plugin-jsdoc-rules-sort-tags)
         * [`tag-lines`](#user-content-eslint-plugin-jsdoc-rules-tag-lines)
+        * [`text-escaping`](#user-content-eslint-plugin-jsdoc-rules-text-escaping)
         * [`valid-types`](#user-content-eslint-plugin-jsdoc-rules-valid-types)
 
 
@@ -18320,6 +18321,22 @@ function maybeTrue() {
     return true;
   }
 }
+
+/**
+ * @param {AST} astNode
+ * @returns {AST}
+ */
+const getTSFunctionComment = function (astNode) {
+  switch (greatGrandparent.type) {
+  case 'VariableDeclarator':
+    if (greatGreatGrandparent.type === 'VariableDeclaration') {
+      return greatGreatGrandparent;
+    }
+
+  default:
+    return astNode;
+  }
+};
 ````
 
 
@@ -22100,6 +22117,155 @@ The following patterns are not considered problems:
 ````
 
 
+<a name="user-content-eslint-plugin-jsdoc-rules-text-escaping"></a>
+<a name="eslint-plugin-jsdoc-rules-text-escaping"></a>
+### <code>text-escaping</code>
+
+This rule can auto-escape certain characters that are input within block and
+tag descriptions.
+
+This rule may be desirable if your text is known not to contain HTML or
+Markdown and you therefore do not wish for it to be accidentally interpreted
+as such by the likes of Visual Studio Code or if you wish to view it escaped
+within it or your documentation.
+
+<a name="user-content-eslint-plugin-jsdoc-rules-text-escaping-options-42"></a>
+<a name="eslint-plugin-jsdoc-rules-text-escaping-options-42"></a>
+#### Options
+
+<a name="user-content-eslint-plugin-jsdoc-rules-text-escaping-options-42-escapehtml"></a>
+<a name="eslint-plugin-jsdoc-rules-text-escaping-options-42-escapehtml"></a>
+##### <code>escapeHTML</code>
+
+This option escapes all `<` and `&` characters (except those followed by
+whitespace which are treated as literals by Visual Studio Code).
+
+<a name="user-content-eslint-plugin-jsdoc-rules-text-escaping-options-42-escapemarkdown"></a>
+<a name="eslint-plugin-jsdoc-rules-text-escaping-options-42-escapemarkdown"></a>
+##### <code>escapeMarkdown</code>
+
+This option escapes the first backtick (`` ` ``) in a paired sequence.
+
+|||
+|---|---|
+|Context|everywhere|
+|Tags|``|
+|Recommended|false|
+|Settings||
+|Options||
+
+The following patterns are considered problems:
+
+````js
+/**
+ * Some things to escape: <a> and &gt; and `test`
+ */
+// Message: You must include either `escapeHTML` or `escapeMarkdown`
+
+/**
+ * Some things to escape: <a> and &gt; and &#xabc; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
+// Message: You have unescaped HTML characters < or &
+
+/**
+ * Some things to escape: <a> and &gt; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
+// Message: You have unescaped Markdown backtick sequences
+
+/**
+ * Some things to escape:
+ * <a> and &gt; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
+// Message: You have unescaped HTML characters < or &
+
+/**
+ * Some things to escape:
+ * <a> and &gt; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
+// Message: You have unescaped Markdown backtick sequences
+
+/**
+ * @param {SomeType} aName Some things to escape: <a> and &gt; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
+// Message: You have unescaped HTML characters < or & in a tag
+
+/**
+ * @param {SomeType} aName Some things to escape: <a> and &gt; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
+// Message: You have unescaped Markdown backtick sequences in a tag
+
+/**
+ * @param {SomeType} aName Some things to escape:
+ * <a> and &gt; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
+// Message: You have unescaped HTML characters < or & in a tag
+
+/**
+ * @param {SomeType} aName Some things to escape:
+ * <a> and &gt; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
+// Message: You have unescaped Markdown backtick sequences in a tag
+````
+
+The following patterns are not considered problems:
+
+````js
+/**
+ * Some things to escape: &lt;a> and &gt; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
+
+/**
+ * Some things to escape: <a> and &gt; and \`test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
+
+/**
+ * Some things to escape: < and &
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
+
+/**
+ * Some things to escape: `
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
+
+/**
+ * @param {SomeType} aName Some things to escape: &lt;a> and &gt; and `test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
+
+/**
+ * @param {SomeType} aName Some things to escape: <a> and &gt; and \`test`
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
+
+/**
+ * @param {SomeType} aName Some things to escape: < and &
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
+
+/**
+ * @param {SomeType} aName Some things to escape: `
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
+
+/**
+ * Nothing
+ * to escape
+ */
+// "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
+````
+
+
 <a name="user-content-eslint-plugin-jsdoc-rules-valid-types"></a>
 <a name="eslint-plugin-jsdoc-rules-valid-types"></a>
 ### <code>valid-types</code>
@@ -22181,8 +22347,8 @@ for valid types (based on the tag's `type` value), and either portion checked
 for presence (based on `false` `name` or `type` values or their `required`
 value). See the setting for more details.
 
-<a name="user-content-eslint-plugin-jsdoc-rules-valid-types-options-42"></a>
-<a name="eslint-plugin-jsdoc-rules-valid-types-options-42"></a>
+<a name="user-content-eslint-plugin-jsdoc-rules-valid-types-options-43"></a>
+<a name="eslint-plugin-jsdoc-rules-valid-types-options-43"></a>
 #### Options
 
 - `allowEmptyNamepaths` (default: true) - Set to `false` to bulk disallow

package/dist/index.js

@@ -52,6 +52,7 @@ var _requireYields = _interopRequireDefault(require("./rules/requireYields"));
 var _requireYieldsCheck = _interopRequireDefault(require("./rules/requireYieldsCheck"));
 var _sortTags = _interopRequireDefault(require("./rules/sortTags"));
 var _tagLines = _interopRequireDefault(require("./rules/tagLines"));
+var _textEscaping = _interopRequireDefault(require("./rules/textEscaping"));
 var _validTypes = _interopRequireDefault(require("./rules/validTypes"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 var _default = {
@@ -107,6 +108,7 @@ var _default = {
         'jsdoc/require-yields-check': 'warn',
         'jsdoc/sort-tags': 'off',
         'jsdoc/tag-lines': 'warn',
+        'jsdoc/text-escaping': 'off',
         'jsdoc/valid-types': 'warn'
       }
     }
@@ -160,6 +162,7 @@ var _default = {
     'require-yields-check': _requireYieldsCheck.default,
     'sort-tags': _sortTags.default,
     'tag-lines': _tagLines.default,
+    'text-escaping': _textEscaping.default,
     'valid-types': _validTypes.default
   }
 };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["configs","recommended","plugins","rules","checkAccess","checkAlignment","checkExamples","checkIndentation","checkLineAlignment","checkParamNames","checkPropertyNames","checkSyntax","checkTagNames","checkTypes","checkValues","emptyTags","implementsOnClasses","matchDescription","matchName","multilineBlocks","newlineAfterDescription","noBadBlocks","noDefaults","noMissingSyntax","noMultiAsterisks","noRestrictedSyntax","noTypes","noUndefinedTypes","requireAsteriskPrefix","requireDescription","requireDescriptionCompleteSentence","requireExample","requireFileOverview","requireHyphenBeforeParamDescription","requireJsdoc","requireParam","requireParamDescription","requireParamName","requireParamType","requireProperty","requirePropertyDescription","requirePropertyName","requirePropertyType","requireReturns","requireReturnsCheck","requireReturnsDescription","requireReturnsType","requireThrows","requireYields","requireYieldsCheck","sortTags","tagLines","validTypes"],"sources":["../src/index.js"],"sourcesContent":["import checkAccess from './rules/checkAccess';\nimport checkAlignment from './rules/checkAlignment';\nimport checkExamples from './rules/checkExamples';\nimport checkIndentation from './rules/checkIndentation';\nimport checkLineAlignment from './rules/checkLineAlignment';\nimport checkParamNames from './rules/checkParamNames';\nimport checkPropertyNames from './rules/checkPropertyNames';\nimport checkSyntax from './rules/checkSyntax';\nimport checkTagNames from './rules/checkTagNames';\nimport checkTypes from './rules/checkTypes';\nimport checkValues from './rules/checkValues';\nimport emptyTags from './rules/emptyTags';\nimport implementsOnClasses from './rules/implementsOnClasses';\nimport matchDescription from './rules/matchDescription';\nimport matchName from './rules/matchName';\nimport multilineBlocks from './rules/multilineBlocks';\nimport newlineAfterDescription from './rules/newlineAfterDescription';\nimport noBadBlocks from './rules/noBadBlocks';\nimport noDefaults from './rules/noDefaults';\nimport noMissingSyntax from './rules/noMissingSyntax';\nimport noMultiAsterisks from './rules/noMultiAsterisks';\nimport noRestrictedSyntax from './rules/noRestrictedSyntax';\nimport noTypes from './rules/noTypes';\nimport noUndefinedTypes from './rules/noUndefinedTypes';\nimport requireAsteriskPrefix from './rules/requireAsteriskPrefix';\nimport requireDescription from './rules/requireDescription';\nimport requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence';\nimport requireExample from './rules/requireExample';\nimport requireFileOverview from './rules/requireFileOverview';\nimport requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription';\nimport requireJsdoc from './rules/requireJsdoc';\nimport requireParam from './rules/requireParam';\nimport requireParamDescription from './rules/requireParamDescription';\nimport requireParamName from './rules/requireParamName';\nimport requireParamType from './rules/requireParamType';\nimport requireProperty from './rules/requireProperty';\nimport requirePropertyDescription from './rules/requirePropertyDescription';\nimport requirePropertyName from './rules/requirePropertyName';\nimport requirePropertyType from './rules/requirePropertyType';\nimport requireReturns from './rules/requireReturns';\nimport requireReturnsCheck from './rules/requireReturnsCheck';\nimport requireReturnsDescription from './rules/requireReturnsDescription';\nimport requireReturnsType from './rules/requireReturnsType';\nimport requireThrows from './rules/requireThrows';\nimport requireYields from './rules/requireYields';\nimport requireYieldsCheck from './rules/requireYieldsCheck';\nimport sortTags from './rules/sortTags';\nimport tagLines from './rules/tagLines';\nimport validTypes from './rules/validTypes';\n\nexport default {\n  configs: {\n    recommended: {\n      plugins: [\n        'jsdoc',\n      ],\n      rules: {\n        'jsdoc/check-access': 'warn',\n        'jsdoc/check-alignment': 'warn',\n        'jsdoc/check-examples': 'off',\n        'jsdoc/check-indentation': 'off',\n        'jsdoc/check-line-alignment': 'off',\n        'jsdoc/check-param-names': 'warn',\n        'jsdoc/check-property-names': 'warn',\n        'jsdoc/check-syntax': 'off',\n        'jsdoc/check-tag-names': 'warn',\n        'jsdoc/check-types': 'warn',\n        'jsdoc/check-values': 'warn',\n        'jsdoc/empty-tags': 'warn',\n        'jsdoc/implements-on-classes': 'warn',\n        'jsdoc/match-description': 'off',\n        'jsdoc/match-name': 'off',\n        'jsdoc/multiline-blocks': 'warn',\n        'jsdoc/newline-after-description': 'warn',\n        'jsdoc/no-bad-blocks': 'off',\n        'jsdoc/no-defaults': 'off',\n        'jsdoc/no-missing-syntax': 'off',\n        'jsdoc/no-multi-asterisks': 'warn',\n        'jsdoc/no-restricted-syntax': 'off',\n        'jsdoc/no-types': 'off',\n        'jsdoc/no-undefined-types': 'warn',\n        'jsdoc/require-asterisk-prefix': 'off',\n        'jsdoc/require-description': 'off',\n        'jsdoc/require-description-complete-sentence': 'off',\n        'jsdoc/require-example': 'off',\n        'jsdoc/require-file-overview': 'off',\n        'jsdoc/require-hyphen-before-param-description': 'off',\n        'jsdoc/require-jsdoc': 'warn',\n        'jsdoc/require-param': 'warn',\n        'jsdoc/require-param-description': 'warn',\n        'jsdoc/require-param-name': 'warn',\n        'jsdoc/require-param-type': 'warn',\n        'jsdoc/require-property': 'warn',\n        'jsdoc/require-property-description': 'warn',\n        'jsdoc/require-property-name': 'warn',\n        'jsdoc/require-property-type': 'warn',\n        'jsdoc/require-returns': 'warn',\n        'jsdoc/require-returns-check': 'warn',\n        'jsdoc/require-returns-description': 'warn',\n        'jsdoc/require-returns-type': 'warn',\n        'jsdoc/require-throws': 'off',\n        'jsdoc/require-yields': 'warn',\n        'jsdoc/require-yields-check': 'warn',\n        'jsdoc/sort-tags': 'off',\n        'jsdoc/tag-lines': 'warn',\n        'jsdoc/valid-types': 'warn',\n      },\n    },\n  },\n  rules: {\n    'check-access': checkAccess,\n    'check-alignment': checkAlignment,\n    'check-examples': checkExamples,\n    'check-indentation': checkIndentation,\n    'check-line-alignment': checkLineAlignment,\n    'check-param-names': checkParamNames,\n    'check-property-names': checkPropertyNames,\n    'check-syntax': checkSyntax,\n    'check-tag-names': checkTagNames,\n    'check-types': checkTypes,\n    'check-values': checkValues,\n    'empty-tags': emptyTags,\n    'implements-on-classes': implementsOnClasses,\n    'match-description': matchDescription,\n    'match-name': matchName,\n    'multiline-blocks': multilineBlocks,\n    'newline-after-description': newlineAfterDescription,\n    'no-bad-blocks': noBadBlocks,\n    'no-defaults': noDefaults,\n    'no-missing-syntax': noMissingSyntax,\n    'no-multi-asterisks': noMultiAsterisks,\n    'no-restricted-syntax': noRestrictedSyntax,\n    'no-types': noTypes,\n    'no-undefined-types': noUndefinedTypes,\n    'require-asterisk-prefix': requireAsteriskPrefix,\n    'require-description': requireDescription,\n    'require-description-complete-sentence': requireDescriptionCompleteSentence,\n    'require-example': requireExample,\n    'require-file-overview': requireFileOverview,\n    'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,\n    'require-jsdoc': requireJsdoc,\n    'require-param': requireParam,\n    'require-param-description': requireParamDescription,\n    'require-param-name': requireParamName,\n    'require-param-type': requireParamType,\n    'require-property': requireProperty,\n    'require-property-description': requirePropertyDescription,\n    'require-property-name': requirePropertyName,\n    'require-property-type': requirePropertyType,\n    'require-returns': requireReturns,\n    'require-returns-check': requireReturnsCheck,\n    'require-returns-description': requireReturnsDescription,\n    'require-returns-type': requireReturnsType,\n    'require-throws': requireThrows,\n    'require-yields': requireYields,\n    'require-yields-check': requireYieldsCheck,\n    'sort-tags': sortTags,\n    'tag-lines': tagLines,\n    'valid-types': validTypes,\n  },\n};\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAA4C;AAAA,eAE7B;EACbA,OAAO,EAAE;IACPC,WAAW,EAAE;MACXC,OAAO,EAAE,CACP,OAAO,CACR;MACDC,KAAK,EAAE;QACL,oBAAoB,EAAE,MAAM;QAC5B,uBAAuB,EAAE,MAAM;QAC/B,sBAAsB,EAAE,KAAK;QAC7B,yBAAyB,EAAE,KAAK;QAChC,4BAA4B,EAAE,KAAK;QACnC,yBAAyB,EAAE,MAAM;QACjC,4BAA4B,EAAE,MAAM;QACpC,oBAAoB,EAAE,KAAK;QAC3B,uBAAuB,EAAE,MAAM;QAC/B,mBAAmB,EAAE,MAAM;QAC3B,oBAAoB,EAAE,MAAM;QAC5B,kBAAkB,EAAE,MAAM;QAC1B,6BAA6B,EAAE,MAAM;QACrC,yBAAyB,EAAE,KAAK;QAChC,kBAAkB,EAAE,KAAK;QACzB,wBAAwB,EAAE,MAAM;QAChC,iCAAiC,EAAE,MAAM;QACzC,qBAAqB,EAAE,KAAK;QAC5B,mBAAmB,EAAE,KAAK;QAC1B,yBAAyB,EAAE,KAAK;QAChC,0BAA0B,EAAE,MAAM;QAClC,4BAA4B,EAAE,KAAK;QACnC,gBAAgB,EAAE,KAAK;QACvB,0BAA0B,EAAE,MAAM;QAClC,+BAA+B,EAAE,KAAK;QACtC,2BAA2B,EAAE,KAAK;QAClC,6CAA6C,EAAE,KAAK;QACpD,uBAAuB,EAAE,KAAK;QAC9B,6BAA6B,EAAE,KAAK;QACpC,+CAA+C,EAAE,KAAK;QACtD,qBAAqB,EAAE,MAAM;QAC7B,qBAAqB,EAAE,MAAM;QAC7B,iCAAiC,EAAE,MAAM;QACzC,0BAA0B,EAAE,MAAM;QAClC,0BAA0B,EAAE,MAAM;QAClC,wBAAwB,EAAE,MAAM;QAChC,oCAAoC,EAAE,MAAM;QAC5C,6BAA6B,EAAE,MAAM;QACrC,6BAA6B,EAAE,MAAM;QACrC,uBAAuB,EAAE,MAAM;QAC/B,6BAA6B,EAAE,MAAM;QACrC,mCAAmC,EAAE,MAAM;QAC3C,4BAA4B,EAAE,MAAM;QACpC,sBAAsB,EAAE,KAAK;QAC7B,sBAAsB,EAAE,MAAM;QAC9B,4BAA4B,EAAE,MAAM;QACpC,iBAAiB,EAAE,KAAK;QACxB,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAE;MACvB;IACF;EACF,CAAC;EACDA,KAAK,EAAE;IACL,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,uBAAc;IACjC,gBAAgB,EAAEC,sBAAa;IAC/B,mBAAmB,EAAEC,yBAAgB;IACrC,sBAAsB,EAAEC,2BAAkB;IAC1C,mBAAmB,EAAEC,wBAAe;IACpC,sBAAsB,EAAEC,2BAAkB;IAC1C,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,sBAAa;IAChC,aAAa,EAAEC,mBAAU;IACzB,cAAc,EAAEC,oBAAW;IAC3B,YAAY,EAAEC,kBAAS;IACvB,uBAAuB,EAAEC,4BAAmB;IAC5C,mBAAmB,EAAEC,yBAAgB;IACrC,YAAY,EAAEC,kBAAS;IACvB,kBAAkB,EAAEC,wBAAe;IACnC,2BAA2B,EAAEC,gCAAuB;IACpD,eAAe,EAAEC,oBAAW;IAC5B,aAAa,EAAEC,mBAAU;IACzB,mBAAmB,EAAEC,wBAAe;IACpC,oBAAoB,EAAEC,yBAAgB;IACtC,sBAAsB,EAAEC,2BAAkB;IAC1C,UAAU,EAAEC,gBAAO;IACnB,oBAAoB,EAAEC,yBAAgB;IACtC,yBAAyB,EAAEC,8BAAqB;IAChD,qBAAqB,EAAEC,2BAAkB;IACzC,uCAAuC,EAAEC,2CAAkC;IAC3E,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,yCAAyC,EAAEC,4CAAmC;IAC9E,eAAe,EAAEC,qBAAY;IAC7B,eAAe,EAAEC,qBAAY;IAC7B,2BAA2B,EAAEC,gCAAuB;IACpD,oBAAoB,EAAEC,yBAAgB;IACtC,oBAAoB,EAAEC,yBAAgB;IACtC,kBAAkB,EAAEC,wBAAe;IACnC,8BAA8B,EAAEC,mCAA0B;IAC1D,uBAAuB,EAAEC,4BAAmB;IAC5C,uBAAuB,EAAEC,4BAAmB;IAC5C,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,6BAA6B,EAAEC,kCAAyB;IACxD,sBAAsB,EAAEC,2BAAkB;IAC1C,gBAAgB,EAAEC,sBAAa;IAC/B,gBAAgB,EAAEC,sBAAa;IAC/B,sBAAsB,EAAEC,2BAAkB;IAC1C,WAAW,EAAEC,iBAAQ;IACrB,WAAW,EAAEC,iBAAQ;IACrB,aAAa,EAAEC;EACjB;AACF,CAAC;AAAA;AAAA"}
+{"version":3,"file":"index.js","names":["configs","recommended","plugins","rules","checkAccess","checkAlignment","checkExamples","checkIndentation","checkLineAlignment","checkParamNames","checkPropertyNames","checkSyntax","checkTagNames","checkTypes","checkValues","emptyTags","implementsOnClasses","matchDescription","matchName","multilineBlocks","newlineAfterDescription","noBadBlocks","noDefaults","noMissingSyntax","noMultiAsterisks","noRestrictedSyntax","noTypes","noUndefinedTypes","requireAsteriskPrefix","requireDescription","requireDescriptionCompleteSentence","requireExample","requireFileOverview","requireHyphenBeforeParamDescription","requireJsdoc","requireParam","requireParamDescription","requireParamName","requireParamType","requireProperty","requirePropertyDescription","requirePropertyName","requirePropertyType","requireReturns","requireReturnsCheck","requireReturnsDescription","requireReturnsType","requireThrows","requireYields","requireYieldsCheck","sortTags","tagLines","textEscaping","validTypes"],"sources":["../src/index.js"],"sourcesContent":["import checkAccess from './rules/checkAccess';\nimport checkAlignment from './rules/checkAlignment';\nimport checkExamples from './rules/checkExamples';\nimport checkIndentation from './rules/checkIndentation';\nimport checkLineAlignment from './rules/checkLineAlignment';\nimport checkParamNames from './rules/checkParamNames';\nimport checkPropertyNames from './rules/checkPropertyNames';\nimport checkSyntax from './rules/checkSyntax';\nimport checkTagNames from './rules/checkTagNames';\nimport checkTypes from './rules/checkTypes';\nimport checkValues from './rules/checkValues';\nimport emptyTags from './rules/emptyTags';\nimport implementsOnClasses from './rules/implementsOnClasses';\nimport matchDescription from './rules/matchDescription';\nimport matchName from './rules/matchName';\nimport multilineBlocks from './rules/multilineBlocks';\nimport newlineAfterDescription from './rules/newlineAfterDescription';\nimport noBadBlocks from './rules/noBadBlocks';\nimport noDefaults from './rules/noDefaults';\nimport noMissingSyntax from './rules/noMissingSyntax';\nimport noMultiAsterisks from './rules/noMultiAsterisks';\nimport noRestrictedSyntax from './rules/noRestrictedSyntax';\nimport noTypes from './rules/noTypes';\nimport noUndefinedTypes from './rules/noUndefinedTypes';\nimport requireAsteriskPrefix from './rules/requireAsteriskPrefix';\nimport requireDescription from './rules/requireDescription';\nimport requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence';\nimport requireExample from './rules/requireExample';\nimport requireFileOverview from './rules/requireFileOverview';\nimport requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription';\nimport requireJsdoc from './rules/requireJsdoc';\nimport requireParam from './rules/requireParam';\nimport requireParamDescription from './rules/requireParamDescription';\nimport requireParamName from './rules/requireParamName';\nimport requireParamType from './rules/requireParamType';\nimport requireProperty from './rules/requireProperty';\nimport requirePropertyDescription from './rules/requirePropertyDescription';\nimport requirePropertyName from './rules/requirePropertyName';\nimport requirePropertyType from './rules/requirePropertyType';\nimport requireReturns from './rules/requireReturns';\nimport requireReturnsCheck from './rules/requireReturnsCheck';\nimport requireReturnsDescription from './rules/requireReturnsDescription';\nimport requireReturnsType from './rules/requireReturnsType';\nimport requireThrows from './rules/requireThrows';\nimport requireYields from './rules/requireYields';\nimport requireYieldsCheck from './rules/requireYieldsCheck';\nimport sortTags from './rules/sortTags';\nimport tagLines from './rules/tagLines';\nimport textEscaping from './rules/textEscaping';\nimport validTypes from './rules/validTypes';\n\nexport default {\n  configs: {\n    recommended: {\n      plugins: [\n        'jsdoc',\n      ],\n      rules: {\n        'jsdoc/check-access': 'warn',\n        'jsdoc/check-alignment': 'warn',\n        'jsdoc/check-examples': 'off',\n        'jsdoc/check-indentation': 'off',\n        'jsdoc/check-line-alignment': 'off',\n        'jsdoc/check-param-names': 'warn',\n        'jsdoc/check-property-names': 'warn',\n        'jsdoc/check-syntax': 'off',\n        'jsdoc/check-tag-names': 'warn',\n        'jsdoc/check-types': 'warn',\n        'jsdoc/check-values': 'warn',\n        'jsdoc/empty-tags': 'warn',\n        'jsdoc/implements-on-classes': 'warn',\n        'jsdoc/match-description': 'off',\n        'jsdoc/match-name': 'off',\n        'jsdoc/multiline-blocks': 'warn',\n        'jsdoc/newline-after-description': 'warn',\n        'jsdoc/no-bad-blocks': 'off',\n        'jsdoc/no-defaults': 'off',\n        'jsdoc/no-missing-syntax': 'off',\n        'jsdoc/no-multi-asterisks': 'warn',\n        'jsdoc/no-restricted-syntax': 'off',\n        'jsdoc/no-types': 'off',\n        'jsdoc/no-undefined-types': 'warn',\n        'jsdoc/require-asterisk-prefix': 'off',\n        'jsdoc/require-description': 'off',\n        'jsdoc/require-description-complete-sentence': 'off',\n        'jsdoc/require-example': 'off',\n        'jsdoc/require-file-overview': 'off',\n        'jsdoc/require-hyphen-before-param-description': 'off',\n        'jsdoc/require-jsdoc': 'warn',\n        'jsdoc/require-param': 'warn',\n        'jsdoc/require-param-description': 'warn',\n        'jsdoc/require-param-name': 'warn',\n        'jsdoc/require-param-type': 'warn',\n        'jsdoc/require-property': 'warn',\n        'jsdoc/require-property-description': 'warn',\n        'jsdoc/require-property-name': 'warn',\n        'jsdoc/require-property-type': 'warn',\n        'jsdoc/require-returns': 'warn',\n        'jsdoc/require-returns-check': 'warn',\n        'jsdoc/require-returns-description': 'warn',\n        'jsdoc/require-returns-type': 'warn',\n        'jsdoc/require-throws': 'off',\n        'jsdoc/require-yields': 'warn',\n        'jsdoc/require-yields-check': 'warn',\n        'jsdoc/sort-tags': 'off',\n        'jsdoc/tag-lines': 'warn',\n        'jsdoc/text-escaping': 'off',\n        'jsdoc/valid-types': 'warn',\n      },\n    },\n  },\n  rules: {\n    'check-access': checkAccess,\n    'check-alignment': checkAlignment,\n    'check-examples': checkExamples,\n    'check-indentation': checkIndentation,\n    'check-line-alignment': checkLineAlignment,\n    'check-param-names': checkParamNames,\n    'check-property-names': checkPropertyNames,\n    'check-syntax': checkSyntax,\n    'check-tag-names': checkTagNames,\n    'check-types': checkTypes,\n    'check-values': checkValues,\n    'empty-tags': emptyTags,\n    'implements-on-classes': implementsOnClasses,\n    'match-description': matchDescription,\n    'match-name': matchName,\n    'multiline-blocks': multilineBlocks,\n    'newline-after-description': newlineAfterDescription,\n    'no-bad-blocks': noBadBlocks,\n    'no-defaults': noDefaults,\n    'no-missing-syntax': noMissingSyntax,\n    'no-multi-asterisks': noMultiAsterisks,\n    'no-restricted-syntax': noRestrictedSyntax,\n    'no-types': noTypes,\n    'no-undefined-types': noUndefinedTypes,\n    'require-asterisk-prefix': requireAsteriskPrefix,\n    'require-description': requireDescription,\n    'require-description-complete-sentence': requireDescriptionCompleteSentence,\n    'require-example': requireExample,\n    'require-file-overview': requireFileOverview,\n    'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,\n    'require-jsdoc': requireJsdoc,\n    'require-param': requireParam,\n    'require-param-description': requireParamDescription,\n    'require-param-name': requireParamName,\n    'require-param-type': requireParamType,\n    'require-property': requireProperty,\n    'require-property-description': requirePropertyDescription,\n    'require-property-name': requirePropertyName,\n    'require-property-type': requirePropertyType,\n    'require-returns': requireReturns,\n    'require-returns-check': requireReturnsCheck,\n    'require-returns-description': requireReturnsDescription,\n    'require-returns-type': requireReturnsType,\n    'require-throws': requireThrows,\n    'require-yields': requireYields,\n    'require-yields-check': requireYieldsCheck,\n    'sort-tags': sortTags,\n    'tag-lines': tagLines,\n    'text-escaping': textEscaping,\n    'valid-types': validTypes,\n  },\n};\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAA4C;AAAA,eAE7B;EACbA,OAAO,EAAE;IACPC,WAAW,EAAE;MACXC,OAAO,EAAE,CACP,OAAO,CACR;MACDC,KAAK,EAAE;QACL,oBAAoB,EAAE,MAAM;QAC5B,uBAAuB,EAAE,MAAM;QAC/B,sBAAsB,EAAE,KAAK;QAC7B,yBAAyB,EAAE,KAAK;QAChC,4BAA4B,EAAE,KAAK;QACnC,yBAAyB,EAAE,MAAM;QACjC,4BAA4B,EAAE,MAAM;QACpC,oBAAoB,EAAE,KAAK;QAC3B,uBAAuB,EAAE,MAAM;QAC/B,mBAAmB,EAAE,MAAM;QAC3B,oBAAoB,EAAE,MAAM;QAC5B,kBAAkB,EAAE,MAAM;QAC1B,6BAA6B,EAAE,MAAM;QACrC,yBAAyB,EAAE,KAAK;QAChC,kBAAkB,EAAE,KAAK;QACzB,wBAAwB,EAAE,MAAM;QAChC,iCAAiC,EAAE,MAAM;QACzC,qBAAqB,EAAE,KAAK;QAC5B,mBAAmB,EAAE,KAAK;QAC1B,yBAAyB,EAAE,KAAK;QAChC,0BAA0B,EAAE,MAAM;QAClC,4BAA4B,EAAE,KAAK;QACnC,gBAAgB,EAAE,KAAK;QACvB,0BAA0B,EAAE,MAAM;QAClC,+BAA+B,EAAE,KAAK;QACtC,2BAA2B,EAAE,KAAK;QAClC,6CAA6C,EAAE,KAAK;QACpD,uBAAuB,EAAE,KAAK;QAC9B,6BAA6B,EAAE,KAAK;QACpC,+CAA+C,EAAE,KAAK;QACtD,qBAAqB,EAAE,MAAM;QAC7B,qBAAqB,EAAE,MAAM;QAC7B,iCAAiC,EAAE,MAAM;QACzC,0BAA0B,EAAE,MAAM;QAClC,0BAA0B,EAAE,MAAM;QAClC,wBAAwB,EAAE,MAAM;QAChC,oCAAoC,EAAE,MAAM;QAC5C,6BAA6B,EAAE,MAAM;QACrC,6BAA6B,EAAE,MAAM;QACrC,uBAAuB,EAAE,MAAM;QAC/B,6BAA6B,EAAE,MAAM;QACrC,mCAAmC,EAAE,MAAM;QAC3C,4BAA4B,EAAE,MAAM;QACpC,sBAAsB,EAAE,KAAK;QAC7B,sBAAsB,EAAE,MAAM;QAC9B,4BAA4B,EAAE,MAAM;QACpC,iBAAiB,EAAE,KAAK;QACxB,iBAAiB,EAAE,MAAM;QACzB,qBAAqB,EAAE,KAAK;QAC5B,mBAAmB,EAAE;MACvB;IACF;EACF,CAAC;EACDA,KAAK,EAAE;IACL,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,uBAAc;IACjC,gBAAgB,EAAEC,sBAAa;IAC/B,mBAAmB,EAAEC,yBAAgB;IACrC,sBAAsB,EAAEC,2BAAkB;IAC1C,mBAAmB,EAAEC,wBAAe;IACpC,sBAAsB,EAAEC,2BAAkB;IAC1C,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,sBAAa;IAChC,aAAa,EAAEC,mBAAU;IACzB,cAAc,EAAEC,oBAAW;IAC3B,YAAY,EAAEC,kBAAS;IACvB,uBAAuB,EAAEC,4BAAmB;IAC5C,mBAAmB,EAAEC,yBAAgB;IACrC,YAAY,EAAEC,kBAAS;IACvB,kBAAkB,EAAEC,wBAAe;IACnC,2BAA2B,EAAEC,gCAAuB;IACpD,eAAe,EAAEC,oBAAW;IAC5B,aAAa,EAAEC,mBAAU;IACzB,mBAAmB,EAAEC,wBAAe;IACpC,oBAAoB,EAAEC,yBAAgB;IACtC,sBAAsB,EAAEC,2BAAkB;IAC1C,UAAU,EAAEC,gBAAO;IACnB,oBAAoB,EAAEC,yBAAgB;IACtC,yBAAyB,EAAEC,8BAAqB;IAChD,qBAAqB,EAAEC,2BAAkB;IACzC,uCAAuC,EAAEC,2CAAkC;IAC3E,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,yCAAyC,EAAEC,4CAAmC;IAC9E,eAAe,EAAEC,qBAAY;IAC7B,eAAe,EAAEC,qBAAY;IAC7B,2BAA2B,EAAEC,gCAAuB;IACpD,oBAAoB,EAAEC,yBAAgB;IACtC,oBAAoB,EAAEC,yBAAgB;IACtC,kBAAkB,EAAEC,wBAAe;IACnC,8BAA8B,EAAEC,mCAA0B;IAC1D,uBAAuB,EAAEC,4BAAmB;IAC5C,uBAAuB,EAAEC,4BAAmB;IAC5C,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,6BAA6B,EAAEC,kCAAyB;IACxD,sBAAsB,EAAEC,2BAAkB;IAC1C,gBAAgB,EAAEC,sBAAa;IAC/B,gBAAgB,EAAEC,sBAAa;IAC/B,sBAAsB,EAAEC,2BAAkB;IAC1C,WAAW,EAAEC,iBAAQ;IACrB,WAAW,EAAEC,iBAAQ;IACrB,eAAe,EAAEC,qBAAY;IAC7B,aAAa,EAAEC;EACjB;AACF,CAAC;AAAA;AAAA"}

package/dist/iterateJsdoc.js

@@ -117,7 +117,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
   utils.getRegexFromString = (str, requiredFlags) => {
     return _jsdocUtils.default.getRegexFromString(str, requiredFlags);
   };
-  utils.getTagDescription = tg => {
+  utils.getTagDescription = (tg, returnArray) => {
     const descriptions = [];
     tg.source.some(({
       tokens: {
@@ -144,7 +144,23 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       descriptions.push(desc);
       return false;
     });
-    return descriptions.join('\n');
+    return returnArray ? descriptions : descriptions.join('\n');
+  };
+  utils.setTagDescription = (tg, matcher, setter) => {
+    let finalIdx = 0;
+    tg.source.some(({
+      tokens: {
+        description
+      }
+    }, idx) => {
+      if (description && matcher.test(description)) {
+        tg.source[idx].tokens.description = setter(description);
+        finalIdx = idx;
+        return true;
+      }
+      return false;
+    });
+    return finalIdx;
   };
   utils.getDescription = () => {
     const descriptions = [];
@@ -167,9 +183,32 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
     });
     return {
       description: descriptions.join('\n'),
+      descriptions,
       lastDescriptionLine
     };
   };
+  utils.setDescriptionLines = (matcher, setter) => {
+    let finalIdx = 0;
+    jsdoc.source.some(({
+      tokens: {
+        description,
+        tag,
+        end
+      }
+    }, idx) => {
+      // istanbul ignore if -- Already checked
+      if (idx && (tag || end)) {
+        return true;
+      }
+      if (description && matcher.test(description)) {
+        jsdoc.source[idx].tokens.description = setter(description);
+        finalIdx = idx;
+        return true;
+      }
+      return false;
+    });
+    return finalIdx;
+  };
   utils.changeTag = (tag, ...tokens) => {
     for (const [idx, src] of tag.source.entries()) {
       src.tokens = {