eslint-config-seek 8.0.0 → 10.0.0

package/.eslintrc.js

@@ -70,7 +70,10 @@ const baseRules = {
   'prefer-const': ERROR,
   'prefer-spread': ERROR,
   'prefer-template': ERROR,
-  'no-return-await': ERROR,
+  // Allow devs to choose between performance and richer stack traces
+  // https://eslint.org/docs/rules/no-return-await#when-not-to-use-it
+  // https://github.com/goldbergyoni/nodebestpractices/blob/master@%7B2022-01-01T00:00:00Z%7D/sections/errorhandling/returningpromises.md
+  'no-return-await': OFF,
 };
 
 const reactRules = {
@@ -85,10 +88,13 @@ const reactRules = {
 };
 
 const baseConfig = {
-  parser: 'babel-eslint',
+  parser: '@babel/eslint-parser',
   parserOptions: {
+    babelOptions: {
+      presets: ['@babel/preset-react'],
+    },
+    requireConfigFile: false,
     sourceType: 'module',
-    ecmaFeatures: { jsx: true },
   },
   root: true,
   env: {
@@ -118,7 +124,7 @@ const baseConfig = {
       extends: [
         'plugin:@typescript-eslint/eslint-recommended',
         'plugin:@typescript-eslint/recommended',
-        'prettier/@typescript-eslint',
+        'prettier',
       ],
       rules: {
         '@typescript-eslint/no-unused-expressions': ERROR,
@@ -137,7 +143,6 @@ const baseConfig = {
           ERROR,
           { ignoreParameters: true },
         ],
-        '@typescript-eslint/explicit-module-boundary-types': OFF,
         // prefer TypeScript exhaustiveness checking
         // https://www.typescriptlang.org/docs/handbook/advanced-types.html#exhaustiveness-checking
         'default-case': OFF,

package/.github/workflows/release.yml

@@ -15,6 +15,10 @@ jobs:
     steps:
       - name: Check out repo
         uses: actions/checkout@main
+        with:
+          # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
+          fetch-depth: 0
+          token: ${{ secrets.SEEK_OSS_CI_GITHUB_TOKEN }}
 
       - name: Set up Node.js 16.x
         uses: actions/setup-node@main

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # eslint-config-seek
 
+## 10.0.0
+
+### Major Changes
+
+- eslint-plugin-jest 27 ([#79](https://github.com/seek-oss/eslint-config-seek/pull/79))
+
+  This major release includes breaking changes. See the [release note](https://github.com/jest-community/eslint-plugin-jest/releases/tag/v27.0.0) for more information.
+
+  The `jest/no-alias-methods` rule is now [enforced](https://github.com/jest-community/eslint-plugin-jest/pull/1221) to discourage usage of alias methods that will be [removed in Jest 30](https://github.com/facebook/jest/issues/13164).
+
+  ```diff
+  - .toBeCalled()
+  + .toHaveBeenCalled()
+  ```
+
+## 9.0.0
+
+### Major Changes
+
+- Support ESLint 8.x ([#73](https://github.com/seek-oss/eslint-config-seek/pull/73))
+
+  We've upgraded the parsers and plugins bundled in `eslint-config-seek` for ESLint 8.x compatibility. Some linting rules have changed and may require manual triage. In particular, we've applied the following major upgrades:
+
+  - [TypeScript ESLint v5](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v5.0.0)
+
+    This includes changes to the recommended rule set.
+
+  - [`babel-eslint`](https://www.npmjs.com/package/babel-eslint) → [`@babel/eslint-parser`](https://www.npmjs.com/package/@babel/eslint-parser)
+
+    This resolves the following installation warning:
+
+    ```console
+    babel-eslint is now @babel/eslint-parser. This package will no longer receive updates.
+    ```
+
+  - [`eslint-config-prettier` v8](https://github.com/prettier/eslint-config-prettier/blob/HEAD/CHANGELOG.md?rgh-link-date=2021-10-18T05%3A10%3A39Z#version-800-2021-02-21)
+
+    This unifies on a single `prettier` config.
+
+  [`eslint-plugin-cypress`](https://github.com/cypress-io/eslint-plugin-cypress/issues/89) is currently incompatible with ESLint 8.x. Projects that utilise Cypress should remain on ESLint 7.x.
+
+### Minor Changes
+
+- Turn off [`no-return-await`](https://eslint.org/docs/rules/no-return-await) ([#74](https://github.com/seek-oss/eslint-config-seek/pull/74))
+
+  `return await` produces [richer stack traces with a marginal performance penalty](https://github.com/goldbergyoni/nodebestpractices/blob/master@%7B2022-01-01T00:00:00Z%7D/sections/errorhandling/returningpromises.md) in recent Node.js versions. This tradeoff is now left to individual consumers to weigh up and optionally enforce.
+
 ## 8.0.0
 
 ### Major Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-seek",
-  "version": "8.0.0",
+  "version": "10.0.0",
   "description": "ESLint configuration used by SEEK",
   "main": ".eslintrc.js",
   "repository": {
@@ -19,22 +19,24 @@
   },
   "homepage": "https://github.com/seek-oss/eslint-config-seek#readme",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.8.1",
-    "@typescript-eslint/parser": "^4.8.1",
-    "babel-eslint": "^10.1.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-import-resolver-node": "^0.3.3",
-    "eslint-plugin-cypress": "^2.11.1",
-    "eslint-plugin-import": "^2.21.2",
-    "eslint-plugin-jest": "^25.2.2",
-    "eslint-plugin-react": "^7.20.0",
-    "eslint-plugin-react-hooks": "^4.0.4",
+    "@babel/core": "^7.17.8",
+    "@babel/eslint-parser": "^7.17.0",
+    "@babel/preset-react": "^7.16.7",
+    "@typescript-eslint/eslint-plugin": "^5.16.0",
+    "@typescript-eslint/parser": "^5.16.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-node": "^0.3.6",
+    "eslint-plugin-cypress": "^2.12.1",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^27.0.1",
+    "eslint-plugin-react": "^7.29.4",
+    "eslint-plugin-react-hooks": "^4.3.0",
     "find-root": "^1.1.0"
   },
   "devDependencies": {
     "@changesets/cli": "2.17.0",
     "@changesets/get-github-info": "0.5.0",
-    "eslint": "^7.14.0",
+    "eslint": "8.11.0",
     "prettier": "2.4.1",
     "typescript": "^4.1.2"
   },