@will-stone/eslint-config 3.1.4 → 4.0.3

package/_for_rule_checking.js

@@ -0,0 +1,21 @@
+/**
+ * This file is just to be used for eslint-find-rules, and should not be used as
+ * an eslint configuration.
+ */
+
+const tsRules = require('./rules/typescript')
+
+module.exports = {
+  plugins: ['@typescript-eslint'],
+  extends: [
+    require.resolve('./javascript'),
+    require.resolve('./react'),
+    require.resolve('./node'),
+    require.resolve('./jest'),
+    require.resolve('./prettier'),
+  ],
+  rules: {
+    // Use the TS rules directly as eslint-find-rules cannot see `overrides`.
+    ...tsRules,
+  },
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@will-stone/eslint-config",
-  "version": "3.1.4",
+  "version": "4.0.3",
   "private": false,
   "description": "My ESLint config",
   "repository": {
@@ -9,7 +9,8 @@
   "license": "MIT",
   "author": "Will Stone",
   "scripts": {
-    "eslint-find-unused-rules": "npx eslint-find-rules --unused ./javascript.js"
+    "eslint-find-unused-rules": "eslint-find-rules --unused ./_for_rule_checking.js > ./unused-rules.txt",
+    "eslint-print-rules": "eslint --no-eslintrc -c ./_for_rule_checking.js --print-config ./_for_rule_checking.js > rules.json"
   },
   "dependencies": {
     "@typescript-eslint/eslint-plugin": "^4.32.0",
@@ -17,7 +18,7 @@
     "confusing-browser-globals": "^1.0.10",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jest": "^24.5.0",
+    "eslint-plugin-jest": "^24.5.2",
     "eslint-plugin-jsx-a11y": "^6.4.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
@@ -27,6 +28,9 @@
     "eslint-plugin-switch-case": "^1.1.2",
     "eslint-plugin-unicorn": "^36.0.0"
   },
+  "devDependencies": {
+    "eslint-find-rules": "^3.6.1"
+  },
   "peerDependencies": {
     "eslint": "^7.32.0",
     "typescript": "4.x"

package/rules/built-in.js

@@ -756,7 +756,7 @@ module.exports = {
   'use-isnan': 'error',
 
   // Enforce comparing typeof expressions against valid strings.
-  'valid-typeof': 'error',
+  'valid-typeof': ['error', { requireStringLiterals: true }],
 
   // By default variable declarations are always moved (“hoisted”) invisibly
   // to the top of their containing scope by the JavaScript interpreter.

package/rules/import.js

@@ -32,6 +32,8 @@ module.exports = {
   'import/extensions': 'off',
   'import/first': 'off',
   'import/group-exports': 'off',
+  'import/no-import-module-exports': 'off',
+  'import/no-relative-packages': 'off',
   'import/max-dependencies': 'off',
   'import/named': 'off',
   'import/namespace': 'off',

package/rules/jest.js

@@ -8,6 +8,8 @@ module.exports = {
   // lowercase letter. This provides more readable test failures.
   'jest/lowercase-name': 'warn',
 
+  'jest/max-nested-describe': 'off',
+
   // Consistent expect methods
   'jest/no-alias-methods': 'error',
 
@@ -17,12 +19,27 @@ module.exports = {
   // Do not allow multiple beforeEach, for example
   'jest/no-duplicate-hooks': 'error',
 
+  'jest/no-hooks': 'off',
+
+  // Conditional logic in tests is usually an indication that a test is attempting to cover too much
+  'jest/no-if': 'error',
+
+  'jest/no-large-snapshots': 'off',
+
+  'jest/no-restricted-matchers': 'off',
+
   // No standalone expect in a describe block
   'jest/no-standalone-expect': 'error',
 
   // Tests shouldn't return anything
   'jest/no-test-return-statement': 'error',
 
+  'jest/prefer-called-with': 'off',
+
+  'jest/prefer-expect-assertions': 'off',
+
+  'jest/prefer-expect-resolves': 'warn',
+
   // beforeEach, beforeAll, afterEach etc. should be at top of test block
   'jest/prefer-hooks-on-top': 'error',
 
@@ -31,6 +48,10 @@ module.exports = {
   // Jest keeps track of changes, and they can be restored.
   'jest/prefer-spy-on': 'error',
 
+  'jest/prefer-strict-equal': 'error',
+
+  'jest/prefer-to-be': 'warn',
+
   // .toBe(null) -> .toBeNull()
   'jest/prefer-to-be-null': 'error',
 
@@ -50,10 +71,14 @@ module.exports = {
   // Requiring a message ensures that the intended error is thrown
   'jest/require-to-throw-message': 'error',
 
+  'jest/require-top-level-describe': 'off',
+
   // Titles are...
   // - not empty
   // - is a string
   // - not prefixed with their block name
   // - have no leading or trailing spaces
   'jest/valid-title': 'error',
+
+  'jest/unbound-method': 'off',
 }

package/rules/node.js

@@ -37,4 +37,33 @@ module.exports = {
   // Not sure I need this...?
   // TODO check others' configs to see how they use this.
   'node/shebang': 'off',
+
+  // Turn these off until I work out if I need them
+  'node/exports-style': 'off',
+  'node/file-extension-in-import': 'off',
+  'node/no-callback-literal': 'off',
+  'node/no-deprecated-api': 'off',
+  'node/no-exports-assign': 'off',
+  'node/no-extraneous-import': 'off',
+  'node/no-extraneous-require': 'off',
+  'node/no-missing-import': 'off',
+  'node/no-missing-require': 'off',
+  'node/no-new-require': 'off',
+  'node/no-restricted-import': 'off',
+  'node/no-unpublished-bin': 'off',
+  'node/no-unpublished-import': 'off',
+  'node/no-unpublished-require': 'off',
+  'node/no-unsupported-features/es-builtins': 'off',
+  'node/no-unsupported-features/es-syntax': 'off',
+  'node/no-unsupported-features/node-builtins': 'off',
+  'node/prefer-global/buffer': 'off',
+  'node/prefer-global/console': 'off',
+  'node/prefer-global/process': 'off',
+  'node/prefer-global/text-decoder': 'off',
+  'node/prefer-global/text-encoder': 'off',
+  'node/prefer-global/url': 'off',
+  'node/prefer-global/url-search-params': 'off',
+  'node/prefer-promises/dns': 'off',
+  'node/prefer-promises/fs': 'off',
+  'node/process-exit-as-throw': 'off',
 }

package/rules/react.js

@@ -20,6 +20,8 @@ module.exports = {
     },
   ],
 
+  'jsx-a11y/lang': 'error',
+
   // Only allow JSX in these file types:
   'react/jsx-filename-extension': ['error', { extensions: ['.jsx', '.tsx'] }],
 

package/rules/typescript.js

@@ -24,8 +24,6 @@ module.exports = {
   'no-new-symbol': 'off',
   // ts(2349)
   'no-obj-calls': 'off',
-  // ts(2451)
-  'no-redeclare': 'off',
   // ts(2408)
   'no-setter-return': 'off',
   // ts(2376)
@@ -80,51 +78,84 @@ module.exports = {
    */
   '@typescript-eslint/await-thenable': 'off',
   '@typescript-eslint/dot-notation': 'off',
+  '@typescript-eslint/naming-convention': 'off',
+  '@typescript-eslint/no-base-to-string': 'off',
   '@typescript-eslint/no-confusing-void-expression': 'off',
   '@typescript-eslint/no-floating-promises': 'off',
   '@typescript-eslint/no-for-in-array': 'off',
   '@typescript-eslint/no-implied-eval': 'off',
+  '@typescript-eslint/no-meaningless-void-operator': 'off',
   '@typescript-eslint/no-misused-promises': 'off',
+  '@typescript-eslint/no-throw-literal': 'off',
+  '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'off',
+  '@typescript-eslint/no-unnecessary-condition': 'off',
+  '@typescript-eslint/no-unnecessary-qualifier': 'off',
+  '@typescript-eslint/no-unnecessary-type-arguments': 'off',
   '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+  '@typescript-eslint/no-unsafe-argument': 'off',
   '@typescript-eslint/no-unsafe-assignment': 'off',
   '@typescript-eslint/no-unsafe-call': 'off',
   '@typescript-eslint/no-unsafe-member-access': 'off',
   '@typescript-eslint/no-unsafe-return': 'off',
   '@typescript-eslint/non-nullable-type-assertion-style': 'off',
+  '@typescript-eslint/prefer-includes': 'off',
+  '@typescript-eslint/prefer-nullish-coalescing': 'off',
+  '@typescript-eslint/prefer-readonly': 'off',
   '@typescript-eslint/prefer-readonly-parameter-types': 'off',
+  '@typescript-eslint/prefer-reduce-type-parameter': 'off',
+  '@typescript-eslint/prefer-return-this-type': 'off',
   '@typescript-eslint/prefer-regexp-exec': 'off',
+  '@typescript-eslint/prefer-string-starts-ends-with': 'off',
   '@typescript-eslint/promise-function-async': 'off',
+  '@typescript-eslint/require-array-sort-compare': 'off',
   '@typescript-eslint/require-await': 'off',
   '@typescript-eslint/restrict-plus-operands': 'off',
   '@typescript-eslint/restrict-template-expressions': 'off',
+  '@typescript-eslint/return-await': 'off',
+  '@typescript-eslint/strict-boolean-expressions': 'off',
+  '@typescript-eslint/switch-exhaustiveness-check': 'off',
   '@typescript-eslint/unbound-method': 'off',
 
   /**
-   * Tweaks
+   * The rest
    */
 
-  // Don't mind if functions do not have return types.
-  '@typescript-eslint/explicit-function-return-type': 'off',
+  // Requires using T[] over Array<T> for arrays
+  '@typescript-eslint/array-type': ['warn', { default: 'array' }],
 
-  // Disallow non-null assertion in locations that may be confusing
-  '@typescript-eslint/no-confusing-non-null-assertion': 'warn',
+  // Bans // tslint:<rule-flag> comments from being used
+  '@typescript-eslint/ban-tslint-comment': 'warn',
 
-  // Disallow duplicate imports
-  'no-duplicate-imports': 'off',
-  '@typescript-eslint/no-duplicate-imports': ['error'],
+  // Ensures that literals on classes are exposed in a consistent style
+  '@typescript-eslint/class-literal-property-style': 'warn',
 
-  // Variables must be used unless name ends with "ignored"
-  'no-unused-vars': 'off',
-  '@typescript-eslint/no-unused-vars': [
-    'error',
-    { varsIgnorePattern: '[iI]gnored' },
+  // Enforce the use of the record type
+  '@typescript-eslint/consistent-indexed-object-style': 'warn',
+
+  // Enforces consistent usage of type assertions
+  '@typescript-eslint/consistent-type-assertions': 'error',
+
+  // Enforce using interfaces for object type definitions
+  '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+
+  // Enforces consistent usage of type imports
+  '@typescript-eslint/consistent-type-imports': [
+    'warn',
+    { prefer: 'type-imports' },
   ],
 
-  'no-use-before-define': 'off',
-  '@typescript-eslint/no-use-before-define': ['error'],
+  // Enforce default parameters to be last
+  'default-param-last': 'off',
+  '@typescript-eslint/default-param-last': ['error'],
 
-  // Requires using T[] over Array<T> for arrays
-  '@typescript-eslint/array-type': ['warn', { default: 'array' }],
+  // Don't mind if functions do not have return types.
+  '@typescript-eslint/explicit-function-return-type': 'off',
+
+  // Require explicit accessibility modifiers ("public") on class properties and methods
+  '@typescript-eslint/explicit-member-accessibility': 'warn',
+
+  // Initialise vairables however you like
+  '@typescript-eslint/init-declarations': 'off',
 
   'lines-between-class-members': 'off',
   '@typescript-eslint/lines-between-class-members': [
@@ -146,34 +177,98 @@ module.exports = {
   // }
   '@typescript-eslint/method-signature-style': 'warn',
 
+  // Disallow non-null assertion in locations that may be confusing
+  '@typescript-eslint/no-confusing-non-null-assertion': 'warn',
+
+  // Disallow duplicate imports
+  'no-duplicate-imports': 'off',
+  '@typescript-eslint/no-duplicate-imports': 'error',
+
   // Disallow duplicate class members
   '@typescript-eslint/no-dupe-class-members': 'error',
 
+  '@typescript-eslint/no-dynamic-delete': 'warn',
+
   // ❌ const bar = foo!!!.bar
   // ✅ const bar = foo!.bar
   '@typescript-eslint/no-extra-non-null-assertion': 'warn',
 
-  // Disallows usage of void type outside of generic or return types
-  '@typescript-eslint/no-invalid-void-type': 'error',
+  // Warns when a class is accidentally used as a namespace
+  '@typescript-eslint/no-extraneous-class': 'error',
+
+  // Disallow usage of the implicit any type in catch clauses
+  '@typescript-eslint/no-implicit-any-catch': 'warn',
 
   // Disallow this keywords outside of classes or class-like objects
   'no-invalid-this': 'off',
   '@typescript-eslint/no-invalid-this': 'error',
 
+  // Disallows usage of void type outside of generic or return types
+  '@typescript-eslint/no-invalid-void-type': 'error',
+
+  // Disallow function declarations that contain unsafe references inside loop statements
+  'no-loop-func': 'off',
+  '@typescript-eslint/no-loop-func': 'error',
+
   // Disallow literal numbers that lose precision
   'no-loss-of-precision': 'off',
   '@typescript-eslint/no-loss-of-precision': ['error'],
 
+  // Disallowing magic numbers causes all sorts of problems
+  '@typescript-eslint/no-magic-numbers': 'off',
+
+  '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
+
+  // Not sure if needed
+  '@typescript-eslint/no-parameter-properties': 'off',
+
+  'no-redeclare': 'off',
+  '@typescript-eslint/no-redeclare': 'error',
+
+  '@typescript-eslint/no-require-imports': 'error',
+
+  'no-restricted-imports': 'off',
+  '@typescript-eslint/no-restricted-imports': 'off',
+
   // Disallow variable declarations from shadowing variables declared in the outer scope
   'no-shadow': 'off',
   '@typescript-eslint/no-shadow': ['error'],
 
+  // Aliasing can be useful
+  '@typescript-eslint/no-type-alias': 'off',
+
+  // Disallows unnecessary constraints on generic types
+  '@typescript-eslint/no-unnecessary-type-constraint': 'warn',
+
   // Aims to eliminate unused expressions which have no effect on the state of the program.
   'no-unused-expressions': 'off',
   '@typescript-eslint/no-unused-expressions': ['error'],
 
-  // Disallows unnecessary constraints on generic types
-  '@typescript-eslint/no-unnecessary-type-constraint': 'warn',
+  // Variables must be used unless name ends with "ignored"
+  'no-unused-vars': 'off',
+  '@typescript-eslint/no-unused-vars': [
+    'error',
+    { varsIgnorePattern: '[iI]gnored' },
+  ],
+
+  'no-use-before-define': 'off',
+  '@typescript-eslint/no-use-before-define': 'error',
+
+  'no-useless-constructor': 'off',
+  '@typescript-eslint/no-useless-constructor': 'error',
+
+  'padding-line-between-statements': 'off',
+  '@typescript-eslint/padding-line-between-statements': [
+    'error',
+    { blankLine: 'always', prev: 'multiline-block-like', next: '*' },
+  ],
+
+  '@typescript-eslint/prefer-enum-initializers': 'error',
+
+  // Unicorn does this better by providing a fixer
+  '@typescript-eslint/prefer-for-of': 'off',
+
+  '@typescript-eslint/prefer-function-type': 'warn',
 
   // Require that all enum members be literal values to prevent unintended enum member name shadow issues.
   '@typescript-eslint/prefer-literal-enum-member': 'error',
@@ -197,4 +292,9 @@ module.exports = {
   // This rule is aimed at ensuring there are spaces around infix operators.
   'space-infix-ops': 'off',
   '@typescript-eslint/space-infix-ops': ['warn', { int32Hint: false }],
+
+  // Not sure if required yet. Might be too strict and produce noist code.
+  '@typescript-eslint/typedef': 'off',
+
+  '@typescript-eslint/unified-signatures': 'error',
 }