feat(require-example): move settings to options

gajus · Jul 7, 2019 · 407d3a9 · 407d3a9
1 parent 9f9f4fb
commit 407d3a9
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 20 deletions.
diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -275,9 +275,6 @@ const getSettings = (context) => {
   settings.allowImplementsWithoutParam = _.get(context, 'settings.jsdoc.allowImplementsWithoutParam');
   settings.allowAugmentsExtendsWithoutParam = _.get(context, 'settings.jsdoc.allowAugmentsExtendsWithoutParam');
 
-  // `require-example` only
-  settings.avoidExampleOnConstructors = Boolean(_.get(context, 'settings.jsdoc.avoidExampleOnConstructors'));
-
   return settings;
 };
 

diff --git a/src/rules/requireExample.js b/src/rules/requireExample.js
@@ -1,23 +1,30 @@
 import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
+import warnRemovedSettings from '../warnRemovedSettings';
 
 export default iterateJsdoc(({
   jsdoc,
   report,
   utils,
-  settings
+  context
 }) => {
+  warnRemovedSettings(context, 'require-example');
+
   if (utils.avoidDocs()) {
     return;
   }
 
+  const options = context.options[0] || {
+    avoidExampleOnConstructors: false
+  };
+
   const targetTagName = 'example';
 
   const functionExamples = _.filter(jsdoc.tags, {
     tag: targetTagName
   });
 
-  if (settings.avoidExampleOnConstructors && (
+  if (options.avoidExampleOnConstructors && (
     utils.hasATag([
       'class',
       'constructor'
@@ -46,6 +53,10 @@ export default iterateJsdoc(({
       {
         additionalProperties: false,
         properties: {
+          avoidExampleOnConstructors: {
+            default: false,
+            type: 'boolean'
+          },
           exemptedBy: {
             items: {
               type: 'string'

diff --git a/test/rules/assertions/requireExample.js b/test/rules/assertions/requireExample.js
@@ -30,6 +30,29 @@ export default {
         }
       ]
     },
+    {
+      code: `
+      /**
+       * @constructor
+       */
+      function f () {
+
+      }
+      `,
+      errors: [
+        {
+          message: '`settings.jsdoc.avoidExampleOnConstructors` has been removed, use options in the rule `require-example` instead.'
+        },
+        {
+          message: 'Missing JSDoc @example declaration.'
+        }
+      ],
+      settings: {
+        jsdoc: {
+          avoidExampleOnConstructors: true
+        }
+      }
+    },
     {
       code: `
       /**
@@ -108,11 +131,9 @@ export default {
 
       }
       `,
-      settings: {
-        jsdoc: {
-          avoidExampleOnConstructors: true
-        }
-      }
+      options: [
+        {avoidExampleOnConstructors: true}
+      ]
     },
     {
       code: `
@@ -124,11 +145,9 @@ export default {
 
       }
       `,
-      settings: {
-        jsdoc: {
-          avoidExampleOnConstructors: true
-        }
-      }
+      options: [
+        {avoidExampleOnConstructors: true}
+      ]
     },
     {
       code: `
@@ -141,11 +160,9 @@ export default {
         }
       }
       `,
-      settings: {
-        jsdoc: {
-          avoidExampleOnConstructors: true
-        }
-      }
+      options: [
+        {avoidExampleOnConstructors: true}
+      ]
     },
     {
       code: `