♻️ decide on base set of eslint rules

Author: dudeofawesome

.vscode/settings.json

@@ -22,9 +22,9 @@
     }
   ],
   "material-icon-theme.files.associations": {
-    "eslint-config*/*.yaml": "eslint"
+    "eslint-config*/**/*.yaml": "eslint"
   },
   "yaml.schemas": {
-    "https://json.schemastore.org/eslintrc": ["eslint-config*/*.yaml"]
+    "https://json.schemastore.org/eslintrc": ["eslint-config*/**/*.yaml"]
   }
 }

eslint-config/base.yaml

@@ -1,40 +1,19 @@
 extends:
-  - 'plugin:@shopify/esnext'
+  - 'eslint:recommended'
   - 'plugin:prettier/recommended'
+  - 'plugin:promise/recommended'
+  - 'plugin:import/recommended'
+
+  - './rules/bugs.yaml'
+  - './rules/deprecated.yaml'
+  - './rules/footguns.yaml'
+  - './rules/imports.yaml'
+  - './rules/miscellaneous.yaml'
+  - './rules/modern-code.yaml'
+  - './rules/promises.yaml'
+  - './rules/readability.yaml'
+  - './rules/security.yaml'
+
 parserOptions:
   ecmaVersion: 2022 # Version is inline with Node 16
   sourceType: 'module'
-
-rules:
-  '@babel/new-cap': 'off'
-  id-length: 'off'
-  import/order:
-    - 'warn'
-    - groups:
-        - 'builtin'
-        - 'external'
-        - 'internal'
-      newlines-between: 'ignore'
-  import/no-default-export: 'error'
-  line-comment-position: 'off'
-  no-empty-function: 'warn'
-  no-negated-condition: 'off'
-  no-nested-ternary: 'off'
-  no-warning-comments: 'off'
-  prettier/prettier: 'warn'
-  require-atomic-updates: ['warn', { allowProperties: true }]
-  sort-class-members/sort-class-members: 'off'
-  import/extensions: 'off'
-  no-useless-constructor: 'off'
-  consistent-return: 'off'
-  require-await: 'off'
-  no-shadow: 'off'
-  promise/no-nesting: 'off'
-  import/no-cycle: 'off'
-  lines-between-class-members: 'off'
-  no-useless-return: 'off'
-  no-use-before-define: 'off'
-  eslint-comments/no-use: 'warn'
-  '@shopify/binary-assignment-parens': 'off'
-  no-console: 'error'
-  # TODO: ban barrels

eslint-config/package.json

@@ -23,7 +23,9 @@
     "@shopify/eslint-plugin": "^43.0.0",
     "eslint": "^8.49.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^5.0.0"
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-promise": "^6.1.1"
   },
   "peerDependencies": {
     "prettier": "^3.0.3"

eslint-config/rules/bugs.yaml

@@ -0,0 +1,15 @@
+rules:
+  # don't compare vars to themselves
+  no-self-compare: 'error'
+
+  # don't use `this` when `this` is `undefined`
+  no-invalid-this: 'error'
+
+  # catch some race conditions
+  require-atomic-updates: ['warn', { allowProperties: true }]
+
+  # don't use `new` keyword when it shouldn't be used
+  no-new-native-nonconstructor: 'error'
+
+  # ensure thrown value extend `Error`
+  no-throw-literal: 'error'

eslint-config/rules/deprecated.yaml

@@ -0,0 +1,9 @@
+rules:
+  # __iterator__ is deprecated
+  no-iterator: 'error'
+
+  # __proto__ is deprecated
+  no-proto: 'error'
+
+  # don't allow var
+  no-var: 'error'

eslint-config/rules/footguns.yaml

@@ -0,0 +1,46 @@
+rules:
+  # require `parseInt` to have a radix specified since some browsers don't default to base 10
+  radix: 'error'
+
+  # require the use of `===` since `==` has some weird behavior
+  eqeqeq: ['error', 'smart']
+
+  # TODO: ban barrels
+  # barrel files can lead to a number of hard to debug issues
+
+  # prefer binary, octal, and hexadecimal literals instead of parseInt('F', 16)
+  prefer-numeric-literals: 'error'
+
+  # ensure that functional array methods are chainable
+  array-callback-return: 'error'
+
+  # don't return in a constructor
+  no-constructor-return: 'error'
+
+  # don't allow array constructors with multiple params
+  no-array-constructor: 'error'
+
+  # don't use arguments.caller
+  no-caller: 'error'
+
+  # TODO: this is an error by default. should it only be a warn?
+  # don't allow `delete` since it can have unexpected consequences
+  no-delete-var: 'warn'
+
+  # don't allow monkeypatching
+  no-extend-native: 'error'
+
+  # don't allow sequences
+  no-sequences: ['error', { allowInParentheses: false }]
+
+  # don't allow the void keyword
+  no-void: 'error'
+
+  # ensure regexp uses certain flags
+  require-unicode-regexp: 'error'
+
+  # prevent unintentional numeric literal values (eg: `071 === 51`)
+  no-octal: 'error'
+
+  # prevent labels from sharing name with variable
+  no-label-var: 'error'

eslint-config/rules/imports.yaml

@@ -0,0 +1,44 @@
+rules:
+  # warn about deprecated imports
+  import/no-deprecated: 'warn'
+
+  # don't export mutable vars
+  import/no-mutable-exports: 'error'
+
+  # don't allow AMD modules
+  import/no-amd: 'error'
+
+  # TODO: can we actually ban this? probably not
+  # don't allow commonjs modules
+  import/no-commonjs: 'error'
+
+  # don't allow mixing ESM with commonjs exports
+  import/no-import-module-exports: 'error'
+
+  # don't allow importing yourself
+  import/no-self-import: 'error'
+
+  # don't allow webpack imports
+  import/no-webpack-loader-syntax: 'error'
+
+  # ensure imports come first in file
+  import/first: 'error'
+
+  # ensure imports are seperated from the rest of the file
+  import/newline-after-import: 'error'
+
+  # don't allow default exports
+  import/no-default-export: 'error'
+
+  # ensure consistent ordering of imports
+  import/order:
+    - 'warn'
+    - groups:
+        - 'builtin'
+        - 'external'
+        - 'internal'
+      newlines-between: 'ignore'
+
+  # TODO: do I need this?
+  # Sort import declarations within module
+  sort-imports: 'off'

eslint-config/rules/miscellaneous.yaml

@@ -0,0 +1,20 @@
+rules:
+  # prevent `console` and `alert` calls from making it into prod
+  no-console: 'error'
+  no-alert: 'error'
+
+  # warn about prettier style issues
+  prettier/prettier: 'warn'
+
+  # TODO: do we really want to force a style for comments?
+  # ensure comments start with a space
+  spaced-comment: ['error', 'always', { 'block': { 'exceptions': ['-=*'] } }]
+
+  # disallow renaming import, export, and destructured assignments to the same name
+  no-useless-rename: 'error'
+
+  # require symbol to have a description
+  symbol-description: 'error'
+
+  # require switch's default case to be last
+  default-case-last: 'error'

eslint-config/rules/modern-code.yaml

@@ -0,0 +1,21 @@
+rules:
+  # use template literals instead of string concatenation
+  prefer-template: 'error'
+
+  # don't use .apply()
+  prefer-spread: 'error'
+
+  # use `**` instead of `Math.pow`
+  prefer-exponentiation-operator: 'error'
+
+  # use a rest parameter instead of `arguments`
+  prefer-rest-params: 'error'
+
+  # Require method and property shorthand syntax for object literals
+  object-shorthand: ['error', 'always', { avoidQuotes: true }]
+
+  # Suggest using arrow functions as callbacks
+  prefer-arrow-callback: ['error', { allowNamedFunctions: true }]
+
+  # use const for vars that are never modified
+  prefer-const: 'error'

eslint-config/rules/promises.yaml

@@ -0,0 +1,22 @@
+rules:
+  # TODO: do we actually want this?
+  # ensure promise errors are caught
+  promise/catch-or-return: ['error', { allowThen: true }]
+
+  # don't call resolve multiple times
+  promise/no-multiple-resolved: 'error'
+
+  # allow nesting promises
+  promise/no-nesting: 'off'
+
+  # allow using promises inside of callbacks
+  promise/no-promise-in-callback: 'off'
+
+  # ensure the proper number of arguments are passed to Promise functions
+  promise/valid-params: 'error'
+
+  # require async functions to contain an await
+  require-await: 'error'
+
+  # prevent synchronous loops (prefering to use `Promise.all`)
+  no-await-in-loop: 'error'