eslint-plugin-jsdoc 3.15.0 → 3.15.1

package/README.md

@@ -23,16 +23,17 @@ JSDoc linting rules for ESLint.
         * [`check-types`](#eslint-plugin-jsdoc-rules-check-types)
         * [`newline-after-description`](#eslint-plugin-jsdoc-rules-newline-after-description)
         * [`no-undefined-types`](#eslint-plugin-jsdoc-rules-no-undefined-types)
-        * [`require-description`](#eslint-plugin-jsdoc-rules-require-description)
         * [`require-description-complete-sentence`](#eslint-plugin-jsdoc-rules-require-description-complete-sentence)
+        * [`require-description`](#eslint-plugin-jsdoc-rules-require-description)
         * [`require-example`](#eslint-plugin-jsdoc-rules-require-example)
         * [`require-hyphen-before-param-description`](#eslint-plugin-jsdoc-rules-require-hyphen-before-param-description)
-        * [`require-param`](#eslint-plugin-jsdoc-rules-require-param)
         * [`require-param-description`](#eslint-plugin-jsdoc-rules-require-param-description)
         * [`require-param-name`](#eslint-plugin-jsdoc-rules-require-param-name)
         * [`require-param-type`](#eslint-plugin-jsdoc-rules-require-param-type)
+        * [`require-param`](#eslint-plugin-jsdoc-rules-require-param)
         * [`require-returns-description`](#eslint-plugin-jsdoc-rules-require-returns-description)
         * [`require-returns-type`](#eslint-plugin-jsdoc-rules-require-returns-type)
+        * [`require-returns`](#eslint-plugin-jsdoc-rules-require-returns)
         * [`valid-types`](#eslint-plugin-jsdoc-rules-valid-types)
 
 
@@ -56,6 +57,7 @@ This table maps the rules between `eslint-plugin-jsdoc` and `jscs-jsdoc`.
 | [`require-param-description`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-description) | [`requireParamDescription`](https://github.com/jscs-dev/jscs-jsdoc#requireparamdescription) |
 | [`require-param-name`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-name) | N/A |
 | [`require-param-type`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type) | [`requireParamTypes`](https://github.com/jscs-dev/jscs-jsdoc#requireparamtypes) |
+| [`require-returns`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns) | [`requireReturn`](https://github.com/jscs-dev/jscs-jsdoc#requirereturn) |
 | [`require-returns-description`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-description) | [`requireReturnDescription`](https://github.com/jscs-dev/jscs-jsdoc#requirereturndescription) |
 | [`require-returns-type`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-type) | [`requireReturnTypes`](https://github.com/jscs-dev/jscs-jsdoc#requirereturntypes) |
 | [`valid-types`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-valid-types) | N/A |
@@ -114,6 +116,7 @@ Finally, enable all of the rules that you would like to use.
         "jsdoc/require-param-description": 1,
         "jsdoc/require-param-name": 1,
         "jsdoc/require-param-type": 1,
+        "jsdoc/require-returns": 1,
         "jsdoc/require-returns-description": 1,
         "jsdoc/require-returns-type": 1,
         "jsdoc/valid-types": 1
@@ -309,7 +312,7 @@ command.
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  * @example alert('hello')
  */
@@ -328,7 +331,7 @@ function quux () {
 
 }
 // Settings: {"jsdoc":{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```js([\\s\\S]*)```"}}
-// Message: undefined
+// Message: @example error (semi): Extra semicolon.
 
 /**
  * @example
@@ -338,7 +341,7 @@ function quux () {
 
 }
 // Settings: {"jsdoc":{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```js ([\\s\\S]*)```"}}
-// Message: undefined
+// Message: @example error (semi): Extra semicolon.
 
 /**
  * @example ```
@@ -348,7 +351,7 @@ function quux () {
 
 }
 // Settings: {"jsdoc":{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```\njs ([\\s\\S]*)```"}}
-// Message: undefined
+// Message: @example error (semi): Extra semicolon.
 
 /**
  * @example <b>Not JavaScript</b>
@@ -363,7 +366,7 @@ function quux2 () {
 
 }
 // Settings: {"jsdoc":{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"rejectExampleCodeRegex":"^\\s*<.*>$"}}
-// Message: undefined
+// Message: @example error (semi): Extra semicolon.
 
 /**
  * @example
@@ -373,7 +376,7 @@ function quux () {
 
 }
 // Settings: {"jsdoc":{"baseConfig":{"rules":{"no-undef":["error"]}},"eslintrcForExamples":false,"noDefaultExampleRules":true}}
-// Message: undefined
+// Message: @example error (semi): Extra semicolon.
 
 /**
  * @example <caption>Valid usage</caption>
@@ -386,7 +389,7 @@ function quux () {
 
 }
 // Settings: {"jsdoc":{"captionRequired":true,"eslintrcForExamples":false}}
-// Message: undefined
+// Message: Caption is expected for examples.
 
 /**
  * @example  quux();
@@ -395,14 +398,14 @@ function quux () {
 
 }
 // Settings: {"jsdoc":{"baseConfig":{"rules":{"indent":["error"]}},"eslintrcForExamples":false,"noDefaultExampleRules":false}}
-// Message: undefined
+// Message: @example error (indent): Expected indentation of 0 spaces but found 1.
 
 /**
  * @example test() // eslint-disable-line semi
  */
 function quux () {}
 // Settings: {"jsdoc":{"eslintrcForExamples":false,"noDefaultExampleRules":true,"reportUnusedDisableDirectives":true}}
-// Message: undefined
+// Message: @example error: Unused eslint-disable directive (no problems were reported from 'semi').
 
 /**
  * @example
@@ -410,12 +413,12 @@ function quux () {}
  */
 function quux () {}
 // Settings: {"jsdoc":{"allowInlineConfig":false,"baseConfig":{"rules":{"semi":["error","always"]}},"eslintrcForExamples":false,"noDefaultExampleRules":true}}
-// Message: undefined
-```
+// Message: @example error (semi): Missing semicolon.
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * @example ```js
  alert('hello');
@@ -476,7 +479,7 @@ function quux () {}
  */
 function quux () {}
 // Settings: {"jsdoc":{"allowInlineConfig":true,"baseConfig":{"rules":{"semi":["error","always"]}},"eslintrcForExamples":false,"noDefaultExampleRules":true}}
-```
+````
 
 
 <a name="eslint-plugin-jsdoc-rules-check-param-names"></a>
@@ -491,7 +494,7 @@ Ensures that parameter names in JSDoc match those in the function declaration.
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  * @param Foo
  */
@@ -552,11 +555,11 @@ function quux (foo) {
 
 }
 // Message: @param "bar" does not match an existing function parameter.
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  *
  */
@@ -633,7 +636,7 @@ function quux ([a, b] = []) {
 function assign (employees) {
 
 };
-```
+````
 
 
 <a name="eslint-plugin-jsdoc-rules-check-param-names-deconstructing-function-parameter"></a>
@@ -736,7 +739,7 @@ version
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  * @Param
  */
@@ -796,11 +799,11 @@ function quux (foo) {
 }
 // Settings: {"jsdoc":{"additionalTagNames":{"customTags":["bar"]}}}
 // Message: Invalid JSDoc tag name "baz".
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * @param foo
  */
@@ -897,7 +900,7 @@ function quux (foo) {
  * @version
  */
 function quux (foo) {}
-```
+````
 
 
 <a name="eslint-plugin-jsdoc-rules-check-types"></a>
@@ -955,7 +958,7 @@ String | **string** | **string** | `("test") instanceof String` -> **`false`**
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  * @param {Number} foo
  */
@@ -987,11 +990,11 @@ function quux (foo, bar, baz) {
 
 }
 // Message: Invalid JSDoc @param "foo" type "Number".
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * @param {number} foo
  * @param {Bar} bar
@@ -1016,7 +1019,7 @@ function quux (foo, bar, baz) {
 function quux (foo, bar, baz) {
 
 }
-```
+````
 
 
 <a name="eslint-plugin-jsdoc-rules-newline-after-description"></a>
@@ -1033,7 +1036,7 @@ This rule takes one argument. If it is `"always"` then a problem is raised when
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  * Foo.
  *
@@ -1058,11 +1061,11 @@ function quux () {
 }
 // Options: ["never"]
 // Message: There must be no newline after the description of the JSDoc block.
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * Foo.
  */
@@ -1097,7 +1100,7 @@ function quux () {
 
 }
 // Options: ["never"]
-```
+````
 
 
 <a name="eslint-plugin-jsdoc-rules-no-undefined-types"></a>
@@ -1115,7 +1118,7 @@ When enabling this rule, types in jsdoc comments will resolve as used variables,
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  * @param {strnig} foo - Bar.
  */
@@ -1123,11 +1126,11 @@ function quux(foo) {
 
 }
 // Message: The type 'strnig' is undefined.
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * @param {string} foo - Bar.
  */
@@ -1194,72 +1197,7 @@ function quux(foo) {
 function quux(foo) {
 
 }
-```
-
-
-<a name="eslint-plugin-jsdoc-rules-require-description"></a>
-### <code>require-description</code>
-
-Requires that all functions have a description.
-
-* All functions must have a `@description` tag.
-* Every description tag must have a non-empty description that explains the purpose of the method.
-
-|||
-|---|---|
-|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
-|Tags|`class`, `example`|
-
-The following patterns are considered problems:
-
-```js
-/**
- *
- */
-function quux () {
-
-}
-// Message: Missing JSDoc @description declaration.
-
-/**
- * @description
- */
-function quux () {
-
-}
-// Message: Missing JSDoc @description description.
-```
-
-The following patterns are not considered problems:
-
-```js
-/**
- * @description
- * // arbitrary description content
- */
-function quux () {
-
-}
-
-/**
- * @description
- * quux(); // does something useful
- */
-function quux () {
-
-}
-
-/**
- * @description <caption>Valid usage</caption>
- * quux(); // does something useful
- *
- * @description <caption>Invalid usage</caption>
- * quux('random unwanted arg'); // results in an error
- */
-function quux () {
-
-}
-```
+````
 
 
 <a name="eslint-plugin-jsdoc-rules-require-description-complete-sentence"></a>
@@ -1279,7 +1217,7 @@ Requires that block description and tag description are written in complete sent
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  * foo.
  */
@@ -1425,11 +1363,11 @@ function quux (foo) {
 
 }
 // Message: Sentence should start with an uppercase character.
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * @param foo - Foo.
  */
@@ -1524,7 +1462,72 @@ function quux () {
 function quux () {
 
 }
-```
+````
+
+
+<a name="eslint-plugin-jsdoc-rules-require-description"></a>
+### <code>require-description</code>
+
+Requires that all functions have a description.
+
+* All functions must have a `@description` tag.
+* Every description tag must have a non-empty description that explains the purpose of the method.
+
+|||
+|---|---|
+|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
+|Tags|`class`, `example`|
+
+The following patterns are considered problems:
+
+````js
+/**
+ *
+ */
+function quux () {
+
+}
+// Message: Missing JSDoc @description declaration.
+
+/**
+ * @description
+ */
+function quux () {
+
+}
+// Message: Missing JSDoc @description description.
+````
+
+The following patterns are not considered problems:
+
+````js
+/**
+ * @description
+ * // arbitrary description content
+ */
+function quux () {
+
+}
+
+/**
+ * @description
+ * quux(); // does something useful
+ */
+function quux () {
+
+}
+
+/**
+ * @description <caption>Valid usage</caption>
+ * quux(); // does something useful
+ *
+ * @description <caption>Invalid usage</caption>
+ * quux('random unwanted arg'); // results in an error
+ */
+function quux () {
+
+}
+````
 
 
 <a name="eslint-plugin-jsdoc-rules-require-example"></a>
@@ -1542,7 +1545,7 @@ Requires that all functions have examples.
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  *
  */
@@ -1558,11 +1561,11 @@ function quux () {
 
 }
 // Message: Missing JSDoc @example description.
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * @example
  * // arbitrary example content
@@ -1589,7 +1592,7 @@ function quux () {
 function quux () {
 
 }
-```
+````
 
 
 <a name="eslint-plugin-jsdoc-rules-require-hyphen-before-param-description"></a>
@@ -1604,7 +1607,7 @@ Requires a hyphen before the `@param` description.
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  * @param foo Foo.
  */
@@ -1612,24 +1615,24 @@ function quux () {
 
 }
 // Message: There must be a hyphen before @param description.
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * @param foo - Foo.
  */
 function quux () {
 
 }
-```
+````
 
 
-<a name="eslint-plugin-jsdoc-rules-require-param"></a>
-### <code>require-param</code>
+<a name="eslint-plugin-jsdoc-rules-require-param-description"></a>
+### <code>require-param-description</code>
 
-Requires that all function parameters are documented.
+Requires that `@param` tag has `description` value.
 
 |||
 |---|---|
@@ -1638,92 +1641,245 @@ Requires that all function parameters are documented.
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
- *
+ * @param foo
  */
 function quux (foo) {
 
 }
-// Message: Missing JSDoc @param "foo" declaration.
+// Message: Missing JSDoc @param "foo" description.
 
 /**
- *
+ * @arg foo
  */
 function quux (foo) {
 
 }
 // Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
-// Message: Missing JSDoc @arg "foo" declaration.
+// Message: Missing JSDoc @arg "foo" description.
+````
+
+The following patterns are not considered problems:
 
+````js
 /**
- * @param foo
+ *
  */
-function quux (foo, bar) {
+function quux (foo) {
 
 }
-// Message: Missing JSDoc @param "bar" declaration.
 
 /**
- * @override
+ * @param foo Foo.
  */
 function quux (foo) {
 
 }
-// Message: Missing JSDoc @param "foo" declaration.
+````
+
 
+<a name="eslint-plugin-jsdoc-rules-require-param-name"></a>
+### <code>require-param-name</code>
+
+Requires that all function parameters have name.
+
+> The `@param` tag requires you to specify the name of the parameter you are documenting. You can also include the parameter's type, enclosed in curly brackets, and a description of the parameter.
+>
+> [JSDoc](http://usejsdoc.org/tags-param.html#overview)
+
+|||
+|---|---|
+|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
+|Tags|`param`|
+
+The following patterns are considered problems:
+
+````js
 /**
- * @implements
+ * @param
  */
 function quux (foo) {
 
 }
-// Message: Missing JSDoc @param "foo" declaration.
+// Message: There must be an identifier after @param type.
 
 /**
- * @augments
+ * @param {string}
  */
 function quux (foo) {
 
 }
-// Message: Missing JSDoc @param "foo" declaration.
+// Message: There must be an identifier after @param tag.
+````
 
+The following patterns are not considered problems:
+
+````js
 /**
- * @extends
+ * @param foo
  */
 function quux (foo) {
 
 }
-// Message: Missing JSDoc @param "foo" declaration.
 
 /**
- * @override
+ * @param {string} foo
  */
-class A {
-  /**
-    *
-    */
-  quux (foo) {
+function quux (foo) {
 
-  }
 }
-// Message: Missing JSDoc @param "foo" declaration.
+````
+
+
+<a name="eslint-plugin-jsdoc-rules-require-param-type"></a>
+### <code>require-param-type</code>
+
+Requires that `@param` tag has `type` value.
+
+|||
+|---|---|
+|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
+|Tags|`param`|
+
+The following patterns are considered problems:
 
+````js
 /**
- * @implements
+ * @param foo
  */
-class A {
-  /**
-   *
-   */
-  quux (foo) {
+function quux (foo) {
 
-  }
 }
-// Message: Missing JSDoc @param "foo" declaration.
+// Message: Missing JSDoc @param "foo" type.
 
 /**
- * @augments
+ * @arg foo
+ */
+function quux (foo) {
+
+}
+// Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
+// Message: Missing JSDoc @arg "foo" type.
+````
+
+The following patterns are not considered problems:
+
+````js
+/**
+ *
+ */
+function quux (foo) {
+
+}
+
+/**
+ * @param {number} foo
+ */
+function quux (foo) {
+
+}
+````
+
+
+<a name="eslint-plugin-jsdoc-rules-require-param"></a>
+### <code>require-param</code>
+
+Requires that all function parameters are documented.
+
+|||
+|---|---|
+|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
+|Tags|`param`|
+
+The following patterns are considered problems:
+
+````js
+/**
+ *
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ *
+ */
+function quux (foo) {
+
+}
+// Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
+// Message: Missing JSDoc @arg "foo" declaration.
+
+/**
+ * @param foo
+ */
+function quux (foo, bar) {
+
+}
+// Message: Missing JSDoc @param "bar" declaration.
+
+/**
+ * @override
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @implements
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @augments
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @extends
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @override
+ */
+class A {
+  /**
+    *
+    */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @implements
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @augments
  */
 class A {
   /**
@@ -1747,11 +1903,11 @@ class A {
   }
 }
 // Message: Missing JSDoc @param "foo" declaration.
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * @param foo
  */
@@ -1937,261 +2093,422 @@ class A {
 
   }
 }
-```
+````
 
 
-<a name="eslint-plugin-jsdoc-rules-require-param-description"></a>
-### <code>require-param-description</code>
+<a name="eslint-plugin-jsdoc-rules-require-returns-description"></a>
+### <code>require-returns-description</code>
 
-Requires that `@param` tag has `description` value.
+Requires that `@returns` tag has `description` value.
 
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
-|Tags|`param`|
+|Tags|`returns`|
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
- * @param foo
+ * @returns
  */
 function quux (foo) {
 
 }
-// Message: Missing JSDoc @param "foo" description.
+// Message: Missing JSDoc @returns description.
 
 /**
- * @arg foo
+ * @return
  */
 function quux (foo) {
 
 }
-// Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
-// Message: Missing JSDoc @arg "foo" description.
-```
+// Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
+// Message: Missing JSDoc @return description.
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  *
  */
-function quux (foo) {
+function quux () {
 
 }
 
 /**
- * @param foo Foo.
+ * @returns Foo.
  */
-function quux (foo) {
+function quux () {
 
 }
-```
-
+````
 
-<a name="eslint-plugin-jsdoc-rules-require-param-name"></a>
-### <code>require-param-name</code>
 
-Requires that all function parameters have name.
+<a name="eslint-plugin-jsdoc-rules-require-returns-type"></a>
+### <code>require-returns-type</code>
 
-> The `@param` tag requires you to specify the name of the parameter you are documenting. You can also include the parameter's type, enclosed in curly brackets, and a description of the parameter.
->
-> [JSDoc](http://usejsdoc.org/tags-param.html#overview)
+Requires that `@returns` tag has `type` value.
 
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
-|Tags|`param`|
+|Tags|`returns`|
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
- * @param
+ * @returns
  */
-function quux (foo) {
+function quux () {
 
 }
-// Message: There must be an identifier after @param type.
+// Message: Missing JSDoc @returns type.
 
 /**
- * @param {string}
+ * @returns Foo.
  */
-function quux (foo) {
+function quux () {
 
 }
-// Message: There must be an identifier after @param tag.
-```
-
-The following patterns are not considered problems:
+// Message: Missing JSDoc @returns type.
 
-```js
 /**
- * @param foo
+ * @return Foo.
  */
-function quux (foo) {
+function quux () {
 
 }
+// Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
+// Message: Missing JSDoc @return type.
+````
 
+The following patterns are not considered problems:
+
+````js
 /**
- * @param {string} foo
+ * @returns {number}
  */
-function quux (foo) {
+function quux () {
 
 }
-```
+````
 
 
-<a name="eslint-plugin-jsdoc-rules-require-param-type"></a>
-### <code>require-param-type</code>
+<a name="eslint-plugin-jsdoc-rules-require-returns"></a>
+### <code>require-returns</code>
 
-Requires that `@param` tag has `type` value.
+Requires returns are documented.
 
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
-|Tags|`param`|
+|Tags|`returns`|
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
- * @param foo
+ *
  */
 function quux (foo) {
 
 }
-// Message: Missing JSDoc @param "foo" type.
+// Message: Missing JSDoc @param "foo" declaration.
 
 /**
- * @arg foo
+ *
  */
 function quux (foo) {
 
 }
 // Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
-// Message: Missing JSDoc @arg "foo" type.
-```
+// Message: Missing JSDoc @arg "foo" declaration.
+
+/**
+ * @param foo
+ */
+function quux (foo, bar) {
+
+}
+// Message: Missing JSDoc @param "bar" declaration.
+
+/**
+ * @override
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @implements
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @augments
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @extends
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @override
+ */
+class A {
+  /**
+    *
+    */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @implements
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @augments
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @extends
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
- *
+ * @param foo
  */
 function quux (foo) {
 
 }
 
 /**
- * @param {number} foo
+ * @inheritdoc
  */
 function quux (foo) {
 
 }
-```
 
+/**
+ * @arg foo
+ */
+function quux (foo) {
 
-<a name="eslint-plugin-jsdoc-rules-require-returns-description"></a>
-### <code>require-returns-description</code>
+}
+// Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
 
-Requires that `@returns` tag has `description` value.
+/**
+ * @override
+ * @param foo
+ */
+function quux (foo) {
 
-|||
-|---|---|
-|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
-|Tags|`returns`|
+}
 
-The following patterns are considered problems:
+/**
+ * @override
+ */
+function quux (foo) {
+
+}
+// Settings: {"jsdoc":{"allowOverrideWithoutParam":true}}
 
-```js
 /**
- * @returns
+ * @implements
  */
 function quux (foo) {
 
 }
-// Message: Missing JSDoc @returns description.
+// Settings: {"jsdoc":{"allowImplementsWithoutParam":true}}
 
 /**
- * @return
+ * @implements
+ * @param foo
  */
 function quux (foo) {
 
 }
-// Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
-// Message: Missing JSDoc @return description.
-```
 
-The following patterns are not considered problems:
+/**
+ * @augments
+ */
+function quux (foo) {
+
+}
+// Settings: {"jsdoc":{"allowAugmentsExtendsWithoutParam":true}}
 
-```js
 /**
- *
+ * @augments
+ * @param foo
  */
-function quux () {
+function quux (foo) {
 
 }
 
 /**
- * @returns Foo.
+ * @extends
  */
-function quux () {
+function quux (foo) {
 
 }
-```
+// Settings: {"jsdoc":{"allowAugmentsExtendsWithoutParam":true}}
 
+/**
+ * @extends
+ * @param foo
+ */
+function quux (foo) {
 
-<a name="eslint-plugin-jsdoc-rules-require-returns-type"></a>
-### <code>require-returns-type</code>
+}
 
-Requires that `@returns` tag has `type` value.
+/**
+ * @override
+ */
+class A {
+  /**
+  * @param foo
+  */
+  quux (foo) {
 
-|||
-|---|---|
-|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
-|Tags|`returns`|
+  }
+}
 
-The following patterns are considered problems:
+/**
+ * @override
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Settings: {"jsdoc":{"allowOverrideWithoutParam":true}}
 
-```js
 /**
- * @returns
+ * @implements
  */
-function quux () {
+class A {
+  /**
+   *
+   */
+  quux (foo) {
 
+  }
 }
-// Message: Missing JSDoc @returns type.
+// Settings: {"jsdoc":{"allowImplementsWithoutParam":true}}
 
 /**
- * @returns Foo.
+ * @implements
  */
-function quux () {
+class A {
+  /**
+   * @param foo
+   */
+  quux (foo) {
 
+  }
 }
-// Message: Missing JSDoc @returns type.
 
 /**
- * @return Foo.
+ * @augments
  */
-function quux () {
+class A {
+  /**
+   *
+   */
+  quux (foo) {
 
+  }
 }
-// Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
-// Message: Missing JSDoc @return type.
-```
+// Settings: {"jsdoc":{"allowAugmentsExtendsWithoutParam":true}}
 
-The following patterns are not considered problems:
+/**
+ * @augments
+ */
+class A {
+  /**
+   * @param foo
+   */
+  quux (foo) {
+
+  }
+}
 
-```js
 /**
- * @returns {number}
+ * @extends
  */
-function quux () {
+class A {
+  /**
+   *
+   */
+  quux (foo) {
 
+  }
 }
-```
+// Settings: {"jsdoc":{"allowAugmentsExtendsWithoutParam":true}}
+
+/**
+ * @extends
+ */
+class A {
+  /**
+   * @param foo
+   */
+  quux (foo) {
+
+  }
+}
+````
 
 
 <a name="eslint-plugin-jsdoc-rules-valid-types"></a>
@@ -2206,7 +2523,7 @@ Requires all types to be valid JSDoc or Closure compiler types without syntax er
 
 The following patterns are considered problems:
 
-```js
+````js
 /**
  * @param {Array<string} foo
  */
@@ -2214,11 +2531,11 @@ function quux() {
 
 }
 // Message: Syntax error in type: Array<string
-```
+````
 
 The following patterns are not considered problems:
 
-```js
+````js
 /**
  * @param {Array<string>} foo
  */
@@ -2239,6 +2556,6 @@ function quux() {
 function quux() {
 
 }
-```
+````
 
 

package/dist/bin/readme-assertions.js

@@ -80,7 +80,7 @@ var updateDocuments = function updateDocuments(assertions) {
       throw new Error('No assertions available for rule "' + ruleName + '".');
     }
 
-    return 'The following patterns are considered problems:\n\n```js\n' + ruleAssertions.invalid.join('\n\n') + '\n```\n\nThe following patterns are not considered problems:\n\n```js\n' + ruleAssertions.valid.join('\n\n') + '\n```\n';
+    return 'The following patterns are considered problems:\n\n````js\n' + ruleAssertions.invalid.join('\n\n') + '\n````\n\nThe following patterns are not considered problems:\n\n````js\n' + ruleAssertions.valid.join('\n\n') + '\n````\n';
   });
 
   _fs.default.writeFileSync(readmeDocumentPath, documentBody);

package/dist/bin/readme-assertions.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/bin/readme-assertions.js"],"names":["trimCode","code","lines","_","trim","split","indendation","length","match","indentSize","map","line","index","slice","join","formatCodeSnippet","setup","paragraphs","push","settings","JSON","stringify","options","errors","message","getAssertions","assertionFiles","glob","sync","path","resolve","__dirname","assertionNames","filePath","basename","assertionCodes","codes","require","invalid","valid","zipObject","updateDocuments","assertions","readmeDocumentPath","documentBody","fs","readFileSync","replace","assertionsBlock","ruleName","ruleAssertions","Error","writeFileSync"],"mappings":";;AAGA;;AACA;;AACA;;AACA;;;;AANA;;;AAQA,IAAMA,QAAQ,GAAG,SAAXA,QAAW,CAACC,IAAD,EAAU;AACzB,MAAIC,KAAK,GAAGC,gBAAEC,IAAF,CAAOH,IAAP,EAAaI,KAAb,CAAmB,IAAnB,CAAZ;;AAEA,MAAMC,WAAW,GAAGJ,KAAK,CAACA,KAAK,CAACK,MAAN,GAAe,CAAhB,CAAL,CAAwBC,KAAxB,CAA8B,MAA9B,CAApB;AAEA,MAAMC,UAAU,GAAGH,WAAW,GAAGA,WAAW,CAAC,CAAD,CAAX,CAAeC,MAAlB,GAA2B,CAAzD;AAEAL,EAAAA,KAAK,GAAGC,gBAAEO,GAAF,CAAMR,KAAN,EAAa,UAACS,IAAD,EAAOC,KAAP,EAAiB;AACpC,QAAIA,KAAK,KAAK,CAAd,EAAiB;AACf,aAAOD,IAAP;AACD;;AAED,WAAOA,IAAI,CAACE,KAAL,CAAWJ,UAAX,CAAP;AACD,GANO,CAAR;AAQA,SAAOP,KAAK,CAACY,IAAN,CAAW,IAAX,CAAP;AACD,CAhBD;;AAkBA,IAAMC,iBAAiB,GAAG,SAApBA,iBAAoB,CAACC,KAAD,EAAW;AACnC,MAAMC,UAAU,GAAG,EAAnB;AAEAA,EAAAA,UAAU,CAACC,IAAX,CAAgBlB,QAAQ,CAACgB,KAAK,CAACf,IAAP,CAAxB;;AAEA,MAAIe,KAAK,CAACG,QAAV,EAAoB;AAClBF,IAAAA,UAAU,CAACC,IAAX,CAAgB,kBAAkBE,IAAI,CAACC,SAAL,CAAeL,KAAK,CAACG,QAArB,CAAlC;AACD;;AAED,MAAIH,KAAK,CAACM,OAAV,EAAmB;AACjBL,IAAAA,UAAU,CAACC,IAAX,CAAgB,iBAAiBE,IAAI,CAACC,SAAL,CAAeL,KAAK,CAACM,OAArB,CAAjC;AACD;;AAED,MAAIN,KAAK,CAACO,MAAV,EAAkB;AAChBN,IAAAA,UAAU,CAACC,IAAX,CAAgB,iBAAiBF,KAAK,CAACO,MAAN,CAAa,CAAb,EAAgBC,OAAjD;AACD;;AAED,SAAOP,UAAU,CAACH,IAAX,CAAgB,IAAhB,CAAP;AACD,CAlBD;;AAoBA,IAAMW,aAAa,GAAG,SAAhBA,aAAgB,GAAM;AAC1B,MAAMC,cAAc,GAAGC,cAAKC,IAAL,CAAUC,cAAKC,OAAL,CAAaC,SAAb,EAAwB,kCAAxB,CAAV,CAAvB;;AAEA,MAAMC,cAAc,GAAG7B,gBAAEO,GAAF,CAAMgB,cAAN,EAAsB,UAACO,QAAD,EAAc;AACzD,WAAOJ,cAAKK,QAAL,CAAcD,QAAd,EAAwB,KAAxB,CAAP;AACD,GAFsB,CAAvB;;AAIA,MAAME,cAAc,GAAGhC,gBAAEO,GAAF,CAAMgB,cAAN,EAAsB,UAACO,QAAD,EAAc;AACzD;AACA,QAAMG,KAAK,GAAGC,OAAO,CAACJ,QAAD,CAArB;;AAEA,WAAO;AACLK,MAAAA,OAAO,EAAEnC,gBAAEO,GAAF,CAAM0B,KAAK,CAACE,OAAZ,EAAqBvB,iBAArB,CADJ;AAELwB,MAAAA,KAAK,EAAEpC,gBAAEO,GAAF,CAAM0B,KAAK,CAACG,KAAZ,EAAmBxB,iBAAnB;AAFF,KAAP;AAID,GARsB,CAAvB;;AAUA,SAAOZ,gBAAEqC,SAAF,CAAYR,cAAZ,EAA4BG,cAA5B,CAAP;AACD,CAlBD;;AAoBA,IAAMM,eAAe,GAAG,SAAlBA,eAAkB,CAACC,UAAD,EAAgB;AACtC,MAAMC,kBAAkB,GAAGd,cAAKf,IAAL,CAAUiB,SAAV,EAAqB,iBAArB,CAA3B;;AAEA,MAAIa,YAAY,GAAGC,YAAGC,YAAH,CAAgBH,kBAAhB,EAAoC,MAApC,CAAnB;;AAEAC,EAAAA,YAAY,GAAGA,YAAY,CAACG,OAAb,CAAqB,iCAArB,EAAwD,UAACC,eAAD,EAAqB;AAC1F,QAAMC,QAAQ,GAAGD,eAAe,CAACxC,KAAhB,CAAsB,sBAAtB,EAA8C,CAA9C,CAAjB;AACA,QAAM0C,cAAc,GAAGR,UAAU,CAACO,QAAD,CAAjC;;AAEA,QAAI,CAACC,cAAL,EAAqB;AACnB,YAAM,IAAIC,KAAJ,CAAU,uCAAuCF,QAAvC,GAAkD,IAA5D,CAAN;AACD;;AAED,WAAO,+DAA+DC,cAAc,CAACZ,OAAf,CAAuBxB,IAAvB,CAA4B,MAA5B,CAA/D,GACL,yEADK,GACuEoC,cAAc,CAACX,KAAf,CAAqBzB,IAArB,CAA0B,MAA1B,CADvE,GAC2G,SADlH;AAED,GAVc,CAAf;;AAYA+B,cAAGO,aAAH,CAAiBT,kBAAjB,EAAqCC,YAArC;AACD,CAlBD;;AAoBAH,eAAe,CAAChB,aAAa,EAAd,CAAf","sourcesContent":["/**\n * This script is used to inline assertions into the README.md documents.\n */\nimport path from 'path';\nimport fs from 'fs';\nimport _ from 'lodash';\nimport glob from 'glob';\n\nconst trimCode = (code) => {\n  let lines = _.trim(code).split('\\n');\n\n  const indendation = lines[lines.length - 1].match(/^\\s+/);\n\n  const indentSize = indendation ? indendation[0].length : 0;\n\n  lines = _.map(lines, (line, index) => {\n    if (index === 0) {\n      return line;\n    }\n\n    return line.slice(indentSize);\n  });\n\n  return lines.join('\\n');\n};\n\nconst formatCodeSnippet = (setup) => {\n  const paragraphs = [];\n\n  paragraphs.push(trimCode(setup.code));\n\n  if (setup.settings) {\n    paragraphs.push('// Settings: ' + JSON.stringify(setup.settings));\n  }\n\n  if (setup.options) {\n    paragraphs.push('// Options: ' + JSON.stringify(setup.options));\n  }\n\n  if (setup.errors) {\n    paragraphs.push('// Message: ' + setup.errors[0].message);\n  }\n\n  return paragraphs.join('\\n');\n};\n\nconst getAssertions = () => {\n  const assertionFiles = glob.sync(path.resolve(__dirname, '../../test/rules/assertions/*.js'));\n\n  const assertionNames = _.map(assertionFiles, (filePath) => {\n    return path.basename(filePath, '.js');\n  });\n\n  const assertionCodes = _.map(assertionFiles, (filePath) => {\n    // eslint-disable-next-line global-require, import/no-dynamic-require\n    const codes = require(filePath);\n\n    return {\n      invalid: _.map(codes.invalid, formatCodeSnippet),\n      valid: _.map(codes.valid, formatCodeSnippet)\n    };\n  });\n\n  return _.zipObject(assertionNames, assertionCodes);\n};\n\nconst updateDocuments = (assertions) => {\n  const readmeDocumentPath = path.join(__dirname, '../../README.md');\n\n  let documentBody = fs.readFileSync(readmeDocumentPath, 'utf8');\n\n  documentBody = documentBody.replace(/<!-- assertions ([a-z]+?) -->/ig, (assertionsBlock) => {\n    const ruleName = assertionsBlock.match(/assertions ([a-z]+)/i)[1];\n    const ruleAssertions = assertions[ruleName];\n\n    if (!ruleAssertions) {\n      throw new Error('No assertions available for rule \"' + ruleName + '\".');\n    }\n\n    return 'The following patterns are considered problems:\\n\\n```js\\n' + ruleAssertions.invalid.join('\\n\\n') +\n      '\\n```\\n\\nThe following patterns are not considered problems:\\n\\n```js\\n' + ruleAssertions.valid.join('\\n\\n') + '\\n```\\n';\n  });\n\n  fs.writeFileSync(readmeDocumentPath, documentBody);\n};\n\nupdateDocuments(getAssertions());\n"],"file":"readme-assertions.js"}
+{"version":3,"sources":["../../src/bin/readme-assertions.js"],"names":["trimCode","code","lines","_","trim","split","indendation","length","match","indentSize","map","line","index","slice","join","formatCodeSnippet","setup","paragraphs","push","settings","JSON","stringify","options","errors","message","getAssertions","assertionFiles","glob","sync","path","resolve","__dirname","assertionNames","filePath","basename","assertionCodes","codes","require","invalid","valid","zipObject","updateDocuments","assertions","readmeDocumentPath","documentBody","fs","readFileSync","replace","assertionsBlock","ruleName","ruleAssertions","Error","writeFileSync"],"mappings":";;AAGA;;AACA;;AACA;;AACA;;;;AANA;;;AAQA,IAAMA,QAAQ,GAAG,SAAXA,QAAW,CAACC,IAAD,EAAU;AACzB,MAAIC,KAAK,GAAGC,gBAAEC,IAAF,CAAOH,IAAP,EAAaI,KAAb,CAAmB,IAAnB,CAAZ;;AAEA,MAAMC,WAAW,GAAGJ,KAAK,CAACA,KAAK,CAACK,MAAN,GAAe,CAAhB,CAAL,CAAwBC,KAAxB,CAA8B,MAA9B,CAApB;AAEA,MAAMC,UAAU,GAAGH,WAAW,GAAGA,WAAW,CAAC,CAAD,CAAX,CAAeC,MAAlB,GAA2B,CAAzD;AAEAL,EAAAA,KAAK,GAAGC,gBAAEO,GAAF,CAAMR,KAAN,EAAa,UAACS,IAAD,EAAOC,KAAP,EAAiB;AACpC,QAAIA,KAAK,KAAK,CAAd,EAAiB;AACf,aAAOD,IAAP;AACD;;AAED,WAAOA,IAAI,CAACE,KAAL,CAAWJ,UAAX,CAAP;AACD,GANO,CAAR;AAQA,SAAOP,KAAK,CAACY,IAAN,CAAW,IAAX,CAAP;AACD,CAhBD;;AAkBA,IAAMC,iBAAiB,GAAG,SAApBA,iBAAoB,CAACC,KAAD,EAAW;AACnC,MAAMC,UAAU,GAAG,EAAnB;AAEAA,EAAAA,UAAU,CAACC,IAAX,CAAgBlB,QAAQ,CAACgB,KAAK,CAACf,IAAP,CAAxB;;AAEA,MAAIe,KAAK,CAACG,QAAV,EAAoB;AAClBF,IAAAA,UAAU,CAACC,IAAX,CAAgB,kBAAkBE,IAAI,CAACC,SAAL,CAAeL,KAAK,CAACG,QAArB,CAAlC;AACD;;AAED,MAAIH,KAAK,CAACM,OAAV,EAAmB;AACjBL,IAAAA,UAAU,CAACC,IAAX,CAAgB,iBAAiBE,IAAI,CAACC,SAAL,CAAeL,KAAK,CAACM,OAArB,CAAjC;AACD;;AAED,MAAIN,KAAK,CAACO,MAAV,EAAkB;AAChBN,IAAAA,UAAU,CAACC,IAAX,CAAgB,iBAAiBF,KAAK,CAACO,MAAN,CAAa,CAAb,EAAgBC,OAAjD;AACD;;AAED,SAAOP,UAAU,CAACH,IAAX,CAAgB,IAAhB,CAAP;AACD,CAlBD;;AAoBA,IAAMW,aAAa,GAAG,SAAhBA,aAAgB,GAAM;AAC1B,MAAMC,cAAc,GAAGC,cAAKC,IAAL,CAAUC,cAAKC,OAAL,CAAaC,SAAb,EAAwB,kCAAxB,CAAV,CAAvB;;AAEA,MAAMC,cAAc,GAAG7B,gBAAEO,GAAF,CAAMgB,cAAN,EAAsB,UAACO,QAAD,EAAc;AACzD,WAAOJ,cAAKK,QAAL,CAAcD,QAAd,EAAwB,KAAxB,CAAP;AACD,GAFsB,CAAvB;;AAIA,MAAME,cAAc,GAAGhC,gBAAEO,GAAF,CAAMgB,cAAN,EAAsB,UAACO,QAAD,EAAc;AACzD;AACA,QAAMG,KAAK,GAAGC,OAAO,CAACJ,QAAD,CAArB;;AAEA,WAAO;AACLK,MAAAA,OAAO,EAAEnC,gBAAEO,GAAF,CAAM0B,KAAK,CAACE,OAAZ,EAAqBvB,iBAArB,CADJ;AAELwB,MAAAA,KAAK,EAAEpC,gBAAEO,GAAF,CAAM0B,KAAK,CAACG,KAAZ,EAAmBxB,iBAAnB;AAFF,KAAP;AAID,GARsB,CAAvB;;AAUA,SAAOZ,gBAAEqC,SAAF,CAAYR,cAAZ,EAA4BG,cAA5B,CAAP;AACD,CAlBD;;AAoBA,IAAMM,eAAe,GAAG,SAAlBA,eAAkB,CAACC,UAAD,EAAgB;AACtC,MAAMC,kBAAkB,GAAGd,cAAKf,IAAL,CAAUiB,SAAV,EAAqB,iBAArB,CAA3B;;AAEA,MAAIa,YAAY,GAAGC,YAAGC,YAAH,CAAgBH,kBAAhB,EAAoC,MAApC,CAAnB;;AAEAC,EAAAA,YAAY,GAAGA,YAAY,CAACG,OAAb,CAAqB,iCAArB,EAAwD,UAACC,eAAD,EAAqB;AAC1F,QAAMC,QAAQ,GAAGD,eAAe,CAACxC,KAAhB,CAAsB,sBAAtB,EAA8C,CAA9C,CAAjB;AACA,QAAM0C,cAAc,GAAGR,UAAU,CAACO,QAAD,CAAjC;;AAEA,QAAI,CAACC,cAAL,EAAqB;AACnB,YAAM,IAAIC,KAAJ,CAAU,uCAAuCF,QAAvC,GAAkD,IAA5D,CAAN;AACD;;AAED,WAAO,gEAAgEC,cAAc,CAACZ,OAAf,CAAuBxB,IAAvB,CAA4B,MAA5B,CAAhE,GACL,2EADK,GACyEoC,cAAc,CAACX,KAAf,CAAqBzB,IAArB,CAA0B,MAA1B,CADzE,GAC6G,UADpH;AAED,GAVc,CAAf;;AAYA+B,cAAGO,aAAH,CAAiBT,kBAAjB,EAAqCC,YAArC;AACD,CAlBD;;AAoBAH,eAAe,CAAChB,aAAa,EAAd,CAAf","sourcesContent":["/**\n * This script is used to inline assertions into the README.md documents.\n */\nimport path from 'path';\nimport fs from 'fs';\nimport _ from 'lodash';\nimport glob from 'glob';\n\nconst trimCode = (code) => {\n  let lines = _.trim(code).split('\\n');\n\n  const indendation = lines[lines.length - 1].match(/^\\s+/);\n\n  const indentSize = indendation ? indendation[0].length : 0;\n\n  lines = _.map(lines, (line, index) => {\n    if (index === 0) {\n      return line;\n    }\n\n    return line.slice(indentSize);\n  });\n\n  return lines.join('\\n');\n};\n\nconst formatCodeSnippet = (setup) => {\n  const paragraphs = [];\n\n  paragraphs.push(trimCode(setup.code));\n\n  if (setup.settings) {\n    paragraphs.push('// Settings: ' + JSON.stringify(setup.settings));\n  }\n\n  if (setup.options) {\n    paragraphs.push('// Options: ' + JSON.stringify(setup.options));\n  }\n\n  if (setup.errors) {\n    paragraphs.push('// Message: ' + setup.errors[0].message);\n  }\n\n  return paragraphs.join('\\n');\n};\n\nconst getAssertions = () => {\n  const assertionFiles = glob.sync(path.resolve(__dirname, '../../test/rules/assertions/*.js'));\n\n  const assertionNames = _.map(assertionFiles, (filePath) => {\n    return path.basename(filePath, '.js');\n  });\n\n  const assertionCodes = _.map(assertionFiles, (filePath) => {\n    // eslint-disable-next-line global-require, import/no-dynamic-require\n    const codes = require(filePath);\n\n    return {\n      invalid: _.map(codes.invalid, formatCodeSnippet),\n      valid: _.map(codes.valid, formatCodeSnippet)\n    };\n  });\n\n  return _.zipObject(assertionNames, assertionCodes);\n};\n\nconst updateDocuments = (assertions) => {\n  const readmeDocumentPath = path.join(__dirname, '../../README.md');\n\n  let documentBody = fs.readFileSync(readmeDocumentPath, 'utf8');\n\n  documentBody = documentBody.replace(/<!-- assertions ([a-z]+?) -->/ig, (assertionsBlock) => {\n    const ruleName = assertionsBlock.match(/assertions ([a-z]+)/i)[1];\n    const ruleAssertions = assertions[ruleName];\n\n    if (!ruleAssertions) {\n      throw new Error('No assertions available for rule \"' + ruleName + '\".');\n    }\n\n    return 'The following patterns are considered problems:\\n\\n````js\\n' + ruleAssertions.invalid.join('\\n\\n') +\n      '\\n````\\n\\nThe following patterns are not considered problems:\\n\\n````js\\n' + ruleAssertions.valid.join('\\n\\n') + '\\n````\\n';\n  });\n\n  fs.writeFileSync(readmeDocumentPath, documentBody);\n};\n\nupdateDocuments(getAssertions());\n"],"file":"readme-assertions.js"}

package/package.json

@@ -60,5 +60,5 @@
     "lint": "eslint ./src ./test",
     "test": "mocha --recursive --require @babel/register"
   },
-  "version": "3.15.0"
+  "version": "3.15.1"
 }