@wistia/eslint-config 0.9.0 → 0.9.2

package/configs/eslint/cypress.js

@@ -1,3 +1,5 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
 module.exports = {
   env: {
     'cypress/globals': true,

package/configs/eslint/default.js

@@ -1,3 +1,5 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
 module.exports = {
   parser: '@babel/eslint-parser',
   parserOptions: {

package/configs/eslint/jest.js

@@ -1,3 +1,5 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
 module.exports = {
   env: {
     jest: true,

package/configs/eslint/prettier.js

@@ -1,3 +1,5 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
 module.exports = {
   plugins: ['eslint-plugin-prettier'],
   extends: ['../../rules/eslint/prettier', 'eslint-config-prettier'].map(require.resolve),

package/configs/eslint/react.js

@@ -1,3 +1,5 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
 module.exports = {
   env: {
     browser: true,

package/configs/eslint/strict.js

@@ -1,3 +1,5 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
 module.exports = {
   plugins: ['eslint-plugin-sonarjs'],
   extends: ['../../rules/eslint/sonar'].map(require.resolve),

package/configs/eslint/styled-components.js

@@ -1,3 +1,5 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
 module.exports = {
   plugins: ['eslint-plugin-better-styled-components', 'eslint-plugin-styled-components-a11y'],
   extends: ['../../rules/eslint/styled-components'].map(require.resolve),

package/configs/eslint/testing-library.js

@@ -1,3 +1,5 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
 module.exports = {
   plugins: ['eslint-plugin-testing-library', 'eslint-plugin-jest-dom'],
   extends: ['../../rules/eslint/testing-library'].map(require.resolve),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "Wistia's ESLint configurations",
   "main": "react.js",
   "exports": {
@@ -18,16 +18,17 @@
     "./testing-library": "./configs/eslint/testing-library.js"
   },
   "scripts": {
-    "lint": "eslint --fix --ignore-path test/.eslintignore .",
+    "lint": "eslint --fix .",
     "prepare": "husky install",
-    "test": "check-export-map && yarn run test:eslint && yarn run test:stylelint",
-    "test:eslint": "eslint --print-config ./test/index.js",
+    "test": "jest",
+    "test:export": "check-export-map",
     "test:stylelint": "stylelint --print-config ./test/index.js"
   },
   "dependencies": {
     "@babel/core": "^7.18.9",
     "@babel/eslint-parser": "^7.18.9",
     "@babel/preset-react": "^7.18.6",
+    "@rushstack/eslint-patch": "^1.1.4",
     "@typescript-eslint/eslint-plugin": "^5.30.7",
     "@typescript-eslint/parser": "^5.30.7",
     "confusing-browser-globals": "^1.0.11",
@@ -63,11 +64,18 @@
     "@commitlint/cli": "^17.0.3",
     "@commitlint/config-conventional": "^17.0.3",
     "check-export-map": "^1.3.0",
-    "husky": "^8.0.1"
+    "husky": "^8.0.1",
+    "jest": "^28.1.3",
+    "jest-specific-snapshot": "^5.0.0"
   },
   "engines": {
     "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
   },
+  "jest": {
+    "setupFiles": [
+      "<rootDir>/test/setupFiles.js"
+    ]
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wistia/eslint-config.git"

package/rules/eslint/errors.js

@@ -202,6 +202,7 @@ module.exports = {
 
     // ensure JSDoc comments are valid
     // https://eslint.org/docs/rules/valid-jsdoc
+    // deprecated in favor of https://github.com/gajus/eslint-plugin-jsdoc
     'valid-jsdoc': 'off',
 
     // ensure that the results of typeof are compared against a valid string

package/rules/eslint/react.js

@@ -18,7 +18,7 @@ module.exports = {
     // Enforce that class methods utilize this
     // https://eslint.org/docs/rules/class-methods-use-this
     'class-methods-use-this': [
-      'off',
+      'error',
       {
         exceptMethods: [
           'render',
@@ -46,7 +46,7 @@ module.exports = {
     'react/display-name': ['off', { ignoreTranspilerName: false }],
 
     // Forbid certain propTypes (any, array, object)
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/forbid-prop-types.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/forbid-prop-types.md
     'react/forbid-prop-types': [
       'error',
       {
@@ -57,7 +57,7 @@ module.exports = {
     ],
 
     // Forbid certain props on DOM Nodes
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/forbid-dom-props.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/forbid-dom-props.md
     'react/forbid-dom-props': ['off', { forbid: [] }],
 
     // Enforce boolean attributes notation in JSX; enable for consistency
@@ -84,7 +84,7 @@ module.exports = {
         eventHandlerPrefix: 'handle',
         eventHandlerPropPrefix: 'on',
         checkLocalVariables: true,
-        checkInlineFunction: true,
+        checkInlineFunction: false,
       },
     ],
 
@@ -166,7 +166,7 @@ module.exports = {
     ],
 
     // Enforce defaultProps declarations alphabetical sorting
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/jsx-sort-default-props.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-sort-default-props.md
     'react/jsx-sort-default-props': [
       'error',
       {
@@ -262,7 +262,7 @@ module.exports = {
     'react/self-closing-comp': 'error',
 
     // Enforce component methods order
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/sort-comp.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/sort-comp.md
     'react/sort-comp': [
       'error',
       {
@@ -314,7 +314,7 @@ module.exports = {
     ],
 
     // Prevent missing parentheses around multilines JSX
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/jsx-wrap-multilines.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-wrap-multilines.md
     'react/jsx-wrap-multilines': [
       'error',
       {
@@ -341,7 +341,7 @@ module.exports = {
     'react/jsx-indent': ['error', 2],
 
     // Disallow target="_blank" on links
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/ac102885765be5ff37847a871f239c6703e1c7cc/docs/rules/jsx-no-target-blank.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-no-target-blank.md
     'react/jsx-no-target-blank': ['error', { enforceDynamicLinks: 'always' }],
 
     // only .jsx files may have JSX
@@ -399,7 +399,7 @@ module.exports = {
     'react/no-children-prop': 'error',
 
     // Validate whitespace in and around the JSX opening and closing brackets
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/jsx-tag-spacing.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-tag-spacing.md
     'react/jsx-tag-spacing': [
       'error',
       {
@@ -420,7 +420,7 @@ module.exports = {
     'react/no-array-index-key': 'error',
 
     // Enforce a defaultProps definition for every prop that is not a required prop
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/require-default-props.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/require-default-props.md
     'react/require-default-props': [
       'error',
       {
@@ -437,11 +437,11 @@ module.exports = {
     'react/void-dom-elements-no-children': 'error',
 
     // Enforce all defaultProps have a corresponding non-required PropType
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/9e13ae2c51e44872b45cc15bf1ac3a72105bdd0e/docs/rules/default-props-match-prop-types.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/default-props-match-prop-types.md
     'react/default-props-match-prop-types': ['error', { allowRequiredDefaults: false }],
 
     // Prevent usage of shouldComponentUpdate when extending React.PureComponent
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/9e13ae2c51e44872b45cc15bf1ac3a72105bdd0e/docs/rules/no-redundant-should-component-update.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-redundant-should-component-update.md
     'react/no-redundant-should-component-update': 'error',
 
     // Prevent unused state values
@@ -449,7 +449,7 @@ module.exports = {
     'react/no-unused-state': 'error',
 
     // Enforces consistent naming for boolean props
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/boolean-prop-naming.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/boolean-prop-naming.md
     'react/boolean-prop-naming': [
       'off',
       {
@@ -460,7 +460,7 @@ module.exports = {
     ],
 
     // Prevents common casing typos
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/73abadb697034b5ccb514d79fb4689836fe61f91/docs/rules/no-typos.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-typos.md
     'react/no-typos': 'error',
 
     // Enforce curly braces or disallow unnecessary curly braces in JSX props and/or children
@@ -469,20 +469,20 @@ module.exports = {
 
     // One JSX Element Per Line
     // disabled because it is overreaching in it's prescriptiveness
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/jsx-one-expression-per-line.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-one-expression-per-line.md
     'react/jsx-one-expression-per-line': ['off', { allow: 'single-child' }],
 
     // Enforce consistent usage of destructuring assignment of props, state, and context
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/destructuring-assignment.md
     // decision: it's acceptable to mix these even at the expense of consistency
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/destructuring-assignment.md
     'react/destructuring-assignment': ['off', 'always'],
 
     // Prevent using this.state within a this.setState
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/no-access-state-in-setstate.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-access-state-in-setstate.md
     'react/no-access-state-in-setstate': 'error',
 
     // Prevent usage of button elements without an explicit type attribute
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/button-has-type.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/button-has-type.md
     'react/button-has-type': [
       'error',
       {
@@ -496,23 +496,23 @@ module.exports = {
     'react/jsx-child-element-spacing': 'off',
 
     // Prevent this from being used in stateless functional components
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/no-this-in-sfc.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-this-in-sfc.md
     'react/no-this-in-sfc': 'error',
 
     // Validate JSX maximum depth
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/abe8381c0d6748047224c430ce47f02e40160ed0/docs/rules/jsx-max-depth.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-max-depth.md
     'react/jsx-max-depth': 'off',
 
     // Disallow multiple spaces between inline JSX props
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/ac102885765be5ff37847a871f239c6703e1c7cc/docs/rules/jsx-props-no-multi-spaces.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-props-no-multi-spaces.md
     'react/jsx-props-no-multi-spaces': 'error',
 
     // Prevent usage of UNSAFE_ methods
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/157cc932be2cfaa56b3f5b45df6f6d4322a2f660/docs/rules/no-unsafe.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-unsafe.md
     'react/no-unsafe': 'off',
 
     // Enforce shorthand or standard form for React fragments
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/bc976b837abeab1dffd90ac6168b746a83fc83cc/docs/rules/jsx-fragments.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-fragments.md
     'react/jsx-fragments': ['error', 'syntax'],
 
     // Enforce linebreaks in curly braces in JSX attributes and expressions.
@@ -580,48 +580,48 @@ module.exports = {
     ],
 
     // Enforce a new line after jsx elements and expressions
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/e2eaadae316f9506d163812a09424eb42698470a/docs/rules/jsx-newline.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-newline.md
     'react/jsx-newline': 'off',
 
     // Prevent react contexts from taking non-stable values
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/e2eaadae316f9506d163812a09424eb42698470a/docs/rules/jsx-no-constructed-context-values.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-no-constructed-context-values.md
     'react/jsx-no-constructed-context-values': 'error',
 
     // Prevent creating unstable components inside components
     // decision: adjusted to allow for render props
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/c2a790a3472eea0f6de984bdc3ee2a62197417fb/docs/rules/no-unstable-nested-components.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-unstable-nested-components.md
     'react/no-unstable-nested-components': ['error', { allowAsProps: true }],
 
     // Enforce that namespaces are not used in React elements
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/8785c169c25b09b33c95655bf508cf46263bc53f/docs/rules/no-namespace.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-namespace.md
     'react/no-namespace': 'error',
 
     // Prefer exact proptype definitions
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/8785c169c25b09b33c95655bf508cf46263bc53f/docs/rules/prefer-exact-props.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/prefer-exact-props.md
     'react/prefer-exact-props': 'error',
 
     // Lifecycle methods should be methods on the prototype, not class fields
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/21e01b61af7a38fc86d94f27eb66cda8054582ed/docs/rules/no-arrow-function-lifecycle.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-arrow-function-lifecycle.md
     'react/no-arrow-function-lifecycle': 'error',
 
     // Prevent usage of invalid attributes
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/21e01b61af7a38fc86d94f27eb66cda8054582ed/docs/rules/no-invalid-html-attribute.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-invalid-html-attribute.md
     'react/no-invalid-html-attribute': 'error',
 
     // Prevent declaring unused methods of component class
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/21e01b61af7a38fc86d94f27eb66cda8054582ed/docs/rules/no-unused-class-component-methods.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-unused-class-component-methods.md
     'react/no-unused-class-component-methods': 'error',
 
     // Ensure destructuring and symmetric naming of useState hook value and setter variables
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/c8833f301314dab3e79ef7ac4cf863e4d5fa0019/docs/rules/hook-use-state.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/hook-use-state.md
     'react/hook-use-state': 'error',
 
     // Enforce sandbox attribute on iframe elements
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/c8833f301314dab3e79ef7ac4cf863e4d5fa0019/docs/rules/iframe-missing-sandbox.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/iframe-missing-sandbox.md
     'react/iframe-missing-sandbox': 'error',
 
     // Prevent problematic leaked values from being rendered
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/c42b624d0fb9ad647583a775ab9751091eec066f/docs/rules/jsx-no-leaked-render.md
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-no-leaked-render.md
     'react/jsx-no-leaked-render': 'error',
   },