Update eslint to make use of the new concurrent option

Author: leeyi45

devserver/package.json

@@ -30,7 +30,7 @@
     "@types/react": "^18.3.1",
     "@types/react-dom": "^18.3.1",
     "@vitest/browser": "^3.2.3",
-    "eslint": "^9.31.0",
+    "eslint": "^9.35.0",
     "playwright": "^1.54.1",
     "sass": "^1.85.0",
     "typescript": "^5.8.2",

docs/package.json

@@ -21,7 +21,6 @@
     "vitepress-sidebar": "^1.31.1"
   },
   "devDependencies": {
-    "@sourceacademy/markdown-plugin-directory-tree": "workspace:^",
-    "eslint": "^9.31.0"
+    "@sourceacademy/markdown-plugin-directory-tree": "workspace:^"
   }
 }

lib/buildtools/package.json

@@ -26,7 +26,7 @@
     "chalk": "^5.0.1",
     "commander": "^13.0.0",
     "esbuild": "^0.25.8",
-    "eslint": "^9.31.0",
+    "eslint": "^9.35.0",
     "http-server": "^14.1.1",
     "jsdom": "^26.1.0",
     "lodash": "^4.17.21",

lib/buildtools/src/commands/__tests__/lint.test.ts

@@ -1,7 +1,8 @@
+import { Command } from '@commander-js/extra-typings';
 import * as manifest from '@sourceacademy/modules-repotools/manifest';
 import { ESLint } from 'eslint';
 import { beforeEach, describe, expect, test, vi } from 'vitest';
-import { getLintCommand } from '../prebuild.js';
+import { concurrencyOption, getLintCommand } from '../prebuild.js';
 import { getCommandRunner } from './testingUtils.js';
 
 const lintFilesMock = vi.hoisted(() => vi.fn());
@@ -154,3 +155,34 @@ describe('Test Lint command directory resolution', () => {
     expect(lintFilesMock).not.toHaveBeenCalled();
   });
 });
+
+describe('Test concurrency option', () => {
+  const runOption = (...args: string[]) => new Promise<ESLint.Options['concurrency']>((resolve, reject) => {
+    new Command()
+      .addOption(concurrencyOption)
+      .exitOverride(reject)
+      .configureOutput({
+        writeErr: () => {}
+      })
+      .action(({ concurrency }) => resolve(concurrency))
+      .parse(args, { from: 'user' });
+  });
+
+  test('number for option uses that number', () => {
+    return expect(runOption('--concurrency', '3')).resolves.toEqual(3);
+  });
+
+  test('off returns \'off\'', () => {
+    return expect(runOption('--concurrency', 'off')).resolves.toEqual('off');
+  });
+
+  test('auto returns \'auto\'', () => {
+    return expect(runOption('--concurrency', 'auto')).resolves.toEqual('auto');
+  });
+
+  test('unknown option throws error', () => {
+    return expect(runOption('--concurrency', 'unknown'))
+      .rejects
+      .toThrowError('Expected auto, off or a number, got unknown');
+  });
+});

lib/buildtools/src/commands/__tests__/testing.test.ts

@@ -140,6 +140,7 @@ describe('Test silent option', () => {
       const command = new Command()
         .exitOverride()
         .addOption(silentOption)
+        .configureOutput({ writeErr: () => {} })
         .action(option => {
           resolve(option.silent);
         });

lib/buildtools/src/commands/prebuild.ts

@@ -1,14 +1,34 @@
 import pathlib from 'path';
-import { Command } from '@commander-js/extra-typings';
+import { Command, InvalidArgumentError, Option } from '@commander-js/extra-typings';
 import { outDir } from '@sourceacademy/modules-repotools/getGitRoot';
 import { resolveEitherBundleOrTab } from '@sourceacademy/modules-repotools/manifest';
 import { divideAndRound } from '@sourceacademy/modules-repotools/utils';
 import chalk from 'chalk';
+import type { ESLint } from 'eslint';
 import { runPrebuild } from '../prebuild/index.js';
 import { formatLintResult, lintGlobal, runEslint } from '../prebuild/lint.js';
 import { formatTscResult, runTsc } from '../prebuild/tsc.js';
 import { logCommandErrorAndExit } from './commandUtils.js';
 
+export const concurrencyOption = new Option('--concurrency <value>')
+  .argParser((value): Exclude<ESLint.Options['concurrency'], undefined> => {
+    switch (value) {
+      case 'auto':
+      case 'off':
+        return value;
+      default: {
+        const count = parseInt(value);
+
+        if (Number.isNaN(count)) {
+          throw new InvalidArgumentError(`Expected auto, off or a number, got ${value}`);
+        }
+
+        return count;
+      }
+    }
+  })
+  .default('auto');
+
 /*
  * The lint command is provided as part of buildtools so that each bundle and tab doesn't
  * have to install its own copy of ESLint
@@ -20,7 +40,8 @@ export const getLintCommand = () => new Command('lint')
   .option('--fix', 'Output linting fixes', false)
   .option('--stats', 'Output linting stats', false)
   .option('--ci', process.env.CI)
-  .action(async (directory, { fix, ci, stats }) => {
+  .addOption(concurrencyOption)
+  .action(async (directory, { ci, ...opts }) => {
     const fullyResolved = pathlib.resolve(directory);
     const resolveResult = await resolveEitherBundleOrTab(fullyResolved);
 
@@ -32,7 +53,7 @@ export const getLintCommand = () => new Command('lint')
       logCommandErrorAndExit(resolveResult);
     }
 
-    const result = await runEslint(resolveResult.asset, fix, stats);
+    const result = await runEslint(resolveResult.asset, opts);
     console.log(formatLintResult(result));
 
     switch (result.severity) {
@@ -50,10 +71,16 @@ export const getLintGlobalCommand = () => new Command('lintglobal')
   .option('--fix', 'Output linting fixes', false)
   .option('--stats', 'Output linting stats', false)
   .option('--ci', process.env.CI)
-  .action(async ({ fix, stats, ci }) => {
-    console.log(chalk.cyanBright('Beginning lint global'));
-    const result = await lintGlobal(fix, stats);
+  .addOption(concurrencyOption)
+  .action(async ({ ci, ...opts }) => {
     const prefix = chalk.blueBright('[lintglobal]');
+
+    console.log(`${prefix} ${chalk.cyanBright('Beginning linting with the following options:')}`);
+    Object.entries(opts).forEach(([key, value], i) => {
+      console.log(`  ${i+1}. ${chalk.greenBright(key)}: ${chalk.cyanBright(value)}`);
+    });
+
+    const result = await lintGlobal(opts);
     const logs = [
       `${prefix} Took ${divideAndRound(result.filesElapsed, 1000)}s to find files`,
       `${prefix} Took ${divideAndRound(result.lintElapsed, 1000)}s to lint files`,
@@ -65,7 +92,7 @@ export const getLintGlobalCommand = () => new Command('lintglobal')
 
     console.log(logs.join('\n'));
 
-    if (stats) {
+    if (opts.stats) {
       const statPath = pathlib.join(outDir, 'lintstats.csv');
       console.log(chalk.greenBright(`Stats written to ${statPath}`));
     }

lib/buildtools/src/prebuild/lint.ts

@@ -6,6 +6,12 @@ import { findSeverity, flatMapAsync, isNodeError } from '@sourceacademy/modules-
 import chalk from 'chalk';
 import { ESLint } from 'eslint';
 
+export interface LintOptions {
+  concurrency: Exclude<ESLint.Options['concurrency'], undefined>;
+  fix: boolean;
+  stats: boolean;
+}
+
 export interface LintResult {
   formatted: string;
   severity: Severity;
@@ -35,11 +41,12 @@ async function timePromise<T>(f: () => Promise<T>) {
 }
 
 // #region runEslint
-export async function runEslint(input: InputAsset, fix: boolean, stats: boolean): Promise<LintResult> {
+export async function runEslint(input: InputAsset, { fix, stats, concurrency }: LintOptions): Promise<LintResult> {
   const linter = new ESLint({
     fix,
     stats,
-    cwd: gitRoot
+    concurrency,
+    cwd: gitRoot,
   });
 
   try {
@@ -104,8 +111,8 @@ interface LintGlobalResults {
  * all together causes ESLint to run out of memory, we have this function that lints everything else
  * so that the bundles and tabs can be linted separately.
  */
-export async function lintGlobal(fix: boolean, stats: boolean): Promise<LintGlobalResults> {
-  const linter = new ESLint({ fix, stats, cwd: gitRoot });
+export async function lintGlobal(opts: LintOptions): Promise<LintGlobalResults> {
+  const linter = new ESLint({ cwd: gitRoot, ...opts });
 
   /**
    * Recursively determine what files to to lint. Just supplying folder paths
@@ -147,21 +154,21 @@ export async function lintGlobal(fix: boolean, stats: boolean): Promise<LintGlob
   const { result: lintResults, elapsed: lintElapsed } = await timePromise(() => flatMapAsync(toLint, each => linter.lintFiles(each)));
 
   let fixElapsed: number | undefined = undefined;
-  if (fix) {
+  if (opts.fix) {
     ;({ elapsed: fixElapsed } = await timePromise(() => ESLint.outputFixes(lintResults)));
   }
 
   const formatter = await linter.loadFormatter('stylish');
   const formatted = await formatter.format(lintResults);
 
-  if (stats) {
+  if (opts.stats) {
     const csvFormatter = await linter.loadFormatter(pathlib.join(import.meta.dirname, '../../lintplugin/dist/formatter.js'));
     const csvFormatted = await csvFormatter.format(lintResults);
     await fs.mkdir(outDir, { recursive: true });
     await fs.writeFile(pathlib.join(outDir, 'lintstats.csv'), csvFormatted);
   }
 
-  const severity = findSeverity(lintResults, each => severityFinder(each, fix));
+  const severity = findSeverity(lintResults, each => severityFinder(each, opts.fix));
 
   return {
     formatted,

lib/lintplugin/package.json

@@ -11,7 +11,7 @@
     "./formatter": "./dist/formatter.js"
   },
   "dependencies": {
-    "eslint": "^9.31.0"
+    "eslint": "^9.35.0"
   },
   "peerDependencies": {
     "@eslint/markdown": "^6.6.0",

lib/modules-lib/package.json

@@ -9,7 +9,7 @@
     "@types/react-dom": "^18.3.1",
     "@vitejs/plugin-react": "^4.7.0",
     "@vitest/browser": "^3.2.3",
-    "eslint": "^9.31.0",
+    "eslint": "^9.35.0",
     "playwright": "^1.54.1",
     "typedoc": "^0.28.9",
     "typedoc-plugin-frontmatter": "^1.3.0",

package.json

@@ -64,7 +64,7 @@
     "@vitest/eslint-plugin": "^1.3.4",
     "@yarnpkg/types": "^4.0.1",
     "esbuild": "^0.25.8",
-    "eslint": "^9.31.0",
+    "eslint": "^9.35.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsdoc": "^51.3.1",
     "eslint-plugin-mdx": "^3.6.2",