@wistia/eslint-config 0.7.2 → 0.9.0

package/README.md

@@ -12,7 +12,4 @@ Wistia's ESLint configuration. This repo is "pseudo-public" - private on our org
 2. should not contradict existing rules
 3. person/team adding new rules handles upgrading consumers and fixing violations
 4. rules should always be set to `error`, never `warn` (the latter are never fixed)
-
-## Publishing
-
-TODO!
+5. add short description of rule & link to rule definition in code comments

package/configs/eslint/default.js

@@ -4,17 +4,13 @@ module.exports = {
     ecmaVersion: 2018,
     sourceType: 'module',
   },
-  plugins: ['eslint-plugin-prettier'],
   extends: [
     '../../rules/eslint/best-practices',
     '../../rules/eslint/errors',
     '../../rules/eslint/es6',
-    '../../rules/eslint/globals',
     '../../rules/eslint/imports',
     '../../rules/eslint/node',
     '../../rules/eslint/style',
     '../../rules/eslint/variables',
-    '../../rules/eslint/prettier',
-    'eslint-config-prettier',
   ].map(require.resolve),
 };

package/configs/eslint/prettier.js

@@ -0,0 +1,4 @@
+module.exports = {
+  plugins: ['eslint-plugin-prettier'],
+  extends: ['../../rules/eslint/prettier', 'eslint-config-prettier'].map(require.resolve),
+};

package/configs/eslint/react.js

@@ -3,22 +3,9 @@ module.exports = {
     browser: true,
   },
   parser: '@babel/eslint-parser',
-  plugins: ['eslint-plugin-prettier'],
   extends: [
-    // base
-    '../../rules/eslint/best-practices',
-    '../../rules/eslint/errors',
-    '../../rules/eslint/es6',
-    '../../rules/eslint/globals',
-    '../../rules/eslint/imports',
-    '../../rules/eslint/node',
-    '../../rules/eslint/style',
-    '../../rules/eslint/variables',
-    // react
     '../../rules/eslint/react',
     '../../rules/eslint/react-a11y',
     '../../rules/eslint/react-hooks.js',
-    '../../rules/eslint/prettier',
-    'eslint-config-prettier',
   ].map(require.resolve),
 };

package/package.json

@@ -1,25 +1,28 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "0.7.2",
+  "version": "0.9.0",
   "description": "Wistia's ESLint configurations",
   "main": "react.js",
   "exports": {
     "./package.json": "./package.json",
     ".": "./configs/eslint/default.js",
-    "./react": "./configs/eslint/react.js",
     "./cypress": "./configs/eslint/cypress.js",
     "./jest": "./configs/eslint/jest.js",
-    "./sonar": "./configs/eslint/sonar.js",
+    "./prettier": "./configs/eslint/prettier.js",
+    "./react": "./configs/eslint/react.js",
+    "./strict": "./configs/eslint/strict.js",
     "./styled-components": "./configs/eslint/styled-components.js",
-    "./testing-library": "./configs/eslint/testing-library.js",
     "./stylelint": "./configs/stylelint/default.js",
     "./stylelint/scss": "./configs/stylelint/scss.js",
-    "./stylelint/styled-components": "./configs/stylelint/styled-components.js"
+    "./stylelint/styled-components": "./configs/stylelint/styled-components.js",
+    "./testing-library": "./configs/eslint/testing-library.js"
   },
   "scripts": {
     "lint": "eslint --fix --ignore-path test/.eslintignore .",
     "prepare": "husky install",
-    "test": "check-export-map && eslint --print-config ./test/index.js"
+    "test": "check-export-map && yarn run test:eslint && yarn run test:stylelint",
+    "test:eslint": "eslint --print-config ./test/index.js",
+    "test:stylelint": "stylelint --print-config ./test/index.js"
   },
   "dependencies": {
     "@babel/core": "^7.18.9",

package/rules/eslint/best-practices.js

@@ -1,3 +1,5 @@
+const confusingBrowserGlobals = require('confusing-browser-globals');
+
 module.exports = {
   rules: {
     // enforces getter/setter pairs in objects
@@ -262,6 +264,23 @@ module.exports = {
     // https://eslint.org/docs/rules/no-redeclare
     'no-redeclare': 'error',
 
+    // browser globals that commonly cause confusion and are not recommended
+    // to use without an explicit `window`.` qualifier
+    // https://eslint.org/docs/rules/no-restricted-globals
+    'no-restricted-globals': [
+      'error',
+      {
+        name: 'isFinite',
+        message:
+          'Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite',
+      },
+      {
+        name: 'isNaN',
+        message:
+          'Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan',
+      },
+    ].concat(confusingBrowserGlobals),
+
     // disallow certain object properties
     // https://eslint.org/docs/rules/no-restricted-properties
     'no-restricted-properties': [

package/rules/eslint/cypress.js

@@ -3,12 +3,32 @@
 
 module.exports = {
   rules: {
+    // Prevent assigning return values of cy calls
+    // https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-assigning-return-values.md
     'cypress/no-assigning-return-values': 'error',
+
+    // Prevent waiting for arbitrary time periods
+    // https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-unnecessary-waiting.md
     'cypress/no-unnecessary-waiting': 'error',
+
+    // Prevent using async/await in Cypress test case
+    // https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-async-tests.md
     'cypress/no-async-tests': 'error',
+
+    // Disallow using `force: true` with action commands
+    // https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-force.md
     'cypress/no-force': 'error',
+
+    // Ensure screenshots are preceded by an assertion
+    // https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/assertion-before-screenshot.md
     'cypress/assertion-before-screenshot': 'error',
+
+    // Only allow data-\* attribute selectors (require-data-selectors)
+    // https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/require-data-selectors.md
     'cypress/require-data-selectors': 'error',
+
+    // Disallow `cy.pause()` parent command
+    // https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-pause.md
     'cypress/no-pause': 'error',
   },
 };

package/rules/eslint/errors.js

@@ -21,9 +21,11 @@ module.exports = {
     'no-compare-neg-zero': 'error',
 
     // disallow assignment in conditional expressions
+    // https://eslint.org/docs/rules/no-cond-assign
     'no-cond-assign': ['error', 'always'],
 
     // disallow use of console
+    // https://eslint.org/docs/rules/no-console
     'no-console': 'error',
 
     // Disallows expressions where the operation doesn't affect the value
@@ -31,15 +33,19 @@ module.exports = {
     'no-constant-binary-expression': 'error',
 
     // disallow use of constant expressions in conditions
+    // https://eslint.org/docs/rules/no-constant-condition
     'no-constant-condition': 'error',
 
     // disallow control characters in regular expressions
+    // https://eslint.org/docs/rules/no-control-regex
     'no-control-regex': 'error',
 
     // disallow use of debugger
+    // https://eslint.org/docs/rules/no-debugger
     'no-debugger': 'error',
 
     // disallow duplicate arguments in functions
+    // https://eslint.org/docs/rules/no-dupe-args
     'no-dupe-args': 'error',
 
     // Disallow duplicate conditions in if-else-if chains
@@ -47,18 +53,23 @@ module.exports = {
     'no-dupe-else-if': 'error',
 
     // disallow duplicate keys when creating object literals
+    // https://eslint.org/docs/rules/no-dupe-keys
     'no-dupe-keys': 'error',
 
     // disallow a duplicate case label.
+    // https://eslint.org/docs/rules/no-duplicate-case
     'no-duplicate-case': 'error',
 
     // disallow empty statements
+    // https://eslint.org/docs/rules/no-empty
     'no-empty': 'error',
 
     // disallow the use of empty character classes in regular expressions
+    // https://eslint.org/docs/rules/no-empty-character-class
     'no-empty-character-class': 'error',
 
     // disallow assigning to the exception in a catch block
+    // https://eslint.org/docs/rules/no-ex-assign
     'no-ex-assign': 'error',
 
     // disallow double-negation boolean casts in a boolean context
@@ -80,21 +91,26 @@ module.exports = {
     ],
 
     // disallow unnecessary semicolons
+    // https://eslint.org/docs/rules/no-extra-semi
     'no-extra-semi': 'error',
 
     // disallow overwriting functions written as function declarations
+    // https://eslint.org/docs/rules/no-func-assign
     'no-func-assign': 'error',
 
     // https://eslint.org/docs/rules/no-import-assign
     'no-import-assign': 'error',
 
     // disallow function or variable declarations in nested blocks
+    // https://eslint.org/docs/rules/no-inner-declarations
     'no-inner-declarations': 'error',
 
     // disallow invalid regular expression strings in the RegExp constructor
+    // https://eslint.org/docs/rules/no-invalid-regexp
     'no-invalid-regexp': 'error',
 
     // disallow irregular whitespace outside of strings and comments
+    // https://eslint.org/docs/rules/no-irregular-whitespace
     'no-irregular-whitespace': 'error',
 
     // Disallow Number Literals That Lose Precision
@@ -106,6 +122,7 @@ module.exports = {
     'no-misleading-character-class': 'error',
 
     // disallow the use of object properties of the global object (Math and JSON) as functions
+    // https://eslint.org/docs/rules/no-obj-calls
     'no-obj-calls': 'error',
 
     // Disallow returning values from Promise executor functions
@@ -117,6 +134,7 @@ module.exports = {
     'no-prototype-builtins': 'error',
 
     // disallow multiple spaces in a regular expression literal
+    // https://eslint.org/docs/rules/no-regex-spaces
     'no-regex-spaces': 'error',
 
     // Disallow returning values from setters
@@ -124,6 +142,7 @@ module.exports = {
     'no-setter-return': 'error',
 
     // disallow sparse arrays
+    // https://eslint.org/docs/rules/no-sparse-arrays
     'no-sparse-arrays': 'error',
 
     // Disallow template literal placeholder syntax in regular strings
@@ -135,6 +154,7 @@ module.exports = {
     'no-unexpected-multiline': 'error',
 
     // disallow unreachable statements after a return, throw, continue, or break statement
+    // https://eslint.org/docs/rules/no-unreachable
     'no-unreachable': 'error',
 
     // Disallow loops with a body that allows only one iteration
@@ -168,6 +188,7 @@ module.exports = {
 
     // disallow negation of the left operand of an in expression
     // deprecated in favor of no-unsafe-negation
+    // https://eslint.org/docs/rules/no-negated-in-lhs
     'no-negated-in-lhs': 'off',
 
     // Disallow assignments that can lead to race conditions due to usage of await or yield
@@ -176,6 +197,7 @@ module.exports = {
     'require-atomic-updates': 'off',
 
     // disallow comparisons with the value NaN
+    // https://eslint.org/docs/rules/use-isnan
     'use-isnan': 'error',
 
     // ensure JSDoc comments are valid

package/rules/eslint/es6.js

@@ -32,6 +32,7 @@ module.exports = {
     'arrow-spacing': ['error', { before: true, after: true }],
 
     // verify super() callings in constructors
+    // https://eslint.org/docs/rules/constructor-super
     'constructor-super': 'error',
 
     // enforce the spacing around the * in generator functions
@@ -52,6 +53,7 @@ module.exports = {
     ],
 
     // disallow modifying variables that are declared using const
+    // https://eslint.org/docs/rules/no-const-assign
     'no-const-assign': 'error',
 
     // disallow duplicate class members
@@ -113,6 +115,7 @@ module.exports = {
     ],
 
     // require let or const instead of var
+    // https://eslint.org/docs/rules/no-var
     'no-var': 'error',
 
     // require method and property shorthand syntax for object literals
@@ -127,6 +130,7 @@ module.exports = {
     ],
 
     // suggest using arrow functions as callbacks
+    // https://eslint.org/docs/rules/prefer-arrow-callback
     'prefer-arrow-callback': [
       'error',
       {
@@ -136,6 +140,7 @@ module.exports = {
     ],
 
     // suggest using of const declaration for variables that are never modified after declared
+    // https://eslint.org/docs/rules/prefer-const
     'prefer-const': [
       'error',
       {

package/rules/eslint/jest.js

@@ -4,59 +4,229 @@
 
 module.exports = {
   rules: {
-    // authoring rules for tests
+    // Authoring rules for tests:
+
+    // Have control over `test` and `it` usages
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/consistent-test-it.md
     'jest/consistent-test-it': 'error',
-    'jest/expect-expect': 'off',
+
+    // Enforce assertion to be made in a test body
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/expect-expect.md
+    'jest/expect-expect': 'error',
+
+    // Enforces a maximum number assertion calls in a test body
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/max-expects.md
+    'jest/max-expects': [
+      'error',
+      {
+        max: 15,
+      },
+    ],
+
+    // Enforces a maximum depth to nested describe calls
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/max-nested-describe.md
+    'jest/max-nested-describe': 'error',
+
+    // Disallow alias methods
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-alias-methods.md
     'jest/no-alias-methods': 'error',
+
+    // Disallow commented out tests
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-commented-out-tests.md
     'jest/no-commented-out-tests': 'error',
+
+    // Prevent calling `expect` conditionally
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-conditional-expect.md
     'jest/no-conditional-expect': 'error',
+
+    // Disallow conditional logic in tests
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-conditional-in-test.md
+    'jest/no-conditional-in-test': 'error',
+
+    // Disallow use of deprecated functions
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-deprecated-functions.md
     'jest/no-deprecated-functions': 'error',
-    // it is often useful to be allowed to add a .skip
+
+    // Disallow disabled tests
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-disabled-tests.md
+    // decision: it is often useful to be allowed to add a .skip
     'jest/no-disabled-tests': 'off',
+
+    // Avoid using a callback in asynchronous tests and hooks
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-done-callback.md
     'jest/no-done-callback': 'error',
+
+    // Disallow duplicate setup and teardown hooks
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-duplicate-hooks.md
     'jest/no-duplicate-hooks': 'error',
+
+    // Disallow using `exports` in files containing tests
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-export.md
     'jest/no-export': 'error',
+
+    // Disallow focused tests
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-focused-tests.md
     'jest/no-focused-tests': 'error',
-    // hooks are useful even though they *potentially* promote shared state between tests
+
+    // Disallow setup and teardown hooks
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-hooks.md
+    // decision: hooks are useful even though they *potentially* promote shared state between tests
     'jest/no-hooks': 'off',
+
+    // Disallow identical titles
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-identical-title.md
     'jest/no-identical-title': 'error',
-    'jest/no-if': 'error',
+
+    // Disallow string interpolation inside snapshots
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-interpolation-in-snapshots.md
     'jest/no-interpolation-in-snapshots': 'error',
+
+    // Disallow Jasmine globals
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-jasmine-globals.md
     'jest/no-jasmine-globals': 'error',
+
+    // Disallow importing Jest
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-jest-import.md
     'jest/no-jest-import': 'error',
-    // reasonable but arbitrary size limit
+
+    // disallow large snapshots
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-large-snapshots.md
+    // decision: arbitrary but reasonable size limit
     'jest/no-large-snapshots': ['error', { maxSize: 500 }],
+
+    // Disallow manually importing from `__mocks__`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-mocks-import.md
     'jest/no-mocks-import': 'error',
+
+    // Disallow specific matchers & modifiers
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-restricted-matchers.md
     'jest/no-restricted-matchers': 'error',
+
+    // Disallow using `expect` outside of `it` or `test` blocks
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-standalone-expect.md
     'jest/no-standalone-expect': 'error',
+
+    // Use `.only` and `.skip` over `f` and `x`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-test-prefixes.md
     'jest/no-test-prefixes': 'error',
+
+    // Disallow explicitly returning from tests
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-test-return-statement.md
     'jest/no-test-return-statement': 'error',
+
+    // Suggest using `toBeCalledWith()` or `toHaveBeenCalledWith()`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-called-with.md
     'jest/prefer-called-with': 'error',
+
+    // Suggest using the built-in comparison matchers
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-comparison-matcher.md
+    'jest/prefer-comparison-matcher': 'error',
+
+    // Suggest using the built-in equality matchers
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-equality-matcher.md
+    'jest/prefer-equality-matcher': 'error',
+
+    // Suggest using `expect.assertions()` OR `expect.hasAssertions()`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-expect-assertions.md
     'jest/prefer-expect-assertions': 'error',
+
+    // Prefer `await expect(...).resolves` over `expect(await ...)` syntax
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-expect-resolves.md
+    'jest/prefer-expect-resolves': 'error',
+
+    // Prefer having hooks in a consistent order
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-hooks-in-order.md
+    'jest/prefer-hooks-in-order': 'error',
+
+    // Suggest having hooks before any test cases
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-hooks-on-top.md
     'jest/prefer-hooks-on-top': 'error',
-    // descriptions are often named after React components which are capitalized
+
+    // Enforce lowercase test names
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-lowercase-title.md
+    // decision: descriptions are often named after React components which are capitalized
     'jest/prefer-lowercase-title': 'off',
+
+    // Prefer including a hint with external snapshots
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-snapshot-hint.md
+    'jest/prefer-snapshot-hint': 'error',
+
+    // Suggest using `jest.spyOn()`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-spy-on.md
     'jest/prefer-spy-on': 'error',
+
+    // Suggest using `toStrictEqual()`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-strict-equal.md
     'jest/prefer-strict-equal': 'error',
+
+    // Suggest using `toBe()` for primitive literals
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-to-be.md
     'jest/prefer-to-be': 'error',
+
+    // Suggest using `toContain()`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-to-contain.md
     'jest/prefer-to-contain': 'error',
+
+    // Suggest using `toHaveLength()`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-to-have-length.md
     'jest/prefer-to-have-length': 'error',
+
+    // Suggest using `test.todo`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-todo.md
     'jest/prefer-todo': 'error',
+
+    // Require setup and teardown code to be within a hook
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/require-hook.md
+    'jest/require-hook': 'error',
+
+    // Require a message for `toThrow()`
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/require-to-throw-message.md
     'jest/require-to-throw-message': 'error',
+
+    // Require test cases and hooks to be inside a `describe` block
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/require-top-level-describe.md
     'jest/require-top-level-describe': 'error',
+
+    // Enforce valid `describe()` callback
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-describe-callback.md
     'jest/valid-describe-callback': 'error',
+
+    // Enforce valid `expect()` usage
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-expect.md
     'jest/valid-expect': 'error',
+
+    // Ensure promises that have expectations in their chain are valid
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-expect-in-promise.md
     'jest/valid-expect-in-promise': 'error',
+
+    // Enforce valid titles
+    // https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-title.md
     'jest/valid-title': 'error',
 
-    // formatting rules for tests
+    // Formatting rules for tests:
+
+    // https://github.com/dangreenisrael/eslint-plugin-jest-formatting/blob/master/docs/rules/padding-around-after-all-blocks.md
     'jest-formatting/padding-around-after-all-blocks': 'error',
+
+    // https://github.com/dangreenisrael/eslint-plugin-jest-formatting/blob/master/docs/rules/padding-around-after-each-blocks.md
     'jest-formatting/padding-around-after-each-blocks': 'error',
+
+    // https://github.com/dangreenisrael/eslint-plugin-jest-formatting/blob/master/docs/rules/padding-around-before-all-blocks.md
     'jest-formatting/padding-around-before-all-blocks': 'error',
+
+    // https://github.com/dangreenisrael/eslint-plugin-jest-formatting/blob/master/docs/rules/padding-around-before-each-blocks.md
     'jest-formatting/padding-around-before-each-blocks': 'error',
+
+    // https://github.com/dangreenisrael/eslint-plugin-jest-formatting/blob/master/docs/rules/padding-around-expect-groups.md
     'jest-formatting/padding-around-expect-groups': 'error',
+
+    // https://github.com/dangreenisrael/eslint-plugin-jest-formatting/blob/master/docs/rules/padding-around-describe-blocks.md
     'jest-formatting/padding-around-describe-blocks': 'error',
+
+    // https://github.com/dangreenisrael/eslint-plugin-jest-formatting/blob/master/docs/rules/padding-around-test-blocks.md
     'jest-formatting/padding-around-test-blocks': 'error',
+
+    // https://github.com/dangreenisrael/eslint-plugin-jest-formatting/blob/master/docs/rules/padding-around-all.md
     'jest-formatting/padding-around-all': 'error',
   },
 };

package/rules/eslint/node.js

@@ -5,6 +5,7 @@ module.exports = {
 
   rules: {
     // enforce return after a callback
+    // https://eslint.org/docs/rules/callback-return
     'callback-return': 'off',
 
     // require all requires be top-level
@@ -12,6 +13,7 @@ module.exports = {
     'global-require': 'error',
 
     // enforces error handling in callbacks (node environment)
+    // https://eslint.org/docs/rules/handle-callback-err
     'handle-callback-err': 'off',
 
     // disallow use of the Buffer() constructor
@@ -19,9 +21,11 @@ module.exports = {
     'no-buffer-constructor': 'error',
 
     // disallow mixing regular variable and require declarations
+    // https://eslint.org/docs/rules/no-mixed-requires
     'no-mixed-requires': ['off', false],
 
     // disallow use of new operator with the require function
+    // https://eslint.org/docs/rules/no-new-require
     'no-new-require': 'error',
 
     // disallow string concatenation with __dirname and __filename
@@ -29,15 +33,19 @@ module.exports = {
     'no-path-concat': 'error',
 
     // disallow use of process.env
+    // https://eslint.org/docs/rules/no-process-env
     'no-process-env': 'off',
 
     // disallow process.exit()
+    // https://eslint.org/docs/rules/no-process-exit
     'no-process-exit': 'off',
 
     // restrict usage of specified node modules
+    // https://eslint.org/docs/rules/no-restricted-modules
     'no-restricted-modules': 'off',
 
-    // disallow use of synchronous methods (off by default)
+    // disallow use of synchronous methods
+    // https://eslint.org/docs/rules/no-sync
     'no-sync': 'off',
   },
 };

package/rules/eslint/prettier.js

@@ -3,6 +3,7 @@
 module.exports = {
   rules: {
     // prettier configuration
+    // https://github.com/prettier/eslint-plugin-prettier#options
     'prettier/prettier': 'error',
   },
 };

package/rules/eslint/react.js

@@ -15,6 +15,8 @@ module.exports = {
     // https://eslint.org/docs/rules/jsx-quotes
     'jsx-quotes': ['error', 'prefer-double'],
 
+    // Enforce that class methods utilize this
+    // https://eslint.org/docs/rules/class-methods-use-this
     'class-methods-use-this': [
       'off',
       {
@@ -146,6 +148,7 @@ module.exports = {
     ],
 
     // Deprecated in favor of react/jsx-sort-props
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-sort-prop-types.md
     'react/jsx-sort-prop-types': 'off',
 
     // Enforce props alphabetical sorting