Upgrade to ESLint v8 (#814)

Co-authored-by: Remus Mate <rmate@seek.com.au>
seek-oss · May 25, 2023 · 0521cbf · 0521cbf
1 parent f7c4211
commit 0521cbf
Show file tree

Hide file tree

Showing 5 changed files with 240 additions and 274 deletions.
diff --git a/.changeset/fifty-laws-hammer.md b/.changeset/fifty-laws-hammer.md
@@ -0,0 +1,5 @@
+---
+'sku': minor
+---
+
+Upgrade ESLint to v8
diff --git a/package.json b/package.json
@@ -48,8 +48,8 @@
     "@types/jest": "^29.0.0",
     "debug": "^4.3.1",
     "dedent": "^0.7.0",
-    "eslint": "^7.18.0",
-    "eslint-config-seek": "^11.0.0",
+    "eslint": "^8.41.0",
+    "eslint-config-seek": "^11.1.2",
     "eslint-plugin-jsdoc": "^44.2.4",
     "gh-pages": "^3.1.0",
     "husky": "^8.0.3",

diff --git a/packages/sku/lib/runESLint.js b/packages/sku/lib/runESLint.js
@@ -1,5 +1,5 @@
 const { yellow, cyan, gray } = require('chalk');
-const EslintCLI = require('eslint').CLIEngine;
+const { ESLint } = require('eslint');
 const eslintConfig = require('../config/eslint/eslintConfig');
 const {
   js: jsExtensions,
@@ -11,56 +11,53 @@ const extensions = [...tsExtensions, ...jsExtensions].map((ext) => `.${ext}`);
 /**
  * @param {{ fix?: boolean, paths?: string[] }}
  */
-const runESLint = ({ fix = false, paths }) =>
-  new Promise((resolve, reject) => {
-    console.log(cyan(`${fix ? 'Fixing' : 'Checking'} code with ESLint`));
+const runESLint = async ({ fix = false, paths }) => {
+  console.log(cyan(`${fix ? 'Fixing' : 'Checking'} code with ESLint`));
 
-    const cli = new EslintCLI({
-      baseConfig: eslintConfig,
-      extensions,
-      useEslintrc: false,
-      fix,
-    });
-    const checkAll = typeof paths === 'undefined';
-    /* Whitelist the file extensions that our ESLint setup currently supports */
-    const filteredFilePaths = checkAll
-      ? ['.']
-      : paths.filter((filePath) =>
-          [...extensions, '.json'].some((ext) => filePath.endsWith(ext)),
-        );
-
-    if (filteredFilePaths.length === 0) {
-      console.log(gray(`No JS files to lint`));
-    } else {
-      console.log(gray(`Paths: ${filteredFilePaths.join(' ')}`));
-      try {
-        const report = cli.executeOnFiles(filteredFilePaths);
+  const eslint = new ESLint({
+    baseConfig: eslintConfig,
+    extensions,
+    useEslintrc: false,
+    fix,
+  });
+  const checkAll = typeof paths === 'undefined';
+  /* Whitelist the file extensions that our ESLint setup currently supports */
+  const filteredFilePaths = checkAll
+    ? ['.']
+    : paths.filter((filePath) =>
+        [...extensions, '.json'].some((ext) => filePath.endsWith(ext)),
+      );
 
-        if (fix) {
-          EslintCLI.outputFixes(report);
-        } else {
-          const { errorCount, warningCount, results } = report;
+  if (filteredFilePaths.length === 0) {
+    console.log(gray(`No JS files to lint`));
+  } else {
+    console.log(gray(`Paths: ${filteredFilePaths.join(' ')}`));
+    try {
+      const report = await eslint.lintFiles(filteredFilePaths);
 
-          if (errorCount || warningCount) {
-            const formatter = cli.getFormatter();
-            console.log(formatter(results));
-          }
+      if (fix) {
+        ESLint.outputFixes(report);
+      } else {
+        const { errorCount, warningCount, results } = report;
 
-          if (errorCount > 0) {
-            reject();
-          }
+        if (errorCount || warningCount) {
+          const formatter = await eslint.loadFormatter();
+          console.log(formatter(results));
         }
-      } catch (e) {
-        if (e && e.message && e.message.includes('No files matching')) {
-          console.warn(yellow(`Warning: ${e.message}`));
-        } else {
-          reject(e);
+
+        if (errorCount > 0) {
+          return Promise.reject();
         }
       }
+    } catch (e) {
+      if (e && e.message && e.message.includes('No files matching')) {
+        console.warn(yellow(`Warning: ${e.message}`));
+      } else {
+        return Promise.reject();
+      }
     }
-
-    resolve();
-  });
+  }
+};
 
 module.exports = {
   check: (paths) => runESLint({ paths }),

diff --git a/packages/sku/package.json b/packages/sku/package.json
@@ -82,8 +82,8 @@
     "esbuild": "^0.17.0",
     "esbuild-register": "^3.3.3",
     "escape-string-regexp": "^4.0.0",
-    "eslint": "^7.18.0",
-    "eslint-config-seek": "^11.1.0",
+    "eslint": "^8.41.0",
+    "eslint-config-seek": "^11.1.2",
     "exception-formatter": "^2.1.2",
     "express": "^4.16.3",
     "fast-glob": "^3.2.5",