@open-turo/eslint-config-react 1.1.0 → 1.2.0

package/.github/workflows/ci.yaml

@@ -8,7 +8,8 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Download actionlint

package/.github/workflows/release.yaml

@@ -9,10 +9,11 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - name: Semantic Release
+      - name: Semantic release
         id: release
         uses: cycjimmy/semantic-release-action@v2
         with:

package/README.md

@@ -13,6 +13,15 @@ repository extend the default `@open-turo/eslint-config-typescript` config inste
 free to create a PR to add a new default that extends it, and rename the current configurations to `legacy` and
 `legacy-extended` respectively. We are not doing that for now to reduce maintenance burden, as it would be unused.
 
+[![Release](https://img.shields.io/github/v/release/open-turo/eslint-config-react)](https://github.com/open-turo/eslint-config-react/releases/)
+[![Tests pass/fail](https://img.shields.io/github/workflow/status/open-turo/eslint-config-react/CI)](https://github.com/open-turo/eslint-config-react/actions/)
+[![License](https://img.shields.io/github/license/open-turo/eslint-config-react)](./LICENSE)
+[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/dwyl/esta/issues)
+![CI](https://github.com/open-turo/eslint-config-react/actions/workflows/release.yaml/badge.svg)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+[![Conventional commits](https://img.shields.io/badge/conventional%20commits-1.0.2-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![Join us!](https://img.shields.io/badge/Turo-Join%20us%21-593CFB.svg)](https://turo.com/jobs)
+
 ## Usage
 
 Install the package and all of its peer dependencies:
@@ -21,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:
 
@@ -36,18 +39,8 @@ 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
 

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

@@ -35,5 +35,5 @@
     "access": "public"
   },
   "repository": "https://github.com/open-turo/eslint-config-react",
-  "version": "1.1.0"
+  "version": "1.2.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",
-    },
-  },
-};