@wistia/eslint-config 0.27.0 → 0.29.0

package/configs/eslint/functional-programming.cjs

@@ -0,0 +1,9 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
+module.exports = {
+  env: {
+    node: true,
+  },
+
+  extends: ['../../rules/eslint/functional-programming.cjs'].map(require.resolve),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "0.27.0",
+  "version": "0.29.0",
   "packageManager": "yarn@4.0.2",
   "description": "Wistia's ESLint configurations",
   "main": "react.js",
@@ -12,6 +12,7 @@
     "./package.json": "./package.json",
     ".": "./configs/eslint/default.cjs",
     "./cypress": "./configs/eslint/cypress.cjs",
+    "./functional-programming": "./configs/eslint/functional-programming.cjs",
     "./jest": "./configs/eslint/jest.cjs",
     "./jsdoc": "./configs/eslint/jsdoc.cjs",
     "./node": "./configs/eslint/node.cjs",
@@ -37,31 +38,32 @@
     "test:stylelint": "stylelint --print-config ./test/index.mjs"
   },
   "dependencies": {
-    "@babel/core": "^7.23.5",
+    "@babel/core": "^7.23.7",
     "@babel/eslint-parser": "^7.23.3",
     "@babel/preset-react": "^7.23.3",
-    "@rushstack/eslint-patch": "^1.6.0",
-    "@testing-library/dom": "^9.3.3",
-    "@typescript-eslint/eslint-plugin": "^6.13.2",
-    "@typescript-eslint/parser": "^6.13.2",
+    "@rushstack/eslint-patch": "^1.6.1",
+    "@testing-library/dom": "^9.3.4",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
     "confusing-browser-globals": "^1.0.11",
-    "eslint": "^8.55.0",
+    "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-better-styled-components": "^1.1.2",
     "eslint-plugin-cypress": "^2.15.1",
     "eslint-plugin-filenames": "^1.3.2",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-jest": "^27.6.0",
+    "eslint-plugin-fp": "^2.3.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^27.6.2",
     "eslint-plugin-jest-dom": "^5.1.0",
     "eslint-plugin-jest-formatting": "^3.1.0",
-    "eslint-plugin-jsdoc": "^46.9.0",
+    "eslint-plugin-jsdoc": "^48.0.2",
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-no-snapshot-testing": "^1.0.61",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-observers": "^1.0.1",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-prettier": "^5.1.3",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
@@ -69,22 +71,22 @@
     "eslint-plugin-storybook": "^0.6.15",
     "eslint-plugin-styled-components-a11y": "^2.1.31",
     "eslint-plugin-testing-library": "^6.2.0",
-    "postcss": "^8.4.32",
+    "postcss": "^8.4.33",
     "postcss-scss": "^4.0.9",
-    "postcss-styled-syntax": "^0.5.0",
+    "postcss-styled-syntax": "^0.6.4",
     "prettier": "^3.1.1",
-    "stylelint": "^16.0.1",
-    "stylelint-declaration-block-no-ignored-properties": "^2.7.0",
+    "stylelint": "^16.1.0",
+    "stylelint-declaration-block-no-ignored-properties": "^2.8.0",
     "stylelint-prettier": "^5.0.0",
     "stylelint-scss": "^6.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.4.3",
-    "@commitlint/config-conventional": "^18.4.3",
+    "@commitlint/cli": "^18.4.4",
+    "@commitlint/config-conventional": "^18.4.4",
     "check-export-map": "^1.3.1",
     "husky": "^8.0.3",
     "typescript": "^5.3.3",
-    "vitest": "^1.0.4"
+    "vitest": "^1.1.3"
   },
   "engines": {
     "node": "^12.22.0 || ^14.17.0 || >=16.0.0"

package/rules/eslint/functional-programming.cjs

@@ -0,0 +1,80 @@
+// only add rules related to functional programming
+// see: https://github.com/jfmengels/eslint-plugin-fp
+
+module.exports = {
+  plugins: ['eslint-plugin-fp'],
+
+  rules: {
+    // Match Exported Values
+    // https://github.com/selaux/eslint-plugin-filenames#matching-exported-values-match-exported
+    'filenames/match-exported': 'error',
+
+    // Forbid the use of arguments.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-arguments.md
+    'fp/no-arguments': 'error',
+
+    // Forbid the use of class.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-class.md
+    'fp/no-class': 'error',
+
+    // Forbid the use of delete.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-delete.md
+    'fp/no-delete': 'error',
+
+    // Forbid the use of the events module.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-events.md
+    'fp/no-events': 'error',
+
+    // Forbid the use of getters and setters.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-get-set.md
+    'fp/no-get-set': 'error',
+
+    // Forbid the use of let.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-let.md
+    'fp/no-let': 'error',
+
+    // Forbid the use of loops.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-loops.md
+    'fp/no-loops': 'error',
+
+    // Forbid the use of Object.assign() with a variable as first argument.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-mutating-assign.md
+    'fp/no-mutating-assign': 'error',
+
+    // Forbid the use of mutating methods.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-mutating-methods.md
+    'fp/no-mutating-methods': 'error',
+
+    // Forbid the use of mutating operators.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-mutation.md
+    'fp/no-mutation': 'error',
+
+    // Forbid the use of null and undefined.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-nil.md
+    'fp/no-nil': 'error',
+
+    // Forbid the use of Proxy.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-proxy.md
+    'fp/no-proxy': 'error',
+
+    // Forbid the use of rest parameters.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-rest-parameters.md
+    'fp/no-rest-parameters': 'error',
+
+    // Forbid the use of this.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-this.md
+    'fp/no-this': 'error',
+
+    // Forbid the use of throw.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-throw.md
+    'fp/no-throw': 'error',
+
+    // Enforce that an expression gets used.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-unused-expression.md
+    'fp/no-unused-expression': 'error',
+
+    // Forbid the creation of valueOf fields.
+    // https://github.com/jfmengels/eslint-plugin-fp/blob/master/docs/rules/no-valueof-field.md
+    'fp/no-valueof-field': 'error',
+  },
+};

package/rules/eslint/typescript-react.cjs

@@ -4,15 +4,20 @@ module.exports = {
   plugins: ['@typescript-eslint'],
 
   rules: {
-    // Enforce a defaultProps definition for every prop that is not a required prop
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/require-default-props.md
     // decision: default prop types shouldn't be necessary for optional parameters as they can just default to undefined
     'react/require-default-props': 'off',
 
-    // Disallow JSX props spreading
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-props-no-spreading.md
     // decision: because we have type safety in TypeScript, this rule isn't necessary as we will see
     // TS errors for prop spreading against mismatched (prop)type declarations
     'react/jsx-props-no-spreading': 'off',
+
+    // decision: TypeScript requires our props to be defined in a type or interface, so we do not need
+    // to have any rules regarding prop-types
+    'react/prop-types': 'off',
+    'react/sort-prop-types': 'off',
+    'react/default-props-match-prop-types': 'off',
+    'react/forbid-foreign-prop-types': 'off',
+    'react/forbid-prop-types': 'off',
+    'react/no-unused-prop-types': 'off',
   },
 };