fix(jsdoc/examples/rules and jsdoc/default-expressions/rules configs): add @Stylistic, @typescript-eslint, and eslint-plulgin-n equivalents to default disabled rules (#1504)

Author: brettz9

.README/rules/check-examples.md

@@ -135,37 +135,40 @@ by decreasing precedence:
 
 ### Rules Disabled by Default Unless `noDefaultExampleRules` is Set to `true`
 
-* `eol-last` - Insisting that a newline "always" be at the end is less likely
-  to be desired in sample code as with the code file convention.
+* `eol-last` (and `@stylistic/eol-last`) - Insisting that a newline "always"
+  be at the end is less likely to be desired in sample code as with the code
+  file convention.
 * `no-console` - This rule is unlikely to have inadvertent temporary debugging
   within examples.
-* `no-multiple-empty-lines` - This rule may be problematic for projects which
+* `no-multiple-empty-lines` (and `@stylistic/no-multiple-empty-lines`) - This
+  rule may be problematic for projects which
   use an initial newline just to start an example. Also, projects may wish to
   use extra lines within examples just for easier illustration
   purposes.
 * `no-undef` - Many variables in examples will be `undefined`.
 * `no-unused-vars` - It is common to define variables for clarity without
   always using them within examples.
-* `padded-blocks` - It can generally look nicer to pad a little even if one's
-  code follows more stringency as far as block padding.
+* `padded-blocks` (and `@stylistic/padded-blocks`) - It can generally look
+  nicer to pad a little even if one's code follows more stringency as far
+  as block padding.
 * `jsdoc/require-file-overview` - Shouldn't check example for jsdoc blocks.
 * `jsdoc/require-jsdoc` - Wouldn't expect jsdoc blocks within jsdoc blocks.
 * `import/no-unresolved` - One wouldn't generally expect example paths to
   resolve relative to the current JavaScript file as one would with real code.
 * `import/unambiguous` - Snippets in examples are likely too short to always
   include full import/export info.
-* `node/no-missing-import` - See `import/no-unresolved`.
-* `node/no-missing-require` -  See `import/no-unresolved`.
+* `node/no-missing-import` (and `n/no-missing-import`) - See `import/no-unresolved`.
+* `node/no-missing-require` (and `n/no-missing-require`) -  See `import/no-unresolved`.
 
 For `checkDefaults`, `checkParams`, and `checkProperties`, the following
 expression-oriented rules will be used by default as well:
 
-* `quotes` - Will insist on "double".
-* `semi` - Will insist on "never".
+* `quotes` (and `@stylistic/quotes`) - Will insist on "double".
+* `semi` (and `@stylistic/semi`) - Will insist on "never".
 * `strict` - Disabled.
 * `no-empty-function` - Disabled.
 * `no-new` - Disabled.
-* `no-unused-expressions` - Disabled.
+* `no-unused-expressions` (and `@typescript-eslint/no-unused-expressions`) - Disabled.
 * `chai-friendly/no-unused-expressions` - Disabled.
 
 ### Options for checking other than `@example` (`checkDefaults`, `checkParams`, or `checkProperties`)

docs/rules/check-examples.md

@@ -162,37 +162,40 @@ by decreasing precedence:
 <a name="check-examples-options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-checkeslintrc-and-baseconfig-rules-disabled-by-default-unless-nodefaultexamplerules-is-set-to-true"></a>
 ### Rules Disabled by Default Unless <code>noDefaultExampleRules</code> is Set to <code>true</code>
 
-* `eol-last` - Insisting that a newline "always" be at the end is less likely
-  to be desired in sample code as with the code file convention.
+* `eol-last` (and `@stylistic/eol-last`) - Insisting that a newline "always"
+  be at the end is less likely to be desired in sample code as with the code
+  file convention.
 * `no-console` - This rule is unlikely to have inadvertent temporary debugging
   within examples.
-* `no-multiple-empty-lines` - This rule may be problematic for projects which
+* `no-multiple-empty-lines` (and `@stylistic/no-multiple-empty-lines`) - This
+  rule may be problematic for projects which
   use an initial newline just to start an example. Also, projects may wish to
   use extra lines within examples just for easier illustration
   purposes.
 * `no-undef` - Many variables in examples will be `undefined`.
 * `no-unused-vars` - It is common to define variables for clarity without
   always using them within examples.
-* `padded-blocks` - It can generally look nicer to pad a little even if one's
-  code follows more stringency as far as block padding.
+* `padded-blocks` (and `@stylistic/padded-blocks`) - It can generally look
+  nicer to pad a little even if one's code follows more stringency as far
+  as block padding.
 * `jsdoc/require-file-overview` - Shouldn't check example for jsdoc blocks.
 * `jsdoc/require-jsdoc` - Wouldn't expect jsdoc blocks within jsdoc blocks.
 * `import/no-unresolved` - One wouldn't generally expect example paths to
   resolve relative to the current JavaScript file as one would with real code.
 * `import/unambiguous` - Snippets in examples are likely too short to always
   include full import/export info.
-* `node/no-missing-import` - See `import/no-unresolved`.
-* `node/no-missing-require` -  See `import/no-unresolved`.
+* `node/no-missing-import` (and `n/no-missing-import`) - See `import/no-unresolved`.
+* `node/no-missing-require` (and `n/no-missing-require`) -  See `import/no-unresolved`.
 
 For `checkDefaults`, `checkParams`, and `checkProperties`, the following
 expression-oriented rules will be used by default as well:
 
-* `quotes` - Will insist on "double".
-* `semi` - Will insist on "never".
+* `quotes` (and `@stylistic/quotes`) - Will insist on "double".
+* `semi` (and `@stylistic/semi`) - Will insist on "never".
 * `strict` - Disabled.
 * `no-empty-function` - Disabled.
 * `no-new` - Disabled.
-* `no-unused-expressions` - Disabled.
+* `no-unused-expressions` (and `@typescript-eslint/no-unused-expressions`) - Disabled.
 * `chai-friendly/no-unused-expressions` - Disabled.
 
 <a name="user-content-check-examples-options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-checkeslintrc-and-baseconfig-options-for-checking-other-than-example-checkdefaults-checkparams-or-checkproperties"></a>

src/index-cjs.js

@@ -554,6 +554,15 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
     ],
     name: 'jsdoc/examples/rules',
     rules: {
+      // "always" newline rule at end unlikely in sample code
+      '@stylistic/eol-last': 0,
+      // Often wish to start `@example` code after newline; also may use
+      //   empty lines for spacing
+      '@stylistic/no-multiple-empty-lines': 0,
+
+      // Can generally look nicer to pad a little even if code imposes more stringency
+      '@stylistic/padded-blocks': 0,
+
       // "always" newline rule at end unlikely in sample code
       'eol-last': 0,
 
@@ -568,6 +577,11 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
       // The end of a multiline comment would end the comment the example is in.
       'jsdoc/require-jsdoc': 0,
 
+      // See import/no-unresolved
+      'n/no-missing-import': 0,
+
+      'n/no-missing-require': 0,
+
       // Unlikely to have inadvertent debugging within examples
       'no-console': 0,
 
@@ -577,7 +591,6 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
 
       // Many variables in examples will be `undefined`
       'no-undef': 0,
-
       // Common to define variables for clarity without always using them
       'no-unused-vars': 0,
 
@@ -613,6 +626,13 @@ index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config
     name: 'jsdoc/default-expressions/rules',
     rules: {
       ...index.configs.examples[1].rules,
+      '@stylistic/quotes': [
+        'error', 'double',
+      ],
+      '@stylistic/semi': [
+        'error', 'never',
+      ],
+      '@typescript-eslint/no-unused-expressions': 0,
       'chai-friendly/no-unused-expressions': 0,
       'no-empty-function': 0,
       'no-new': 0,

src/index.js

@@ -560,6 +560,15 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
     ],
     name: 'jsdoc/examples/rules',
     rules: {
+      // "always" newline rule at end unlikely in sample code
+      '@stylistic/eol-last': 0,
+      // Often wish to start `@example` code after newline; also may use
+      //   empty lines for spacing
+      '@stylistic/no-multiple-empty-lines': 0,
+
+      // Can generally look nicer to pad a little even if code imposes more stringency
+      '@stylistic/padded-blocks': 0,
+
       // "always" newline rule at end unlikely in sample code
       'eol-last': 0,
 
@@ -574,6 +583,11 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
       // The end of a multiline comment would end the comment the example is in.
       'jsdoc/require-jsdoc': 0,
 
+      // See import/no-unresolved
+      'n/no-missing-import': 0,
+
+      'n/no-missing-require': 0,
+
       // Unlikely to have inadvertent debugging within examples
       'no-console': 0,
 
@@ -583,7 +597,6 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
 
       // Many variables in examples will be `undefined`
       'no-undef': 0,
-
       // Common to define variables for clarity without always using them
       'no-unused-vars': 0,
 
@@ -619,6 +632,13 @@ index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config
     name: 'jsdoc/default-expressions/rules',
     rules: {
       ...index.configs.examples[1].rules,
+      '@stylistic/quotes': [
+        'error', 'double',
+      ],
+      '@stylistic/semi': [
+        'error', 'never',
+      ],
+      '@typescript-eslint/no-unused-expressions': 0,
       'chai-friendly/no-unused-expressions': 0,
       'no-empty-function': 0,
       'no-new': 0,

src/rules/checkExamples.js

@@ -37,6 +37,16 @@ const countChars = (str, ch) => {
 
 /** @type {import('eslint').Linter.RulesRecord} */
 const defaultMdRules = {
+  // "always" newline rule at end unlikely in sample code
+  '@stylistic/eol-last': 0,
+
+  // Often wish to start `@example` code after newline; also may use
+  //   empty lines for spacing
+  '@stylistic/no-multiple-empty-lines': 0,
+
+  // Can generally look nicer to pad a little even if code imposes more stringency
+  '@stylistic/padded-blocks': 0,
+
   // "always" newline rule at end unlikely in sample code
   'eol-last': 0,
 
@@ -51,13 +61,16 @@ const defaultMdRules = {
   // The end of a multiline comment would end the comment the example is in.
   'jsdoc/require-jsdoc': 0,
 
+  // See import/no-unresolved
+  'n/no-missing-import': 0,
+  'n/no-missing-require': 0,
+
   // Unlikely to have inadvertent debugging within examples
   'no-console': 0,
 
   // Often wish to start `@example` code after newline; also may use
   //   empty lines for spacing
   'no-multiple-empty-lines': 0,
-
   // Many variables in examples will be `undefined`
   'no-undef': 0,
 
@@ -66,6 +79,7 @@ const defaultMdRules = {
 
   // See import/no-unresolved
   'node/no-missing-import': 0,
+
   'node/no-missing-require': 0,
 
   // Can generally look nicer to pad a little even if code imposes more stringency
@@ -75,6 +89,13 @@ const defaultMdRules = {
 /** @type {import('eslint').Linter.RulesRecord} */
 const defaultExpressionRules = {
   ...defaultMdRules,
+  '@stylistic/quotes': [
+    'error', 'double',
+  ],
+  '@stylistic/semi': [
+    'error', 'never',
+  ],
+  '@typescript-eslint/no-unused-expressions': 'off',
   'chai-friendly/no-unused-expressions': 'off',
   'no-empty-function': 'off',
   'no-new': 'off',