eslint-config-seek 7.0.9 → 9.0.0

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/changelog.js

@@ -0,0 +1,162 @@
+const {
+  getInfo,
+  getInfoFromPullRequest,
+} = require('@changesets/get-github-info');
+
+/**
+ * Adapted from `@changesets/cli`.
+ *
+ * {@link https://github.com/atlassian/changesets/blob/%40changesets/cli%402.17.0/packages/cli/src/changelog/index.ts}
+ *
+ * @type import('@changesets/types').ChangelogFunctions
+ */
+const defaultChangelogFunctions = {
+  getDependencyReleaseLine: async (changesets, dependenciesUpdated) => {
+    if (dependenciesUpdated.length === 0) return '';
+
+    const changesetLinks = changesets.map(
+      (changeset) => `- Updated dependencies [${changeset.commit}]`,
+    );
+
+    const updatedDependenciesList = dependenciesUpdated.map(
+      (dependency) => `  - ${dependency.name}@${dependency.newVersion}`,
+    );
+
+    return [...changesetLinks, ...updatedDependenciesList].join('\n');
+  },
+  getReleaseLine: async (changeset) => {
+    const [firstLine, ...futureLines] = changeset.summary
+      .split('\n')
+      .map((l) => l.trimRight());
+
+    const suffix = changeset.commit;
+
+    return `\n\n- ${firstLine}${suffix ? ` (${suffix})` : ''}\n${futureLines
+      .map((l) => `  ${l}`)
+      .join('\n')}`;
+  },
+};
+
+/**
+ * Adapted from `@changesets/changelog-github`.
+ *
+ * {@link https://github.com/atlassian/changesets/blob/%40changesets/changelog-github%400.4.1/packages/changelog-github/src/index.ts}
+ *
+ * @type import('@changesets/types').ChangelogFunctions
+ */
+const gitHubChangelogFunctions = {
+  getDependencyReleaseLine: async (
+    changesets,
+    dependenciesUpdated,
+    options,
+  ) => {
+    if (!options.repo) {
+      throw new Error(
+        'Please provide a repo to this changelog generator like this:\n"changelog": ["./changelog.js", { "repo": "org/repo" }]',
+      );
+    }
+    if (dependenciesUpdated.length === 0) return '';
+
+    const changesetLink = `- Updated dependencies [${(
+      await Promise.all(
+        changesets.map(async (cs) => {
+          if (cs.commit) {
+            let { links } = await getInfo({
+              repo: options.repo,
+              commit: cs.commit,
+            });
+            return links.commit;
+          }
+        }),
+      )
+    )
+      .filter((_) => _)
+      .join(', ')}]:`;
+
+    const updatedDependenciesList = dependenciesUpdated.map(
+      (dependency) => `  - ${dependency.name}@${dependency.newVersion}`,
+    );
+
+    return [changesetLink, ...updatedDependenciesList].join('\n');
+  },
+  getReleaseLine: async (changeset, _type, options) => {
+    if (!options || !options.repo) {
+      throw new Error(
+        'Please provide a repo to this changelog generator like this:\n"changelog": ["./changelog.js", { "repo": "org/repo" }]',
+      );
+    }
+
+    /** @type number | undefined */
+    let prFromSummary;
+    /** @type string | undefined */
+    let commitFromSummary;
+
+    const replacedChangelog = changeset.summary
+      .replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
+        let num = Number(pr);
+        if (!isNaN(num)) prFromSummary = num;
+        return '';
+      })
+      .replace(/^\s*commit:\s*([^\s]+)/im, (_, commit) => {
+        commitFromSummary = commit;
+        return '';
+      })
+      .replace(/^\s*(?:author|user):\s*@?([^\s]+)/gim, (_, user) => {
+        usersFromSummary.push(user);
+        return '';
+      })
+      .trim();
+
+    const [firstLine, ...futureLines] = replacedChangelog
+      .split('\n')
+      .map((l) => l.trimRight());
+
+    const links = await (async () => {
+      if (prFromSummary !== undefined) {
+        let { links } = await getInfoFromPullRequest({
+          repo: options.repo,
+          pull: prFromSummary,
+        });
+        if (commitFromSummary) {
+          links = {
+            ...links,
+            commit: `[\`${commitFromSummary}\`](https://github.com/${options.repo}/commit/${commitFromSummary})`,
+          };
+        }
+        return links;
+      }
+      const commitToFetchFrom = commitFromSummary || changeset.commit;
+      if (commitToFetchFrom) {
+        let { links } = await getInfo({
+          repo: options.repo,
+          commit: commitToFetchFrom,
+        });
+        return links;
+      }
+      return {
+        commit: null,
+        pull: null,
+        user: null,
+      };
+    })();
+
+    const suffix = links.pull ?? links.commit;
+
+    return [
+      `\n- ${firstLine}${suffix ? ` (${suffix})` : ''}`,
+      ...futureLines.map((l) => `  ${l}`),
+    ].join('\n');
+  },
+};
+
+if (process.env.GITHUB_TOKEN) {
+  module.exports = gitHubChangelogFunctions;
+} else {
+  console.warn(
+    `Defaulting to Git-based versioning.
+Enable GitHub-based versioning by setting the GITHUB_TOKEN environment variable.
+This requires a GitHub personal access token with the \`public_repo\` scope: https://github.com/settings/tokens/new`,
+  );
+
+  module.exports = defaultChangelogFunctions;
+}

package/.changeset/config.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@1.6.1/schema.json",
+  "changelog": ["./changelog.js", { "repo": "seek-oss/eslint-config-seek" }],
+  "commit": false,
+  "linked": [],
+  "access": "public",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

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: {
@@ -97,15 +103,11 @@ const baseConfig = {
   },
   settings: {
     react: {
-      version: '>16',
+      version: 'detect',
     },
   },
-  plugins: ['react', 'react-hooks', 'css-modules'],
-  extends: [
-    'plugin:css-modules/recommended',
-    'plugin:react/recommended',
-    'prettier',
-  ],
+  plugins: ['react', 'react-hooks'],
+  extends: ['plugin:react/recommended', 'prettier'],
   rules: {
     ...baseRules,
     ...reactRules,
@@ -122,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,
@@ -141,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,
@@ -159,7 +160,6 @@ const baseConfig = {
         es6: true,
       },
       extends: [
-        'plugin:flowtype/recommended',
         'plugin:import/errors',
         'plugin:import/warnings',
         'plugin:import/typescript',
@@ -171,7 +171,6 @@ const baseConfig = {
           },
         },
       },
-      plugins: ['flowtype'],
       rules: {
         'no-use-before-define': [ERROR, { functions: false }],
         'no-unused-expressions': ERROR,

package/.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - beta
+      - master
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    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
+        with:
+          node-version: 16.x
+
+      - name: Install dependencies
+        run: yarn --immutable
+
+      - name: Release
+        uses: changesets/action@v1
+        with:
+          publish: yarn release
+          version: yarn changeset-version
+        env:
+          GITHUB_TOKEN: ${{ secrets.SEEK_OSS_CI_GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.SEEK_OSS_CI_NPM_TOKEN }}

package/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+
+on:
+  - pull_request
+  - push
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@main
+
+      - name: Set up Node.js 16.x
+        uses: actions/setup-node@main
+        with:
+          node-version: 16.x
+
+      - name: Install dependencies
+        run: yarn --immutable
+
+      - name: Test
+        run: yarn test

package/CHANGELOG.md

@@ -0,0 +1,53 @@
+# eslint-config-seek
+
+## 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
+
+- Remove support for Flow ([#64](https://github.com/seek-oss/eslint-config-seek/pull/64))
+
+  SEEK has aligned on [TypeScript](https://www.typescriptlang.org/) for static type checking. [Flow](https://flow.org/) support was similarly removed in [sku 11](https://github.com/seek-oss/sku/releases/tag/v11.0.0).
+
+  Affected projects should migrate to TypeScript.
+
+- Remove support for CSS Modules ([#64](https://github.com/seek-oss/eslint-config-seek/pull/64))
+
+  [eslint-plugin-css-modules](https://github.com/atfzl/eslint-plugin-css-modules) is unmaintained, and SEEK has since moved on to [vanilla-extract](https://vanilla-extract.style/).
+
+  Affected projects should migrate to vanilla-extract.
+
+### Patch Changes
+
+- Detect the react version ([#68](https://github.com/seek-oss/eslint-config-seek/pull/68))

package/README.md

@@ -1,4 +1,5 @@
-[![Test & Release](https://github.com/seek-oss/eslint-config-seek/actions/workflows/test-and-release.yml/badge.svg)](https://github.com/seek-oss/eslint-config-seek/actions/workflows/test-and-release.yml)
+[![Test](https://github.com/seek-oss/eslint-config-seek/actions/workflows/test.yml/badge.svg)](https://github.com/seek-oss/eslint-config-seek/actions/workflows/test.yml)
+[![Release](https://github.com/seek-oss/eslint-config-seek/actions/workflows/release.yml/badge.svg)](https://github.com/seek-oss/eslint-config-seek/actions/workflows/release.yml)
 
 # eslint-config-seek
 

package/package.json

@@ -1,63 +1,47 @@
 {
   "name": "eslint-config-seek",
-  "version": "7.0.9",
+  "version": "9.0.0",
   "description": "ESLint configuration used by SEEK",
   "main": ".eslintrc.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/seek-oss/eslint-config-seek.git"
   },
-  "author": "Seek",
+  "author": "SEEK",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/seek-oss/eslint-config-seek/issues"
   },
   "scripts": {
+    "release": "changeset publish",
     "test": "eslint .",
-    "commit": "git-cz",
-    "release": "semantic-release"
-  },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint --edit --extends seek"
-    }
+    "changeset-version": "changeset version && prettier --write ."
   },
   "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-css-modules": "^2.11.0",
-    "eslint-plugin-cypress": "^2.11.1",
-    "eslint-plugin-flowtype": "^5.1.3",
-    "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": "^26.1.2",
+    "eslint-plugin-react": "^7.29.4",
+    "eslint-plugin-react-hooks": "^4.3.0",
     "find-root": "^1.1.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^8.2.0",
-    "commitizen": "^4.0.3",
-    "commitlint-config-seek": "^1.0.0",
-    "cz-conventional-changelog": "^3.0.2",
-    "eslint": "^7.14.0",
-    "husky": "^3.1.0",
-    "semantic-release": "^15.13.31",
+    "@changesets/cli": "2.17.0",
+    "@changesets/get-github-info": "0.5.0",
+    "eslint": "8.11.0",
+    "prettier": "2.4.1",
     "typescript": "^4.1.2"
   },
-  "release": {
-    "success": false
-  },
   "peerDependencies": {
     "eslint": ">=6",
     "typescript": ">=3.3"
-  },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
   }
 }

package/.github/workflows/test-and-release.yml

@@ -1,34 +0,0 @@
-name: Test & Release
-
-on:
-  - pull_request
-  - push
-
-jobs:
-  test-and-release:
-    name: Test & Release
-    runs-on: ubuntu-latest
-    env:
-      CI: true
-    steps:
-      - name: Check out repo
-        uses: actions/checkout@main
-        with:
-          lfs: true
-
-      - name: Set up Node.js 14.x
-        uses: actions/setup-node@main
-        with:
-          node-version: 14.x
-
-      - name: Install dependencies
-        run: yarn --immutable
-
-      - name: Test
-        run: yarn test
-
-      - name: Release
-        run: yarn release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.SEEK_OSS_CI_NPM_TOKEN }}