BREAKING CHANGE(require-description): remove noDefaults option and change contexts to always override defaults

Author: brettz9

.README/rules/require-description.md

@@ -9,19 +9,17 @@ Requires that all functions have a description.
 
 An options object may have any of the following properties:
 
-- `contexts` - Set to a string or array of strings representing the AST context
+- `contexts` - Set to an array of strings representing the AST context
   where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
+  Overrides the defaults.
 - `exemptedBy` - Array of tags (e.g., `['type']`) whose presence on the document
     block avoids the need for a `@description`.
-- `noDefaults` - By default, `contexts` will permit `ArrowFunctionExpression`,
-  `FunctionDeclaration`, and `FunctionExpression`. Set this instead to `true` to
-  have `contexts` override these.
 
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`description`|
 |Aliases|`desc`|
-|Options|`contexts`, `exemptedBy`, `noDefaults`|
+|Options|`contexts`, `exemptedBy`|
 
 <!-- assertions requireDescription -->

src/jsdocUtils.js

@@ -493,22 +493,16 @@ const parseClosureTemplateTag = (tag) => {
  * @returns {string[]}
  */
 const enforcedContexts = (context, defaultContexts) => {
-  /* istanbul ignore next */
-  const defltContexts = defaultContexts === true ? [
-    'ArrowFunctionExpression',
-    'FunctionDeclaration',
-    'FunctionExpression'
-  ] : defaultContexts;
   const {
-    noDefaults,
-    contexts: ctxts = []
+    /* istanbul ignore next */
+    contexts = defaultContexts === true ? [
+      'ArrowFunctionExpression',
+      'FunctionDeclaration',
+      'FunctionExpression'
+    ] : defaultContexts
   } = context.options[0] || {};
 
-  const contexts = typeof ctxts === 'string' ? [ctxts] : ctxts;
-
-  return noDefaults ?
-    contexts :
-    [...new Set([...defltContexts, ...contexts])];
+  return contexts;
 };
 
 const getContextObject = (contexts, checkJsdoc) => {

src/rules/requireDescription.js

@@ -37,26 +37,16 @@ export default iterateJsdoc(({
         additionalProperties: false,
         properties: {
           contexts: {
-            oneOf: [
-              {
-                items: {
-                  type: 'string'
-                },
-                type: 'array'
-              },
-              {
-                type: 'string'
-              }
-            ]
+            items: {
+              type: 'string'
+            },
+            type: 'array'
           },
           exemptedBy: {
             items: {
               type: 'string'
             },
             type: 'array'
-          },
-          noDefaults: {
-            type: 'boolean'
           }
         },
         type: 'object'

test/rules/assertions/requireDescription.js

@@ -31,7 +31,7 @@ export default {
       ],
       options: [
         {
-          contexts: 'ClassDeclaration'
+          contexts: ['ClassDeclaration']
         }
       ]
     },
@@ -51,8 +51,7 @@ export default {
       ],
       options: [
         {
-          contexts: 'ClassDeclaration',
-          noDefaults: true
+          contexts: ['ClassDeclaration']
         }
       ]
     },
@@ -109,8 +108,7 @@ export default {
         {
           contexts: [
             'TSInterfaceDeclaration'
-          ],
-          noDefaults: true
+          ]
         }
       ],
       parser: require.resolve('@typescript-eslint/parser')
@@ -218,7 +216,7 @@ export default {
       `,
       options: [
         {
-          noDefaults: true
+          contexts: ['ClassDeclaration']
         }
       ]
     },