feat(check-examples): apply to all contexts

Author: brettz9

.README/rules/check-examples.md

@@ -98,7 +98,7 @@ decreasing precedence:
 
 |||
 |---|---|
-|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `FunctionDeclaration`, `FunctionExpression`|
+|Context|everywhere|
 |Tags|`example`|
 |Options| *See above* |
 

README.md

@@ -566,7 +566,7 @@ decreasing precedence:
 
 |||
 |---|---|
-|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `FunctionDeclaration`, `FunctionExpression`|
+|Context|everywhere|
 |Tags|`example`|
 |Options| *See above* |
 
@@ -612,6 +612,16 @@ function quux () {
 // Options: [{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```js ([\\s\\S]*)```"}]
 // Message: @example error (semi): Extra semicolon.
 
+/**
+ * @example
+ * ```js alert('hello'); ```
+ */
+var quux = {
+
+};
+// Options: [{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```js ([\\s\\S]*)```"}]
+// Message: @example error (semi): Extra semicolon.
+
 /**
  * @example ```
  * js alert('hello'); ```
@@ -797,6 +807,16 @@ function quux () {}
  */
 function quux () {}
 // Options: [{"allowInlineConfig":true,"baseConfig":{"rules":{"semi":["error","always"]}},"eslintrcForExamples":false,"noDefaultExampleRules":true}]
+
+/**
+ * @example ```js
+ alert('hello')
+ ```
+ */
+var quux = {
+
+};
+// Options: [{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```js([\\s\\S]*)```"}]
 ````
 
 

src/rules/checkExamples.js

@@ -231,6 +231,7 @@ export default iterateJsdoc(({
     });
   });
 }, {
+  iterateAllJsdocs: true,
   meta: {
     schema: [
       {
@@ -276,11 +277,5 @@ export default iterateJsdoc(({
       }
     ],
     type: 'suggestion'
-  },
-  returns: [
-    'ArrowFunctionExpression',
-    'ClassDeclaration',
-    'FunctionDeclaration',
-    'FunctionExpression'
-  ]
+  }
 });

test/rules/assertions/checkExamples.js

@@ -107,6 +107,31 @@ export default {
         exampleCodeRegex: '```js ([\\s\\S]*)```'
       }]
     },
+    {
+      code: `
+          /**
+           * @example
+           * \`\`\`js alert('hello'); \`\`\`
+           */
+          var quux = {
+
+          };
+      `,
+      errors: [
+        {
+          message: '@example error (semi): Extra semicolon.'
+        }
+      ],
+      options: [{
+        baseConfig: {
+          rules: {
+            semi: ['error', 'never']
+          }
+        },
+        eslintrcForExamples: false,
+        exampleCodeRegex: '```js ([\\s\\S]*)```'
+      }]
+    },
     {
       code: `
           /**
@@ -544,6 +569,27 @@ export default {
         eslintrcForExamples: false,
         noDefaultExampleRules: true
       }]
+    },
+    {
+      code: `
+          /**
+           * @example \`\`\`js
+           alert('hello')
+           \`\`\`
+           */
+          var quux = {
+
+          };
+      `,
+      options: [{
+        baseConfig: {
+          rules: {
+            semi: ['error', 'never']
+          }
+        },
+        eslintrcForExamples: false,
+        exampleCodeRegex: '```js([\\s\\S]*)```'
+      }]
     }
   ]
 };