chore: refactor

eslint · Aug 19, 2024 · 23e67f1 · 23e67f1
1 parent 59672f5
commit 23e67f1
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 69 deletions.
diff --git a/src/cli.ts b/src/cli.ts
@@ -2,7 +2,6 @@ import process from 'node:process'
 import fs from 'node:fs/promises'
 import { existsSync } from 'node:fs'
 import { relative, resolve } from 'node:path'
-import { types } from 'node:util'
 
 import open from 'open'
 import { getPort } from 'get-port-please'
@@ -13,6 +12,7 @@ import { createHostServer } from './server'
 import { distDir } from './dirs'
 import { readConfig } from './configs'
 import { MARK_CHECK, MARK_INFO } from './constants'
+import { ConfigInspectorError } from './errors'
 
 const cli = cac(
   'eslint-config-inspector',
@@ -35,16 +35,22 @@ cli
 
     const cwd = process.cwd()
     const outDir = resolve(cwd, options.outDir)
-    const configs = await readConfig({
-      cwd,
-      userConfigPath: options.config,
-      userBasePath: options.basePath,
-      globMatchedFiles: options.files,
-    })
 
-    if (types.isNativeError(configs)) {
-      configs.prettyPrint()
-      process.exit(1)
+    let configs
+    try {
+      configs = await readConfig({
+        cwd,
+        userConfigPath: options.config,
+        userBasePath: options.basePath,
+        globMatchedFiles: options.files,
+      })
+    }
+    catch (error) {
+      if (error instanceof ConfigInspectorError) {
+        error.prettyPrint()
+        process.exit(1)
+      }
+      throw error
     }
 
     let baseURL = options.base

diff --git a/src/configs.ts b/src/configs.ts
@@ -1,6 +1,5 @@
 import { basename, dirname, relative, resolve } from 'node:path'
 import process from 'node:process'
-import { types } from 'node:util'
 import { ConfigArray } from '@eslint/config-array'
 import { configArrayFindFiles } from '@voxpelli/config-array-find-files'
 import { bundleRequire } from 'bundle-require'
@@ -9,7 +8,8 @@ import c from 'picocolors'
 import { resolve as resolveModule } from 'mlly'
 import type { FlatConfigItem, MatchedFile, Payload, RuleInfo } from '../shared/types'
 import { isIgnoreOnlyConfig, matchFile } from '../shared/configs'
-import { MARK_CHECK, MARK_ERROR, MARK_INFO, configFilenames, legacyConfigFilenames } from './constants'
+import { MARK_CHECK, MARK_INFO, configFilenames, legacyConfigFilenames } from './constants'
+import { ConfigPathError, ConfigPathLegacyError } from './errors'
 
 export interface ReadConfigOptions extends ResolveConfigPathOptions {
   /**
@@ -41,47 +41,6 @@ export interface ResolveConfigPathOptions {
   userBasePath?: string
 }
 
-export class ConfigPathError extends Error {
-  override name = 'ConfigPathError' as const
-
-  constructor(
-    public basePath: string,
-    public configFilenames: string[],
-  ) {
-    super('Cannot find ESLint config file')
-  }
-
-  prettyPrint() {
-    console.error(MARK_ERROR, this.message, c.dim(`
-
-Looked in ${c.underline(this.basePath)} and parent folders for:
-
- * ${this.configFilenames.join('\n * ')}`,
-    ))
-  }
-}
-
-export class ConfigPathLegacyError extends Error {
-  override name = 'ConfigPathLegacyError' as const
-
-  constructor(
-    public basePath: string,
-    public configFilename: string,
-  ) {
-    super('Found ESLint legacy config file')
-  }
-
-  prettyPrint() {
-    console.error(MARK_ERROR, this.message, c.dim(`
-
-Encountered unsupported legacy config ${c.underline(this.configFilename)} in ${c.underline(this.basePath)}
-
-\`@eslint/config-inspector\` only works with the new flat config format:
-https://eslint.org/docs/latest/use/configure/configuration-files-new`,
-    ))
-  }
-}
-
 /**
  * Search and read the ESLint config file.
  *
@@ -108,7 +67,7 @@ export async function resolveConfigPath(options: ResolveConfigPathOptions) {
   if (!configPath) {
     const legacyConfigPath = await findUp(legacyConfigFilenames, { cwd: lookupBasePath })
 
-    return legacyConfigPath
+    throw legacyConfigPath
       ? new ConfigPathLegacyError(
         `${relative(cwd, dirname(legacyConfigPath))}/`,
         basename(legacyConfigPath),
@@ -124,12 +83,19 @@ export async function resolveConfigPath(options: ResolveConfigPathOptions) {
       ? cwd // When user explicit provide config path, use current working directory as root
       : dirname(configPath) // Otherwise, use config file's directory as root
   )
+
   return {
     basePath,
     configPath,
   }
 }
 
+export interface ESLintConfig {
+  configs: FlatConfigItem[]
+  payload: Payload
+  dependencies: string[]
+}
+
 /**
  * Search and read the ESLint config file, processed into inspector payload with module dependencies
  *
@@ -140,18 +106,14 @@ export async function resolveConfigPath(options: ResolveConfigPathOptions) {
  */
 export async function readConfig(
   options: ReadConfigOptions,
-): Promise<ConfigPathLegacyError | ConfigPathError | { configs: FlatConfigItem[], payload: Payload, dependencies: string[] }> {
+): Promise<ESLintConfig> {
   const {
     chdir = true,
     globMatchedFiles: globFiles = true,
   } = options
 
   const resolvedConfigPath = await resolveConfigPath(options)
 
-  if (types.isNativeError(resolvedConfigPath)) {
-    return resolvedConfigPath
-  }
-
   const { basePath, configPath } = resolvedConfigPath
   if (chdir && basePath !== process.cwd())
     process.chdir(basePath)

diff --git a/src/errors.ts b/src/errors.ts
@@ -0,0 +1,49 @@
+import c from 'picocolors'
+import { MARK_ERROR } from './constants'
+
+export class ConfigInspectorError extends Error {
+  prettyPrint() {
+    console.error(MARK_ERROR, this.message)
+  }
+}
+
+export class ConfigPathError extends ConfigInspectorError {
+  override name = 'ConfigPathError' as const
+
+  constructor(
+    public basePath: string,
+    public configFilenames: string[],
+  ) {
+    super('Cannot find ESLint config file')
+  }
+
+  override prettyPrint() {
+    console.error(MARK_ERROR, this.message, c.dim(`
+
+Looked in ${c.underline(this.basePath)} and parent folders for:
+
+ * ${this.configFilenames.join('\n * ')}`,
+    ))
+  }
+}
+
+export class ConfigPathLegacyError extends ConfigInspectorError {
+  override name = 'ConfigPathLegacyError' as const
+
+  constructor(
+    public basePath: string,
+    public configFilename: string,
+  ) {
+    super('Found ESLint legacy config file')
+  }
+
+  override prettyPrint() {
+    console.error(MARK_ERROR, this.message, c.dim(`
+
+Encountered unsupported legacy config ${c.underline(this.configFilename)} in ${c.underline(this.basePath)}
+
+\`@eslint/config-inspector\` only works with the new flat config format:
+https://eslint.org/docs/latest/use/configure/configuration-files-new`,
+    ))
+  }
+}
diff --git a/src/ws.ts b/src/ws.ts
@@ -1,5 +1,4 @@
 import process from 'node:process'
-import { types } from 'node:util'
 
 import chokidar from 'chokidar'
 import type { WebSocket } from 'ws'
@@ -8,6 +7,7 @@ import { getPort } from 'get-port-please'
 import type { ReadConfigOptions } from './configs'
 import { readConfig, resolveConfigPath } from './configs'
 import { MARK_CHECK } from './constants'
+import { ConfigInspectorError } from './errors'
 import type { Payload } from '~~/shared/types'
 
 const readErrorWarning = `Failed to load \`eslint.config.js\`.
@@ -30,11 +30,18 @@ export async function createWsServer(options: CreateWsServerOptions) {
     ws.on('close', () => wsClients.delete(ws))
   })
 
-  const resolvedConfigPath = await resolveConfigPath(options)
-
-  if (types.isNativeError(resolvedConfigPath)) {
-    resolvedConfigPath.prettyPrint()
-    process.exit(1)
+  let resolvedConfigPath: Awaited<ReturnType<typeof resolveConfigPath>>
+  try {
+    resolvedConfigPath = await resolveConfigPath(options)
+  }
+  catch (e) {
+    if (e instanceof ConfigInspectorError) {
+      e.prettyPrint()
+      process.exit(1)
+    }
+    else {
+      throw e
+    }
   }
 
   const { basePath } = resolvedConfigPath
@@ -62,9 +69,6 @@ export async function createWsServer(options: CreateWsServerOptions) {
       if (!payload) {
         return await readConfig(options)
           .then((res) => {
-            if (types.isNativeError(res)) {
-              throw res
-            }
             const _payload = payload = res.payload
             _payload.meta.wsPort = port
             watcher.add(res.dependencies)
@@ -75,7 +79,12 @@ export async function createWsServer(options: CreateWsServerOptions) {
     }
     catch (e) {
       console.error(readErrorWarning)
-      console.error(e)
+      if (e instanceof ConfigInspectorError) {
+        e.prettyPrint()
+      }
+      else {
+        console.error(e)
+      }
       return {
         message: readErrorWarning,
         error: String(e),