npm - eslint-plugin-jsdoc - Versions diffs - 46.4.5 → 46.5.0 - Mend

eslint-plugin-jsdoc 46.4.5 → 46.5.0

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 (66) hide show

package/README.md +31 -0
package/dist/alignTransform.js +5 -5
package/dist/alignTransform.js.map +1 -1
package/dist/index.js +21 -10
package/dist/index.js.map +1 -1
package/dist/iterateJsdoc.js +1 -1
package/dist/iterateJsdoc.js.map +1 -1
package/dist/rules/checkExamples.js +12 -6
package/dist/rules/checkExamples.js.map +1 -1
package/package.json +19 -15
package/docs/advanced.md +0 -102
package/docs/rules/check-access.md +0 -193
package/docs/rules/check-alignment.md +0 -169
package/docs/rules/check-examples.md +0 -784
package/docs/rules/check-indentation.md +0 -296
package/docs/rules/check-line-alignment.md +0 -1002
package/docs/rules/check-param-names.md +0 -1035
package/docs/rules/check-property-names.md +0 -244
package/docs/rules/check-syntax.md +0 -80
package/docs/rules/check-tag-names.md +0 -1132
package/docs/rules/check-types.md +0 -1198
package/docs/rules/check-values.md +0 -409
package/docs/rules/empty-tags.md +0 -220
package/docs/rules/implements-on-classes.md +0 -219
package/docs/rules/imports-as-dependencies.md +0 -99
package/docs/rules/informative-docs.md +0 -400
package/docs/rules/match-description.md +0 -1008
package/docs/rules/match-name.md +0 -249
package/docs/rules/multiline-blocks.md +0 -398
package/docs/rules/no-bad-blocks.md +0 -174
package/docs/rules/no-blank-block-descriptions.md +0 -91
package/docs/rules/no-blank-blocks.md +0 -98
package/docs/rules/no-defaults.md +0 -207
package/docs/rules/no-missing-syntax.md +0 -275
package/docs/rules/no-multi-asterisks.md +0 -278
package/docs/rules/no-restricted-syntax.md +0 -383
package/docs/rules/no-types.md +0 -168
package/docs/rules/no-undefined-types.md +0 -789
package/docs/rules/require-asterisk-prefix.md +0 -297
package/docs/rules/require-description-complete-sentence.md +0 -820
package/docs/rules/require-description.md +0 -585
package/docs/rules/require-example.md +0 -390
package/docs/rules/require-file-overview.md +0 -324
package/docs/rules/require-hyphen-before-param-description.md +0 -281
package/docs/rules/require-jsdoc.md +0 -1857
package/docs/rules/require-param-description.md +0 -238
package/docs/rules/require-param-name.md +0 -163
package/docs/rules/require-param-type.md +0 -227
package/docs/rules/require-param.md +0 -1820
package/docs/rules/require-property-description.md +0 -88
package/docs/rules/require-property-name.md +0 -79
package/docs/rules/require-property-type.md +0 -79
package/docs/rules/require-property.md +0 -128
package/docs/rules/require-returns-check.md +0 -1053
package/docs/rules/require-returns-description.md +0 -181
package/docs/rules/require-returns-type.md +0 -144
package/docs/rules/require-returns.md +0 -1191
package/docs/rules/require-throws.md +0 -326
package/docs/rules/require-yields-check.md +0 -544
package/docs/rules/require-yields.md +0 -823
package/docs/rules/sort-tags.md +0 -635
package/docs/rules/tag-lines.md +0 -551
package/docs/rules/text-escaping.md +0 -177
package/docs/rules/valid-types.md +0 -881
package/docs/settings.md +0 -362
package/tsconfig.json +0 -22

package/docs/rules/require-returns-description.md DELETED Viewed

@@ -1,181 +0,0 @@
-<a name="user-content-require-returns-description"></a>
-<a name="require-returns-description"></a>
-# <code>require-returns-description</code>
-* [Options](#user-content-require-returns-description-options)
-    * [`contexts`](#user-content-require-returns-description-options-contexts)
-* [Context and settings](#user-content-require-returns-description-context-and-settings)
-* [Failing examples](#user-content-require-returns-description-failing-examples)
-* [Passing examples](#user-content-require-returns-description-passing-examples)
-Requires that the `@returns` tag has a `description` value. The error
-will not be reported if the return value is `void` or `undefined`
-or if it is `Promise<void>` or `Promise<undefined>`.
-<a name="user-content-require-returns-description-options"></a>
-<a name="require-returns-description-options"></a>
-## Options
-<a name="user-content-require-returns-description-options-contexts"></a>
-<a name="require-returns-description-options-contexts"></a>
-### <code>contexts</code>
-Set this to an array of strings representing the AST context (or an object with
-`context` and `comment` properties) where you wish the rule to be applied.
-Overrides the default contexts (see below). Set to `"any"` if you want
-the rule to apply to any jsdoc block throughout your files (as is necessary
-for finding function blocks not attached to a function declaration or
-expression, i.e., `@callback` or `@function` (or its aliases `@func` or
-`@method`) (including those associated with an `@interface`).
-See the ["AST and Selectors"](#user-content-eslint-plugin-jsdoc-advanced-ast-and-selectors)
-section of our README for more on the expected format.
-<a name="user-content-require-returns-description-context-and-settings"></a>
-<a name="require-returns-description-context-and-settings"></a>
-## Context and settings
-|||
-|---|---|
-|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
-|Tags|`returns`|
-|Aliases|`return`|
-|Recommended|true|
-|Options|`contexts`|
-<a name="user-content-require-returns-description-failing-examples"></a>
-<a name="require-returns-description-failing-examples"></a>
-## Failing examples
-The following patterns are considered problems:
-````js
-/**
- * @returns
- */
-function quux (foo) {
-}
-// Message: Missing JSDoc @returns description.
-/**
- * @returns {string}
- */
-function quux (foo) {
-}
-// Message: Missing JSDoc @returns description.
-/**
- * @returns {string}
- */
-function quux (foo) {
-}
-// "jsdoc/require-returns-description": ["error"|"warn", {"contexts":["any"]}]
-// Message: Missing JSDoc @returns description.
-/**
- * @function
- * @returns {string}
- */
-// "jsdoc/require-returns-description": ["error"|"warn", {"contexts":["any"]}]
-// Message: Missing JSDoc @returns description.
-/**
- * @callback
- * @returns {string}
- */
-// "jsdoc/require-returns-description": ["error"|"warn", {"contexts":["any"]}]
-// Message: Missing JSDoc @returns description.
-/**
- * @return
- */
-function quux (foo) {
-}
-// Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
-// Message: Missing JSDoc @return description.
-/**
- * @returns
- */
-function quux () {
-}
-// Settings: {"jsdoc":{"tagNamePreference":{"returns":false}}}
-// Message: Unexpected tag `@returns`
-````
-<a name="user-content-require-returns-description-passing-examples"></a>
-<a name="require-returns-description-passing-examples"></a>
-## Passing examples
-The following patterns are not considered problems:
-````js
-/**
- *
- */
-function quux () {
-}
-/**
- * @returns Foo.
- */
-function quux () {
-}
-/**
- * @returns Foo.
- */
-function quux () {
-}
-// "jsdoc/require-returns-description": ["error"|"warn", {"contexts":["any"]}]
-/**
- * @returns {undefined}
- */
-function quux () {
-}
-/**
- * @returns {void}
- */
-function quux () {
-}
-/**
- * @returns {Promise<void>}
- */
-function quux () {
-}
-/**
- * @returns {Promise<undefined>}
- */
-function quux () {
-}
-/**
- * @function
- * @returns
- */
-/**
- * @callback
- * @returns
- */
-````

package/docs/rules/require-returns-type.md DELETED Viewed

@@ -1,144 +0,0 @@
-<a name="user-content-require-returns-type"></a>
-<a name="require-returns-type"></a>
-# <code>require-returns-type</code>
-* [Options](#user-content-require-returns-type-options)
-    * [`contexts`](#user-content-require-returns-type-options-contexts)
-* [Context and settings](#user-content-require-returns-type-context-and-settings)
-* [Failing examples](#user-content-require-returns-type-failing-examples)
-* [Passing examples](#user-content-require-returns-type-passing-examples)
-Requires that `@returns` tag has a `type` value (in curly brackets).
-<a name="user-content-require-returns-type-options"></a>
-<a name="require-returns-type-options"></a>
-## Options
-<a name="user-content-require-returns-type-options-contexts"></a>
-<a name="require-returns-type-options-contexts"></a>
-### <code>contexts</code>
-Set this to an array of strings representing the AST context (or an object with
-`context` and `comment` properties) where you wish the rule to be applied.
-Overrides the default contexts (see below). Set to `"any"` if you want
-the rule to apply to any jsdoc block throughout your files (as is necessary
-for finding function blocks not attached to a function declaration or
-expression, i.e., `@callback` or `@function` (or its aliases `@func` or
-`@method`) (including those associated with an `@interface`).
-See the ["AST and Selectors"](#user-content-eslint-plugin-jsdoc-advanced-ast-and-selectors)
-section of our README for more on the expected format.
-<a name="user-content-require-returns-type-context-and-settings"></a>
-<a name="require-returns-type-context-and-settings"></a>
-## Context and settings
-|||
-|---|---|
-|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
-|Tags|`returns`|
-|Aliases|`return`|
-|Recommended|true|
-|Options|`contexts`|
-<a name="user-content-require-returns-type-failing-examples"></a>
-<a name="require-returns-type-failing-examples"></a>
-## Failing examples
-The following patterns are considered problems:
-````js
-/**
- * @returns
- */
-function quux () {
-}
-// Message: Missing JSDoc @returns type.
-/**
- * @returns Foo.
- */
-function quux () {
-}
-// Message: Missing JSDoc @returns type.
-/**
- * @returns Foo.
- */
-function quux () {
-}
-// "jsdoc/require-returns-type": ["error"|"warn", {"contexts":["any"]}]
-// Message: Missing JSDoc @returns type.
-/**
- * @function
- * @returns Foo.
- */
-// "jsdoc/require-returns-type": ["error"|"warn", {"contexts":["any"]}]
-// Message: Missing JSDoc @returns type.
-/**
- * @callback
- * @returns Foo.
- */
-// "jsdoc/require-returns-type": ["error"|"warn", {"contexts":["any"]}]
-// Message: Missing JSDoc @returns type.
-/**
- * @return Foo.
- */
-function quux () {
-}
-// Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
-// Message: Missing JSDoc @return type.
-/**
- * @returns
- */
-function quux () {
-}
-// Settings: {"jsdoc":{"tagNamePreference":{"returns":false}}}
-// Message: Unexpected tag `@returns`
-````
-<a name="user-content-require-returns-type-passing-examples"></a>
-<a name="require-returns-type-passing-examples"></a>
-## Passing examples
-The following patterns are not considered problems:
-````js
-/**
- * @returns {number}
- */
-function quux () {
-}
-/**
- * @returns {number}
- */
-function quux () {
-}
-// "jsdoc/require-returns-type": ["error"|"warn", {"contexts":["any"]}]
-/**
- * @function
- * @returns Foo.
- */
-/**
- * @callback
- * @returns Foo.
- */
-````