feat: add eslint-config option to run-single command

Implements the `--config` command for run-single.
This has been renamed from `config` to `eslint-config` to help better differentiate the differences
between the run --config command.

Author: christopher-buss

cli/index.ts

@@ -27,15 +27,15 @@ interface RunSingleCommandOptions {
    */
   report: ReporterFormat
 
+  /** Optional path to an ESLint configuration file to use for linting. */
+  eslintConfig?: string
+
   /** Maximum allowed duration in ms. */
   maxDuration: number
 
   /** The number of iterations to run the benchmark for the rule. */
   iterations: number
 
-  /** Optional path to an ESLint configuration file to use for linting. */
-  config?: string
-
   /** Optional path to a file where the benchmark report should be saved. */
   output?: string
 
@@ -150,7 +150,7 @@ export function run(): void {
     .command('run-single', 'Run benchmark on a single ESLint rule')
     .option('--rule <rule>', 'Path to the ESLint rule file')
     .option('--name <name>', 'Name of the rule to benchmark')
-    .option('--config <config>', 'Path to ESLint config file')
+    .option('--eslint-config <config>', 'Path to ESLint config file')
     .option('--source <source>', 'Path to directory or file with test cases')
     .option('--iterations <number>', 'Number of benchmark iterations', {
       default: DEFAULT_ITERATIONS,
@@ -227,6 +227,7 @@ export function run(): void {
         console.info(`Using source: ${options.source}`)
 
         await runBenchmarksFromConfig({
+          eslintConfigFile: options.eslintConfig,
           reporterOptions: reporterOptionsArray,
           userConfig: constructedUserConfig,
           configDirectory,

core/benchmark/run-benchmark.ts

@@ -21,6 +21,9 @@ export interface ProcessedBenchmarkTask {
 
 /** Parameters for running a benchmark. */
 interface RunBenchmarkParameters {
+  /** Optional path to custom ESLint config file. */
+  eslintConfigFile?: string
+
   /** Configuration for the benchmark. */
   config: BenchmarkConfig
 
@@ -69,7 +72,7 @@ type Language = (typeof LANGUAGES)[number]
 export async function runBenchmark(
   parameters: RunBenchmarkParameters,
 ): Promise<ProcessedBenchmarkTask[] | null> {
-  let { configDirectory, testCases, config } = parameters
+  let { eslintConfigFile, configDirectory, testCases, config } = parameters
 
   if (testCases.length === 0) {
     return null
@@ -103,6 +106,7 @@ export async function runBenchmark(
       eslint = await createESLintInstance({
         languages: currentTestCaseLanguages,
         rule: testCase.rule,
+        eslintConfigFile,
         configDirectory,
       })
       await eslint.lintText('/* eslint-disable */')

core/eslint/create-eslint-instance.ts

@@ -12,6 +12,9 @@ import { toSeverity } from './to-severity'
 
 /** Options for creating an ESLint instance. */
 interface CreateESLintInstanceOptions {
+  /** Optional path to custom ESLint config file. */
+  eslintConfigFile?: string
+
   /** The path to the user configuration directory. */
   configDirectory: string
 
@@ -45,7 +48,7 @@ let jiti = createJiti(import.meta.url, {
 export async function createESLintInstance(
   instanceOptions: CreateESLintInstanceOptions,
 ): Promise<ESLint> {
-  let { configDirectory, languages, rule } = instanceOptions
+  let { eslintConfigFile, configDirectory, languages, rule } = instanceOptions
 
   let { path: rulePath, severity, options, ruleId } = rule
 
@@ -140,8 +143,8 @@ export async function createESLintInstance(
 
   return new FlatESLint({
     ruleFilter: ({ ruleId: currentRuleId }) => currentRuleId === uniqueRuleId,
+    overrideConfigFile: eslintConfigFile ?? null,
     overrideConfig: [flatConfig],
-    overrideConfigFile: null,
     allowInlineConfig: false,
     fix: true,
   })

runners/run-benchmarks-from-config.ts

@@ -33,6 +33,9 @@ interface RunBenchmarksFromConfigParameters {
   /** The user-defined benchmark configuration. */
   userConfig: UserBenchmarkConfig
 
+  /** Optional path to custom ESLint config file. */
+  eslintConfigFile?: string
+
   /** User configuration directory path */
   configDirectory: string
 }
@@ -89,7 +92,8 @@ interface RunBenchmarksFromConfigParameters {
 export async function runBenchmarksFromConfig(
   parameters: RunBenchmarksFromConfigParameters,
 ): Promise<void> {
-  let { reporterOptions, configDirectory, userConfig } = parameters
+  let { eslintConfigFile, reporterOptions, configDirectory, userConfig } =
+    parameters
 
   if (userConfig.tests.length === 0) {
     console.warn('User configuration contains no tests. Exiting.')
@@ -173,6 +177,7 @@ export async function runBenchmarksFromConfig(
         // eslint-disable-next-line no-await-in-loop
         await runBenchmark({
           config: specBenchmarkConfig,
+          eslintConfigFile,
           configDirectory,
           testCases,
         })

test/core/eslint/create-eslint-instance.test.ts

@@ -483,4 +483,19 @@ describe('createESLintInstance', () => {
 
     expect(config.rules).toBeDefined()
   })
+
+  it('sets custom config file when provided', async () => {
+    constructorOptions = {}
+
+    await createESLintInstance({
+      eslintConfigFile: '/path/to/custom/eslint.config.js',
+      rule: { ruleId: 'test-rule', severity: 2 },
+      configDirectory: temporaryDirectory,
+      languages: ['javascript'],
+    })
+
+    expect(constructorOptions['overrideConfigFile']).toBe(
+      '/path/to/custom/eslint.config.js',
+    )
+  })
 })