@cto.af/eslint-config 3.0.2 → 4.0.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Joe Hildebrand
+Copyright (c) 2024 Joe Hildebrand
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/README.md

@@ -1 +1,60 @@
-EsLint rules for [cto.af](https://cto.af) projects.
+# @cto-af/eslint-config
+
+EsLint rules for [cto.af](https://cto.af) projects, using ESLint flat configs.
+
+## Install
+
+```sh
+npm install -D eslint @cto-af/eslint-config
+```
+
+Optionally:
+```sh
+npm install -D typescript-eslint typescript eslint-plugin-ava eslint-plugin-jsdoc eslint-plugin-markdown
+```
+
+## CommonJS project:
+
+eslint.config.js
+
+```cjs
+module.exports = require('@cto.af/eslint-config');
+```
+
+## ES6 project:
+
+eslint.config.js
+
+```mjs
+import es6 from '@cto.af/eslint-config/es6.js';
+
+export default es6;
+```
+
+## TS Project:
+
+eslint.config.js:
+
+```mjs
+import es6 from '@cto.af/eslint-config/es6.js';
+import ts from '@cto.af/eslint-config/ts.js';
+
+export default [
+  ...es6,
+  ts,
+];
+```
+
+## Turn on everything:
+
+eslint.config.js:
+
+```mjs
+import all from '@cto.af/eslint-config/all.js';
+import mod from '@cto.af/eslint-config/module.js';
+
+export default [
+  ...all,
+  mod,
+];
+```

package/all.js

@@ -0,0 +1,13 @@
+'use strict';
+
+// Turn on everything.  Requires all of the optional dependencies.
+module.exports = [
+  ...require('./ignores.js'),
+  ...require('./js'),
+  ...require('./mjs'),
+  ...require('./ts'),
+  ...require('./jsdoc'),
+  ...require('./jsdoc_ts'),
+  ...require('./ava'),
+  ...require('./markdown'),
+];

package/allModule.js

@@ -0,0 +1,6 @@
+'use strict';
+
+module.exports = [
+  ...require('./all.js'),
+  ...require('./module.js'),
+];

package/ava.js

@@ -1,57 +1,17 @@
 'use strict';
 
-// Intended to be used in the `test` subdir, with:
-//
-// module.exports = {
-//   extends: '@cto.af/eslint-config/ava'
-// }
-//
-// and a root config like:
-//
-// module.exports = {
-//   root: true,
-//   extends: '@cto.af'
-// }
-
-module.exports = {
-  plugins: [
-    'ava',
+const {rules} = require('./rules/ava.js');
+module.exports = [{
+  files: [
+    'test/**.test.*',
+    'test/**.ava.*',
+    'test/**.spec.*',
+    'ava/**.test.*',
+    'ava/**.ava.*',
+    'ava/**.spec.*',
   ],
-  rules: {
-    'ava/assertion-arguments': 'error',
-    'ava/hooks-order': 'error',
-    'ava/max-asserts': 'off',
-    'ava/no-async-fn-without-await': 'error',
-    'ava/no-duplicate-modifiers': 'error',
-    'ava/no-identical-title': 'error',
-    'ava/no-ignored-test-files': 'off', // Buggy
-    'ava/no-incorrect-deep-equal': 'error',
-    'ava/no-import-test-files': 'error',
-    'ava/no-inline-assertions': 'error',
-    'ava/no-nested-tests': 'error',
-    'ava/no-only-test': 'error',
-    'ava/no-skip-assert': 'error',
-    'ava/no-skip-test': 'error',
-    'ava/no-todo-implementation': 'error',
-    'ava/no-todo-test': 'error',
-    'ava/no-unknown-modifiers': 'error',
-    'ava/prefer-async-await': 'error',
-    'ava/prefer-power-assert': 'off',
-    'ava/prefer-t-regex': 'error',
-    'ava/test-title-format': 'error',
-    'ava/test-title': 'error',
-    'ava/use-t-throws-async-well': 'error',
-    'ava/use-t-well': 'error',
-    'ava/use-t': 'error',
-    'ava/use-test': 'error',
-    'ava/use-true-false': 'off',
-
-    // [Possible Errors](https://github.com/eslint-community/eslint-plugin-n#possible-errors)
-    'n/no-extraneous-import': ['error', {
-      // This is an extraneous error because of the way ava is built and the
-      // way that esplugin-n finds depedencies.
-      allowModules: ['ava'],
-    }],
-    'n/no-extraneous-require': ['error', {allowModules: ['ava']}],
+  plugins: {
+    ava: require('eslint-plugin-ava'),
   },
-};
+  rules,
+}];

package/es6.js

@@ -0,0 +1,7 @@
+'use strict';
+
+// Turn on es6 modules
+module.exports = [
+  ...require('./index'),
+  ...require('./module'),
+];

package/globals.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('globals');

package/ignores.js

@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports = [{
+  ignores: [
+    'coverage/**',
+    'node_modules/**',
+    'docs/**',
+  ],
+}];

package/index.js

@@ -1,394 +1,8 @@
 'use strict';
 
-module.exports = {
-  env: {
-    node: true,
-    es6: true,
-    es2021: true,
-  },
-  plugins: [
-    'n',
-  ],
-  ignorePatterns: [
-    'coverage/',
-    'node_modules/',
-    'docs/',
-  ],
-  parserOptions: {
-    ecmaVersion: 2020,
-  },
-  reportUnusedDisableDirectives: true,
-  rules: {
-    // Last updated 2023-06-26, v8.43.0
-    // eslint-plugin-n 16.0.1
-
-    // [Possible Problems](https://eslint.org/docs/rules/#possible-problems)
-    'array-callback-return': ['error', {allowImplicit: true}],
-    'constructor-super': 'error',
-    'for-direction': 'error',
-    'getter-return': 'error',
-    'no-async-promise-executor': 'error',
-    'no-await-in-loop': 'off', // I'll figure these out myself.
-    'no-class-assign': 'error',
-    'no-compare-neg-zero': 'error',
-    'no-cond-assign': 'error',
-    'no-const-assign': 'error',
-    'no-constant-binary-expression': 'error',
-    'no-constant-condition': 'error',
-    'no-constructor-return': 'error',
-    'no-control-regex': 'error',
-    'no-debugger': 'error',
-    'no-dupe-args': 'error',
-    'no-dupe-class-members': 'error',
-    'no-dupe-else-if': 'error',
-    'no-dupe-keys': 'error',
-    'no-duplicate-case': 'error',
-    'no-duplicate-imports': 'error',
-    'no-empty-character-class': 'error',
-    'no-empty-pattern': 'error',
-    'no-ex-assign': 'error',
-    'no-fallthrough': 'error',
-    'no-func-assign': 'error',
-    'no-import-assign': 'error',
-    'no-inner-declarations': 'error',
-    'no-invalid-regexp': 'error',
-    'no-irregular-whitespace': 'error',
-    'no-loss-of-precision': 'error',
-    'no-misleading-character-class': 'error',
-    'no-new-native-nonconstructor': 'error',
-    'no-new-symbol': 'error',
-    'no-obj-calls': 'error',
-    'no-promise-executor-return': 'error',
-    'no-prototype-builtins': 'error',
-    'no-self-assign': 'error',
-    'no-self-compare': 'error',
-    'no-setter-return': 'error',
-    'no-sparse-arrays': 'error',
-    'no-template-curly-in-string': 'error',
-    'no-this-before-super': 'error',
-    'no-undef': 'error',
-    'no-unexpected-multiline': 'error',
-    'no-unmodified-loop-condition': 'error',
-    'no-unreachable': 'error',
-    'no-unreachable-loop': 'error',
-    'no-unsafe-finally': 'error',
-    'no-unsafe-negation': 'error',
-    'no-unsafe-optional-chaining': 'error',
-    'no-unused-private-class-members': 'error',
-    'no-unused-vars': [
-      'error', {
-        args: 'none',
-        argsIgnorePattern: '^_',
-        caughtErrors: 'all',
-        caughtErrorsIgnorePattern: '^(_|ignore)',
-        varsIgnorePattern: '^_',
-      },
-    ],
-    'no-use-before-define': 'error',
-    'no-useless-backreference': 'error',
-    'require-atomic-updates': 'error',
-    'use-isnan': 'error',
-    'valid-typeof': ['error', {requireStringLiterals: true}],
-
-    // [Suggestions](https://eslint.org/docs/rules/#suggestions)
-    'accessor-pairs': 'error',
-    'arrow-body-style': ['error', 'as-needed'],
-    'block-scoped-var': 'error',
-    'camelcase': 'off', // If I had started with this.
-    'capitalized-comments': ['error', 'always', {
-      ignoreConsecutiveComments: true,
-      ignorePattern: 'c8',
-    }],
-    'class-methods-use-this': 'warn',
-    // This one is pedantic even for me.
-    'complexity': 'off',
-    'consistent-return': 'error',
-    'consistent-this': 'off', // Not needed anymore with =>
-    'curly': ['error', 'multi-line'],
-    // I use exhastive cases a lot, which makes the default unreachable
-    'default-case': 'off',
-    'default-case-last': 'error',
-    'default-param-last': 'error',
-    'dot-notation': 'error',
-    'eqeqeq': ['error', 'always', {null: 'ignore'}],
-    'func-name-matching': 'error',
-    'func-names': ['error', 'as-needed'],
-    'func-style': ['error', 'declaration', {allowArrowFunctions: true}],
-    'grouped-accessor-pairs': 'error',
-    'guard-for-in': 'error',
-    'id-denylist': 'off', // Not needed
-    'id-length': 'off', // Not needed
-    'id-match': 'off', // Not needed
-    'init-declarations': 'error',
-    'logical-assignment-operators': 'off', // No.
-    'max-classes-per-file': 'off', // No.
-    'max-depth': 'off', // No.
-    'max-lines': 'off', // No.
-    'max-lines-per-function': 'off', // No.
-    'max-nested-callbacks': 'off', // No.
-    'max-params': ['error', 4],
-    'max-statements': 'off', // No.
-    'multiline-comment-style': ['error', 'separate-lines'],
-    'new-cap': 'error',
-    'no-array-constructor': 'error',
-    'no-alert': 'error',
-    'no-bitwise': 'off', // Lol.  Not in these projects
-    'no-caller': 'error',
-    'no-case-declarations': 'error',
-    'no-confusing-arrow': 'error',
-    'no-console': 'error',
-    'no-continue': 'off', // Why?
-    'no-delete-var': 'error',
-    'no-div-regex': 'error',
-    'no-else-return': 'error',
-    'no-empty': 'error',
-    'no-empty-function': 'error',
-    'no-empty-static-block': 'error',
-    'no-eq-null': 'off', // I disagree with this one.
-    'no-eval': 'error',
-    'no-extend-native': 'error',
-    'no-extra-bind': 'error',
-    'no-extra-boolean-cast': 'error',
-    'no-extra-label': 'error',
-    'no-extra-semi': 'error',
-    'no-floating-decimal': 'error',
-    'no-global-assign': 'error',
-    'no-implicit-coercion': 'error',
-    'no-implicit-globals': 'error',
-    'no-implied-eval': 'error',
-    'no-inline-comments': 'off', // Meta.
-    'no-invalid-this': 'error',
-    'no-iterator': 'error',
-    'no-label-var': 'error',
-    'no-labels': 'error',
-    'no-lone-blocks': 'error',
-    'no-lonely-if': 'error',
-    'no-loop-func': 'error',
-    // No shot at this for node-cbor.  For other projects, yes.
-    'no-magic-numbers': 'off',
-    'no-mixed-operators': 'error',
-    'no-multi-assign': 'error',
-    'no-multi-str': 'error',
-    'no-negated-condition': 'error',
-    'no-nested-ternary': 'error',
-    'no-new': 'error',
-    'no-new-func': 'error',
-    'no-new-wrappers': 'warn',
-    'no-nonoctal-decimal-escape': 'error',
-    'no-object-constructor': 'error',
-    'no-octal': 'error',
-    'no-octal-escape': 'warn',
-    'no-param-reassign': 'off', // I do this all the time.
-    'no-plusplus': 'off', // What?
-    'no-proto': 'error',
-    'no-redeclare': 'error',
-    'no-regex-spaces': 'error',
-    'no-restricted-exports': 'off', // Not needed
-    'no-restricted-globals': 'off', // Not needed
-    'no-restricted-imports': 'off', // Not needed
-    'no-restricted-properties': 'off', // Not needed
-    'no-restricted-syntax': 'off', // Not needed
-    'no-return-assign': 'error',
-    'no-script-url': 'error',
-    'no-sequences': 'error',
-    'no-shadow': 'error',
-    'no-shadow-restricted-names': 'error',
-    'no-ternary': 'off', // No.
-    'no-throw-literal': 'error',
-    'no-undef-init': 'off', // Turns out I need this often enough
-    'no-undefined': 'off', // No.
-    'no-underscore-dangle': 'off', // Maybe one day.
-    'no-unneeded-ternary': 'error',
-    'no-unused-expressions': ['error', {allowShortCircuit: true}],
-    'no-unused-labels': 'error',
-    'no-useless-call': 'error',
-    'no-useless-catch': 'error',
-    'no-useless-computed-key': 'error',
-    'no-useless-concat': 'error',
-    'no-useless-constructor': 'off', // I like useless constructors
-    'no-useless-escape': 'error',
-    'no-useless-rename': 'error',
-    'no-useless-return': 'error',
-    'no-var': 'error',
-    'no-void': 'error',
-    'no-warning-comments': 'off', // Only turn this on periodically
-    'no-with': 'error',
-    'object-shorthand': 'error',
-    'one-var': ['error', 'never'],
-    'one-var-declaration-per-line': 'error',
-    'operator-assignment': 'error',
-    'prefer-arrow-callback': 'error',
-    'prefer-const': 'error',
-    'prefer-destructuring': 'error',
-    'prefer-exponentiation-operator': 'error',
-    'prefer-named-capture-group': 'error',
-    'prefer-numeric-literals': 'error',
-    'prefer-object-has-own': 'off', // Not yet
-    'prefer-object-spread': 'error',
-    'prefer-promise-reject-errors': 'warn',
-    'prefer-regex-literals': 'error',
-    'prefer-rest-params': 'error',
-    'prefer-spread': 'error',
-    'prefer-template': 'error',
-    'quote-props': ['error', 'consistent-as-needed'],
-    'radix': 'error',
-    'require-await': 'error',
-    'require-unicode-regexp': 'off', // No.
-    'require-yield': 'error',
-    'sort-imports': 'error',
-    'sort-keys': 'off', // Pedantic
-    'sort-vars': 'off', // Pedantic
-    'spaced-comment': ['error', 'always'],
-    'strict': ['error', 'global'],
-    'symbol-description': 'error',
-    'vars-on-top': 'error',
-    'yoda': ['error', 'never', {exceptRange: true}],
-
-    // [Layout & Formatting](https://eslint.org/docs/rules/#layout-formatting)
-    'array-bracket-newline': ['error', 'consistent'],
-    'array-bracket-spacing': ['error', 'never'],
-    'array-element-newline': ['error', 'consistent'],
-    'arrow-parens': ['error', 'as-needed'],
-    'arrow-spacing': 'error',
-    'block-spacing': ['error', 'always'],
-    'brace-style': ['error', '1tbs'],
-    'comma-dangle': ['error', {
-      arrays: 'always-multiline',
-      objects: 'always-multiline',
-      imports: 'always-multiline',
-      exports: 'always-multiline',
-      functions: 'never',
-    }],
-    'comma-spacing': 'error',
-    'comma-style': ['error', 'last'],
-    'computed-property-spacing': 'error',
-    'dot-location': ['error', 'property'],
-    'eol-last': 'error',
-    'func-call-spacing': 'error',
-    'function-call-argument-newline': ['error', 'consistent'],
-    'function-paren-newline': ['error', 'consistent'],
-    'generator-star-spacing': 'error',
-    'implicit-arrow-linebreak': ['error', 'beside'],
-    'indent': ['error', 2, {SwitchCase: 1}],
-    'jsx-quotes': 'off', // Not needed
-    'key-spacing': 'error',
-    'keyword-spacing': 'error',
-    'line-comment-position': 'off', // I'm all over the place on these
-    'linebreak-style': 'error',
-    'lines-around-comment': ['error', {
-      allowBlockStart: true,
-      allowClassStart: true,
-    }],
-    'lines-between-class-members': ['error', 'always', {
-      exceptAfterSingleLine: true,
-    }],
-    'max-len': ['error', 80, {
-      ignoreRegExpLiterals: true,
-      ignoreStrings: true,
-      ignoreTemplateLiterals: true,
-      ignoreUrls: true,
-    }],
-    'max-statements-per-line': 'off',
-    'multiline-ternary': ['error', 'always-multiline'],
-    'new-parens': 'error',
-    'newline-per-chained-call': 'error',
-    'no-extra-parens': 'off', // Too fiddly to torn off everything.
-    'no-mixed-spaces-and-tabs': 'error',
-    'no-multi-spaces': 'error',
-    'no-multiple-empty-lines': ['error', {max: 1}],
-    'no-tabs': 'error',
-    'no-trailing-spaces': 'error',
-    'no-whitespace-before-property': 'error',
-    'nonblock-statement-body-position': 'error',
-    'object-curly-newline': 'error',
-    'object-curly-spacing': ['error', 'never'],
-    'object-property-newline': ['error', {allowAllPropertiesOnSameLine: true}],
-    'operator-linebreak': ['error', 'after'],
-    'padded-blocks': ['error', 'never'],
-    'padding-line-between-statements': 'error',
-    'quotes': ['error', 'single', {avoidEscape: true}],
-    'rest-spread-spacing': ['error', 'never'],
-    // Massive breaking change.  I changed my mind.
-    'semi': ['error', 'always'],
-    'semi-spacing': 'error',
-    'semi-style': ['error'],
-    'space-before-blocks': 'error',
-    'space-before-function-paren': ['error', 'never'],
-    'space-in-parens': 'error',
-    'space-infix-ops': ['error', {int32Hint: false}],
-    'space-unary-ops': 'error',
-    'switch-colon-spacing': 'error',
-    'template-curly-spacing': 'error',
-    'template-tag-spacing': 'error',
-    'unicode-bom': 'error',
-    'wrap-iife': 'error',
-    'wrap-regex': 'off', // No.
-    'yield-star-spacing': ['error', 'before'],
-
-    // [Possible Errors](https://github.com/eslint-community/eslint-plugin-n#possible-errors)
-    'n/handle-callback-err': ['error', 'er'],
-    'n/no-callback-literal': 'error',
-    'n/no-exports-assign': 'error',
-    'n/no-extraneous-import': 'error',
-    'n/no-extraneous-require': 'error',
-    'n/no-missing-import': ['error', {
-      allowModules: ['ava'], // Ava uses fancy new stuff, so shows up unavailable.
-    }],
-    'n/no-missing-require': 'off', // This one doesn't work yet:
-    'n/no-new-require': 'error',
-    'n/no-path-concat': 'error',
-    'n/no-process-exit': 'off', // No.
-    'n/no-unpublished-bin': 'error',
-    'n/no-unpublished-import': 'off', // Doesn't work
-    'n/no-unpublished-require': 'off', // Doesn't work
-    'n/no-unsupported-features/es-builtins': 'error',
-    'n/no-unsupported-features/es-syntax': 'error',
-    'n/no-unsupported-features/node-builtins': 'error',
-    'n/process-exit-as-throw': 'error',
-    'n/shebang': 'off', // This always seems to be wrong
-
-    // [Best Practices](https://github.com/eslint-community/eslint-plugin-n#best-practices)
-    'n/no-deprecated-api': 'error',
-
-    // [Stylistic Issues](https://github.com/eslint-community/eslint-plugin-n#stylistic-issues)
-    'n/callback-return': 'off', // No
-    'n/exports-style': 'off',
-    // Doesn't work for `import 'regenerator-runtime/runtime'`
-    'n/file-extension-in-import': 'error',
-    'n/global-require': 'off',
-    'n/no-mixed-requires': 'error',
-    // No
-    'n/no-process-env': 'off',
-    'n/no-restricted-import': 'off',
-    'n/no-restricted-require': 'off',
-    'n/no-sync': 'off',
-
-    'n/prefer-global/buffer': ['error', 'never'],
-    // Hopefully only used in tests and cli
-    'n/prefer-global/console': 'off',
-    'n/prefer-global/process': 'off',
-    'n/prefer-global/text-decoder': ['error', 'always'],
-    'n/prefer-global/text-encoder': ['error', 'always'],
-    'n/prefer-global/url': ['error', 'always'],
-    'n/prefer-global/url-search-params': ['error', 'always'],
-    // Not yet
-    'n/prefer-promises/dns': 'off',
-    'n/prefer-promises/fs': 'off',
-  },
-  overrides: [
-    {
-      files: ['*.mjs'],
-      parserOptions: {sourceType: 'module'},
-      rules: {
-        // [Possible Errors](https://eslint.org/docs/rules/#possible-errors)
-        'n/no-unsupported-features/es-syntax': [
-          'error',
-          {
-            version: '>=12.19',
-            ignores: ['modules'],
-          },
-        ],
-      },
-    },
-  ],
-};
+// Just the core rules, no optional dependencies needed.
+module.exports = [
+  ...require('./ignores.js'),
+  ...require('./js'),
+  ...require('./mjs'),
+];

package/js.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const globals = require('globals');
+const {rules} = require('./rules/js.js');
+
+module.exports = [{
+  files: [
+    '**/*.js',
+    '**/*.cjs',
+    '**/*.mjs',
+    '**/*.ts',
+  ],
+  plugins: {
+    '@stylistic': require('@stylistic/eslint-plugin'),
+    'n': require('eslint-plugin-n'),
+  },
+  languageOptions: {
+    globals: globals.node,
+    ecmaVersion: 2022,
+    sourceType: 'commonjs',
+  },
+  rules,
+}];