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

brettz9 · chiawendt · commit 7e4a106e6d71 · 2019-06-26T18:52:40.000+08:00
Also reverting for `match-description`
diff --git a/.README/rules/match-description.md b/.README/rules/match-description.md
@@ -73,18 +73,13 @@ it by setting it to `false`.
 
 Set this to a string or array of strings representing the AST context
 where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
-
-##### `noDefaults`
-
-By default, `contexts` will permit `ArrowFunctionExpression`,
-`FunctionDeclaration`, and `FunctionExpression`. Set this instead to `true` to
-have `contexts` override these.
+Overrides the defaults.
 
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|N/A by default but see `tags` options|
 |Settings||
-|Options|`contexts`, `noDefaults`, `tags` (allows for 'param', 'arg', 'argument', 'returns', 'return'), `matchDescription`|
+|Options|`contexts`, `tags` (allows for 'param', 'arg', 'argument', 'returns', 'return'), `matchDescription`|
 
 <!-- assertions matchDescription -->
diff --git a/.README/rules/require-description.md b/.README/rules/require-description.md
@@ -11,17 +11,15 @@ An options object may have any of the following properties:
 
 - `contexts` - Set to a string or 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 -->
diff --git a/.README/rules/require-jsdoc.md b/.README/rules/require-jsdoc.md
@@ -36,8 +36,6 @@ be checked by the rule.
 
 - `contexts` - Set this to a string or array of strings representing the additional
   AST context where you wish the rule to be applied (e.g., `Property` for properties).
-  Note that unlike `require-description` and `match-description`, this rule has no
-  `noDefaults` option because its defaults are instead set up by `require`.
 
 |||
 |---|---|
diff --git a/src/jsdocUtils.js b/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) => {
diff --git a/src/rules/matchDescription.js b/src/rules/matchDescription.js
@@ -71,17 +71,10 @@ export default iterateJsdoc(({
         additionalProperties: false,
         properties: {
           contexts: {
-            oneOf: [
-              {
-                items: {
-                  type: 'string'
-                },
-                type: 'array'
-              },
-              {
-                type: 'string'
-              }
-            ]
+            items: {
+              type: 'string'
+            },
+            type: 'array'
           },
           mainDescription: {
             oneOf: [
@@ -98,10 +91,6 @@ export default iterateJsdoc(({
             format: 'regex',
             type: 'string'
           },
-          noDefaults: {
-            default: false,
-            type: 'boolean'
-          },
           tags: {
             patternProperties: {
               '.*': {
diff --git a/src/rules/requireDescription.js b/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'
diff --git a/src/rules/requireJsdoc.js b/src/rules/requireJsdoc.js
@@ -8,17 +8,10 @@ const OPTIONS_SCHEMA = {
   additionalProperties: false,
   properties: {
     contexts: {
-      oneOf: [
-        {
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        {
-          type: 'string'
-        }
-      ]
+      items: {
+        type: 'string'
+      },
+      type: 'array'
     },
     publicOnly: {
       oneOf: [
diff --git a/test/rules/assertions/matchDescription.js b/test/rules/assertions/matchDescription.js
@@ -19,8 +19,7 @@ export default {
         {
           contexts: [
             'ClassExpression'
-          ],
-          noDefaults: true
+          ]
         }
       ]
     },
@@ -43,8 +42,7 @@ export default {
         {
           contexts: [
             'ObjectExpression'
-          ],
-          noDefaults: true
+          ]
         }
       ]
     },
@@ -461,8 +459,7 @@ export default {
         {
           contexts: [
             'ClassDeclaration'
-          ],
-          noDefaults: true
+          ]
         }
       ]
     },
@@ -485,8 +482,7 @@ export default {
         {
           contexts: [
             'ClassProperty'
-          ],
-          noDefaults: true
+          ]
         }
       ],
       parser: require.resolve('@typescript-eslint/parser')
@@ -510,8 +506,7 @@ export default {
         {
           contexts: [
             'TSInterfaceDeclaration'
-          ],
-          noDefaults: true
+          ]
         }
       ],
       parser: require.resolve('@typescript-eslint/parser')
@@ -535,8 +530,7 @@ export default {
         {
           contexts: [
             'Property'
-          ],
-          noDefaults: true
+          ]
         }
       ]
     }
@@ -784,8 +778,7 @@ export default {
         {
           contexts: [
             'ClassProperty'
-          ],
-          noDefaults: true
+          ]
         }
       ],
       parser: require.resolve('@typescript-eslint/parser')
@@ -803,8 +796,7 @@ export default {
         {
           contexts: [
             'TSInterfaceDeclaration'
-          ],
-          noDefaults: true
+          ]
         }
       ],
       parser: require.resolve('@typescript-eslint/parser')
@@ -821,8 +813,7 @@ export default {
       options: [
         {
           contexts: [
-          ],
-          noDefaults: true
+          ]
         }
       ]
     },
@@ -838,8 +829,7 @@ export default {
       options: [
         {
           contexts: [
-          ],
-          noDefaults: true
+          ]
         }
       ]
     },
@@ -855,8 +845,7 @@ export default {
       options: [
         {
           contexts: [
-          ],
-          noDefaults: true
+          ]
         }
       ]
     }
diff --git a/test/rules/assertions/requireDescription.js b/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']
         }
       ]
     },

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,7 @@ export default {`
`19`	`19`	`{`
`20`	`20`	`contexts: [`
`21`	`21`	`'ClassExpression'`
`22`		`- ],`
`23`		`- noDefaults: true`
	`22`	`+ ]`
`24`	`23`	`}`
`25`	`24`	`]`
`26`	`25`	`},`
`@@ -43,8 +42,7 @@ export default {`
`43`	`42`	`{`
`44`	`43`	`contexts: [`
`45`	`44`	`'ObjectExpression'`
`46`		`- ],`
`47`		`- noDefaults: true`
	`45`	`+ ]`
`48`	`46`	`}`
`49`	`47`	`]`
`50`	`48`	`},`
`@@ -461,8 +459,7 @@ export default {`
`461`	`459`	`{`
`462`	`460`	`contexts: [`
`463`	`461`	`'ClassDeclaration'`
`464`		`- ],`
`465`		`- noDefaults: true`
	`462`	`+ ]`
`466`	`463`	`}`
`467`	`464`	`]`
`468`	`465`	`},`
`@@ -485,8 +482,7 @@ export default {`
`485`	`482`	`{`
`486`	`483`	`contexts: [`
`487`	`484`	`'ClassProperty'`
`488`		`- ],`
`489`		`- noDefaults: true`
	`485`	`+ ]`
`490`	`486`	`}`
`491`	`487`	`],`
`492`	`488`	`parser: require.resolve('@typescript-eslint/parser')`
`@@ -510,8 +506,7 @@ export default {`
`510`	`506`	`{`
`511`	`507`	`contexts: [`
`512`	`508`	`'TSInterfaceDeclaration'`
`513`		`- ],`
`514`		`- noDefaults: true`
	`509`	`+ ]`
`515`	`510`	`}`
`516`	`511`	`],`
`517`	`512`	`parser: require.resolve('@typescript-eslint/parser')`
`@@ -535,8 +530,7 @@ export default {`
`535`	`530`	`{`
`536`	`531`	`contexts: [`
`537`	`532`	`'Property'`
`538`		`- ],`
`539`		`- noDefaults: true`
	`533`	`+ ]`
`540`	`534`	`}`
`541`	`535`	`]`
`542`	`536`	`}`
`@@ -784,8 +778,7 @@ export default {`
`784`	`778`	`{`
`785`	`779`	`contexts: [`
`786`	`780`	`'ClassProperty'`
`787`		`- ],`
`788`		`- noDefaults: true`
	`781`	`+ ]`
`789`	`782`	`}`
`790`	`783`	`],`
`791`	`784`	`parser: require.resolve('@typescript-eslint/parser')`
`@@ -803,8 +796,7 @@ export default {`
`803`	`796`	`{`
`804`	`797`	`contexts: [`
`805`	`798`	`'TSInterfaceDeclaration'`
`806`		`- ],`
`807`		`- noDefaults: true`
	`799`	`+ ]`
`808`	`800`	`}`
`809`	`801`	`],`
`810`	`802`	`parser: require.resolve('@typescript-eslint/parser')`
`@@ -821,8 +813,7 @@ export default {`
`821`	`813`	`options: [`
`822`	`814`	`{`
`823`	`815`	`contexts: [`
`824`		`- ],`
`825`		`- noDefaults: true`
	`816`	`+ ]`
`826`	`817`	`}`
`827`	`818`	`]`
`828`	`819`	`},`
`@@ -838,8 +829,7 @@ export default {`
`838`	`829`	`options: [`
`839`	`830`	`{`
`840`	`831`	`contexts: [`
`841`		`- ],`
`842`		`- noDefaults: true`
	`832`	`+ ]`
`843`	`833`	`}`
`844`	`834`	`]`
`845`	`835`	`},`
`@@ -855,8 +845,7 @@ export default {`
`855`	`845`	`options: [`
`856`	`846`	`{`
`857`	`847`	`contexts: [`
`858`		`- ],`
`859`		`- noDefaults: true`
	`848`	`+ ]`
`860`	`849`	`}`
`861`	`850`	`]`
`862`	`851`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ export default {`
`31`	`31`	`],`
`32`	`32`	`options: [`
`33`	`33`	`{`
`34`		`- contexts: 'ClassDeclaration'`
	`34`	`+ contexts: ['ClassDeclaration']`
`35`	`35`	`}`
`36`	`36`	`]`
`37`	`37`	`},`
`@@ -51,8 +51,7 @@ export default {`
`51`	`51`	`],`
`52`	`52`	`options: [`
`53`	`53`	`{`
`54`		`- contexts: 'ClassDeclaration',`
`55`		`- noDefaults: true`
	`54`	`+ contexts: ['ClassDeclaration']`
`56`	`55`	`}`
`57`	`56`	`]`
`58`	`57`	`},`
`@@ -109,8 +108,7 @@ export default {`
`109`	`108`	`{`
`110`	`109`	`contexts: [`
`111`	`110`	`'TSInterfaceDeclaration'`
`112`		`- ],`
`113`		`- noDefaults: true`
	`111`	`+ ]`
`114`	`112`	`}`
`115`	`113`	`],`
`116`	`114`	`parser: require.resolve('@typescript-eslint/parser')`
`@@ -218,7 +216,7 @@ export default {`
`218`	`216`	`,
`219`	`217`	`options: [`
`220`	`218`	`{`
`221`		`- noDefaults: true`
	`219`	`+ contexts: ['ClassDeclaration']`
`222`	`220`	`}`
`223`	`221`	`]`
`224`	`222`	`},`