@open-turo/eslint-config-react 1.1.1 → 1.3.0

package/README.md

@@ -30,14 +30,8 @@ Install the package and all of its peer dependencies:
 npx install-peerdeps --dev @open-turo/eslint-config-react
 ```
 
-Then in your `.eslintrc` file extend from one of the two configurations included in this package:
-
-1. The default, based on our existing front-end repositories
-2. The "extended", which adds more react-related plugins. We intend to transition to this one as default over time
-
-### Default config
-
-The default config of this repo is the recommended version for nour existing front-end projects.
+Then in your `.eslintrc` file, extend from the default configuration of this package, which is the recommended eslint
+configuration for our existing front-end projects.
 
 To use this config, just add to your `.eslintrc` the following:
 
@@ -45,21 +39,13 @@ To use this config, just add to your `.eslintrc` the following:
 "extends": "@open-turo/eslint-config-typescript"
 ```
 
-### Extended config (extended react-related rules)
-
-We also provide an alternative `extended` preset, which adds more react-related plugins.
-We intend to transition to this one as default over time; and we encourage you to use it for new projects.
-
-If you want to use this `extended` configuration, you can import it by instead adding the following to your `.eslintrc`:
-
-```
-"extends": "@open-turo/eslint-config-typescript/extended"
-```
-
-Simply notice the `/extended` suffix, which points to the `extended.js` file in this repository.
+We used to have an alternative `extended` preset, which added more react-related plugins, but after some testing, it
+has been integrated into the default preset.
 
 ## Development
 
+### Pre-commit
+
 Install [pre-commit](https://pre-commit.com/) and the commit hooks:
 
 ```shell
@@ -67,6 +53,11 @@ pre-commit install
 pre-commit install --hook-type commit-msg
 ```
 
+### Keeping peerDependencies up-to-date
+
+Transitive `peerDependencies` should be added, and kept up to date. A useful tool for that task is
+`npx check-peer-dependencies`, which shows us our missing (or outdated) peerDependencies.
+
 ## Get Help
 
 Please review Issues, post new Issues against this repository as needed.

package/index.js

@@ -1,11 +1,28 @@
 module.exports = {
   root: true,
+  plugins: ["react", "react-hooks", "jsx-a11y"],
   env: {
     browser: true,
   },
   ignorePatterns: ["babel.config.js"],
-  extends: ["@open-turo/eslint-config-typescript/legacy"],
+  extends: [
+    "@open-turo/eslint-config-typescript/legacy",
+    "plugin:react/recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:jsx-a11y/recommended",
+  ],
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
   rules: {
+    "jsx-a11y/anchor-is-valid": [
+      "warn",
+      {
+        specialLink: ["to"],
+      },
+    ],
     "node/no-unpublished-import": [
       "error",
       {
@@ -18,5 +35,25 @@ module.exports = {
         ],
       },
     ],
+    // don't force .jsx extension
+    "react/jsx-filename-extension": "off",
+    // In TS you must use the Fragment syntax instead of the shorthand
+    "react/jsx-fragments": "off",
+    // This allows props to be spread in JSX
+    "react/jsx-props-no-spreading": "off",
+    // ensure props are alphabetical
+    "react/jsx-sort-props": "error",
+    // We don't need default props on TS components
+    "react/require-default-props": "off",
+    "react/sort-prop-types": "error",
+    // State initialization can be in the constructor or via class fields
+    "react/state-in-constructor": "off",
+    // This allows static properties to be placed within the class declaration
+    "react/static-property-placement": "off",
+  },
+  settings: {
+    react: {
+      version: "detect",
+    },
   },
 };

package/package.json

@@ -4,14 +4,25 @@
   "devDependencies": {
     "@commitlint/cli": "^17.0.0",
     "@open-turo/commitlint-config-conventional": "^1.0.2",
-    "@open-turo/eslint-config-typescript": "2.0.0",
+    "@open-turo/eslint-config-typescript": "^2.1.0",
     "@semantic-release/git": "^10.0.1",
-    "@typescript-eslint/eslint-plugin": "^5.20.0",
-    "@typescript-eslint/parser": "^5.20.0",
-    "eslint": "^8.28.0",
+    "@typescript-eslint/eslint-plugin": "^5.46.0",
+    "@typescript-eslint/parser": "^5.46.0",
+    "eslint": ">=8.18.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "^3.5.2",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^27.1.6",
     "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-react": "^7.29.4",
     "eslint-plugin-react-hooks": "^4.4.0",
+    "eslint-plugin-simple-import-sort": "^8.0.0",
+    "eslint-plugin-sonarjs": "^0.16.0",
+    "eslint-plugin-sort-destructure-keys": "^1.4.0",
+    "eslint-plugin-typescript-sort-keys": "^2.1.0",
+    "prettier": "^2.5.1",
     "semantic-release": "^19.0.2",
     "semantic-release-github-pullrequest": "^1.3.0"
   },
@@ -23,17 +34,28 @@
   "main": "index.js",
   "name": "@open-turo/eslint-config-react",
   "peerDependencies": {
-    "@open-turo/eslint-config-typescript": "2.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.20.0",
-    "@typescript-eslint/parser": "^5.20.0",
-    "eslint": ">=8.16.0",
+    "@open-turo/eslint-config-typescript": "^2.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.46.0",
+    "@typescript-eslint/parser": "^5.46.0",
+    "eslint": ">=8.18.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "^3.5.2",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^27.1.6",
     "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-simple-import-sort": "^8.0.0",
+    "eslint-plugin-sonarjs": "^0.16.0",
+    "eslint-plugin-sort-destructure-keys": "^1.4.0",
+    "eslint-plugin-typescript-sort-keys": "^2.1.0",
     "eslint-plugin-react": "^7.29.4",
-    "eslint-plugin-react-hooks": "^4.4.0"
+    "eslint-plugin-react-hooks": "^4.4.0",
+    "prettier": "^2.5.1"
   },
   "publishConfig": {
     "access": "public"
   },
   "repository": "https://github.com/open-turo/eslint-config-react",
-  "version": "1.1.1"
+  "version": "1.3.0"
 }

package/extended.js

@@ -1,43 +0,0 @@
-module.exports = {
-  root: true,
-  plugins: ["react", "react-hooks", "jsx-a11y"],
-  extends: [
-    "./index.js",
-    "plugin:react/recommended",
-    "plugin:react-hooks/recommended",
-    "plugin:jsx-a11y/recommended",
-  ],
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-  },
-  rules: {
-    "jsx-a11y/anchor-is-valid": [
-      "warn",
-      {
-        specialLink: ["to"],
-      },
-    ],
-    // don't force .jsx extension
-    "react/jsx-filename-extension": "off",
-    // In TS you must use the Fragment syntax instead of the shorthand
-    "react/jsx-fragments": "off",
-    // This allows props to be spread in JSX
-    "react/jsx-props-no-spreading": "off",
-    // ensure props are alphabetical
-    "react/jsx-sort-props": "error",
-    // We don't need default props on TS components
-    "react/require-default-props": "off",
-    "react/sort-prop-types": "error",
-    // State initialization can be in the constructor or via class fields
-    "react/state-in-constructor": "off",
-    // This allows static properties to be placed within the class declaration
-    "react/static-property-placement": "off",
-  },
-  settings: {
-    react: {
-      version: "detect",
-    },
-  },
-};