npm - eslint-plugin-jsdoc - Versions diffs - 44.2.2 → 44.2.4 - Mend

eslint-plugin-jsdoc 44.2.2 → 44.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (117) hide show

package/dist/alignTransform.js +86 -4
package/dist/alignTransform.js.map +1 -1
package/dist/exportParser.js +134 -4
package/dist/exportParser.js.map +1 -1
package/dist/getDefaultTagStructureForMode.js +71 -62
package/dist/getDefaultTagStructureForMode.js.map +1 -1
package/dist/index.js +7 -5
package/dist/index.js.map +1 -1
package/dist/iterateJsdoc.js +1081 -111
package/dist/iterateJsdoc.js.map +1 -1
package/dist/jsdocUtils.js +381 -132
package/dist/jsdocUtils.js.map +1 -1
package/dist/rules/checkAlignment.js +6 -0
package/dist/rules/checkAlignment.js.map +1 -1
package/dist/rules/checkExamples.js +70 -6
package/dist/rules/checkExamples.js.map +1 -1
package/dist/rules/checkIndentation.js +11 -1
package/dist/rules/checkIndentation.js.map +1 -1
package/dist/rules/checkLineAlignment.js +69 -5
package/dist/rules/checkLineAlignment.js.map +1 -1
package/dist/rules/checkParamNames.js +12 -7
package/dist/rules/checkParamNames.js.map +1 -1
package/dist/rules/checkPropertyNames.js +13 -7
package/dist/rules/checkPropertyNames.js.map +1 -1
package/dist/rules/checkTagNames.js +45 -5
package/dist/rules/checkTagNames.js.map +1 -1
package/dist/rules/checkTypes.js +97 -36
package/dist/rules/checkTypes.js.map +1 -1
package/dist/rules/checkValues.js +6 -6
package/dist/rules/checkValues.js.map +1 -1
package/dist/rules/emptyTags.js +8 -1
package/dist/rules/emptyTags.js.map +1 -1
package/dist/rules/informativeDocs.js +26 -7
package/dist/rules/informativeDocs.js.map +1 -1
package/dist/rules/matchDescription.js +19 -2
package/dist/rules/matchDescription.js.map +1 -1
package/dist/rules/matchName.js +2 -2
package/dist/rules/matchName.js.map +1 -1
package/dist/rules/multilineBlocks.js +12 -1
package/dist/rules/multilineBlocks.js.map +1 -1
package/dist/rules/noBadBlocks.js +4 -6
package/dist/rules/noBadBlocks.js.map +1 -1
package/dist/rules/noBlankBlockDescriptions.js +2 -0
package/dist/rules/noBlankBlockDescriptions.js.map +1 -1
package/dist/rules/noMissingSyntax.js +58 -15
package/dist/rules/noMissingSyntax.js.map +1 -1
package/dist/rules/noMultiAsterisks.js +1 -6
package/dist/rules/noMultiAsterisks.js.map +1 -1
package/dist/rules/noRestrictedSyntax.js +17 -4
package/dist/rules/noRestrictedSyntax.js.map +1 -1
package/dist/rules/noTypes.js +3 -0
package/dist/rules/noTypes.js.map +1 -1
package/dist/rules/noUndefinedTypes.js +61 -20
package/dist/rules/noUndefinedTypes.js.map +1 -1
package/dist/rules/requireAsteriskPrefix.js +20 -0
package/dist/rules/requireAsteriskPrefix.js.map +1 -1
package/dist/rules/requireDescription.js +6 -2
package/dist/rules/requireDescription.js.map +1 -1
package/dist/rules/requireDescriptionCompleteSentence.js +73 -10
package/dist/rules/requireDescriptionCompleteSentence.js.map +1 -1
package/dist/rules/requireFileOverview.js +9 -4
package/dist/rules/requireFileOverview.js.map +1 -1
package/dist/rules/requireHyphenBeforeParamDescription.js +23 -6
package/dist/rules/requireHyphenBeforeParamDescription.js.map +1 -1
package/dist/rules/requireJsdoc.js +148 -30
package/dist/rules/requireJsdoc.js.map +1 -1
package/dist/rules/requireParam.js +46 -2
package/dist/rules/requireParam.js.map +1 -1
package/dist/rules/requireProperty.js +1 -1
package/dist/rules/requireProperty.js.map +1 -1
package/dist/rules/requireReturns.js +2 -2
package/dist/rules/requireReturns.js.map +1 -1
package/dist/rules/requireReturnsCheck.js +9 -2
package/dist/rules/requireReturnsCheck.js.map +1 -1
package/dist/rules/requireThrows.js +2 -2
package/dist/rules/requireThrows.js.map +1 -1
package/dist/rules/requireYields.js +9 -2
package/dist/rules/requireYields.js.map +1 -1
package/dist/rules/requireYieldsCheck.js +19 -5
package/dist/rules/requireYieldsCheck.js.map +1 -1
package/dist/rules/sortTags.js +67 -9
package/dist/rules/sortTags.js.map +1 -1
package/dist/rules/tagLines.js +22 -3
package/dist/rules/tagLines.js.map +1 -1
package/dist/rules/textEscaping.js +16 -2
package/dist/rules/textEscaping.js.map +1 -1
package/dist/rules/validTypes.js +25 -8
package/dist/rules/validTypes.js.map +1 -1
package/dist/tagNames.js +27 -0
package/dist/tagNames.js.map +1 -1
package/dist/utils/hasReturnValue.js +87 -42
package/dist/utils/hasReturnValue.js.map +1 -1
package/docs/rules/check-tag-names.md +15 -0
package/docs/rules/no-missing-syntax.md +6 -0
package/docs/rules/no-undefined-types.md +18 -0
package/docs/rules/require-description-complete-sentence.md +525 -289
package/docs/rules/require-description.md +289 -525
package/docs/rules/require-file-overview.md +7 -0
package/docs/rules/require-jsdoc.md +1 -1
package/docs/rules/require-param-description.md +116 -1694
package/docs/rules/require-param-name.md +58 -133
package/docs/rules/require-param-type.md +119 -55
package/docs/rules/require-param.md +1700 -111
package/docs/rules/require-property-description.md +39 -79
package/docs/rules/require-property-name.md +21 -30
package/docs/rules/require-property-type.md +21 -21
package/docs/rules/require-property.md +82 -33
package/docs/rules/require-returns-check.md +636 -747
package/docs/rules/require-returns-description.md +61 -933
package/docs/rules/require-returns-type.md +42 -79
package/docs/rules/require-returns.md +1081 -61
package/docs/rules/require-yields-check.md +238 -517
package/docs/rules/require-yields.md +517 -238
package/docs/rules/valid-types.md +1 -1
package/docs/settings.md +1 -1
package/package.json +13 -5
package/tsconfig.json +5 -2

package/docs/rules/require-file-overview.md CHANGED Viewed

@@ -229,6 +229,13 @@ function quux () {
  */
 // "jsdoc/require-file-overview": ["error"|"warn", {"tags":{"file":{"initialCommentsOnly":true,"preventDuplicates":true}}}]
 // Message: Duplicate @file
+/**
+ *
+ */
+function quux () {}
+// Settings: {"jsdoc":{"tagNamePreference":{"file":{"replacement":"fileoverview"}}}}
+// Message: Missing @fileoverview
 ````

package/docs/rules/require-jsdoc.md CHANGED Viewed

@@ -1825,7 +1825,7 @@ var a = {
   b: 1,
   c: 2
 };
-// "jsdoc/require-jsdoc": ["error"|"warn", {"contexts":[{"context":"FunctionDeclaration","minLineCount":4},{"context":"VariableDeclaration","minLineCount":5}],"require":{"FunctionDeclaration":false}}]
+// "jsdoc/require-jsdoc": ["error"|"warn", {"contexts":["ClassDeclaration",{"context":"FunctionDeclaration","minLineCount":4},{"context":"VariableDeclaration","minLineCount":5}],"require":{"FunctionDeclaration":false}}]
 class A {
   setId(newId: number): void {