refactor: follow oclif conventions around error handling

Author: kbrabrand

src/actions/streamProcessor.ts

@@ -1,20 +1,18 @@
 import {writeFile} from 'node:fs/promises'
 
-import {subdebug} from '@sanity/cli-core'
 import {spinner} from '@sanity/cli-core/ux'
 import {WorkerChannelReceiver} from '@sanity/worker-channels'
 import {format, resolveConfig as resolvePrettierConfig} from 'prettier'
 
 import {TypeGenConfig} from '../readConfig.js'
 import {count} from '../utils/count.js'
+import {debug} from '../utils/debug.js'
 import {formatPath} from '../utils/formatPath.js'
 import {getMessage} from '../utils/getMessage.js'
 import {percent} from '../utils/percent.js'
 import {generatedFileWarning} from './generatedFileWarning.js'
 import {TypegenWorkerChannel} from './types.js'
 
-const debug = subdebug('typegen:generate')
-
 /**
  * Processes the event stream from a typegen worker thread.
  *

src/actions/typegenGenerate.ts

@@ -3,10 +3,10 @@ import {dirname, isAbsolute, join} from 'node:path'
 import {env} from 'node:process'
 import {Worker} from 'node:worker_threads'
 
-import {subdebug} from '@sanity/cli-core'
 import {WorkerChannelReceiver} from '@sanity/worker-channels'
 
 import {prepareConfig} from '../utils/config.js'
+import {debug} from '../utils/debug.js'
 import {processTypegenWorkerStream} from './streamProcessor.js'
 import {
   type GenerationResult,
@@ -15,8 +15,6 @@ import {
   TypegenWorkerChannel,
 } from './types.js'
 
-const debug = subdebug('typegen:generate')
-
 /**
  * Runs a single typegen generation.
  *

src/actions/typegenWatch.ts

@@ -93,7 +93,7 @@ export function runTypegenWatcher(options: RunTypegenOptions): {
       stats.successfulDurations.push(duration)
     } catch (err) {
       const errorMessage = err instanceof Error ? err.message : err
-      console.error(` ${chalk.red('›')}   ${errorMessage}`)
+      error(` ${chalk.red('›')}   ${errorMessage}`)
       stats.failedCount++
     }
   })

src/commands/typegen/generate.ts

@@ -1,19 +1,18 @@
 import {stat} from 'node:fs/promises'
 
 import {Flags} from '@oclif/core'
-import {SanityCommand, subdebug} from '@sanity/cli-core'
+import {SanityCommand} from '@sanity/cli-core'
 import {chalk, spinner} from '@sanity/cli-core/ux'
 import {omit, once} from 'lodash-es'
 
 import {runTypegenGenerate} from '../../actions/typegenGenerate.js'
 import {runTypegenWatcher} from '../../actions/typegenWatch.js'
 import {configDefinition, readConfig, type TypeGenConfig} from '../../readConfig.js'
 import {TypegenWatchModeTrace, TypesGeneratedTrace} from '../../typegen.telemetry.js'
+import {debug} from '../../utils/debug.js'
 import {promiseWithResolvers} from '../../utils/promiseWithResolvers.js'
 import {telemetry} from '../../utils/telemetryLogger.js'
 
-const debug = subdebug('typegen:generate')
-
 const description = `Sanity TypeGen (Beta)
 This command is currently in beta and may undergo significant changes. Feedback is welcome!
 
@@ -89,21 +88,21 @@ export class TypegenGenerateCommand extends SanityCommand<typeof TypegenGenerate
       // check if the legacy config exist
       const legacyConfigPath = configPath || 'sanity-typegen.json'
       let hasLegacyConfig = false
+
       try {
         const file = await stat(legacyConfigPath)
         hasLegacyConfig = file.isFile()
       } catch (err) {
         if (err instanceof Error && 'code' in err && err.code === 'ENOENT' && configPath) {
-          throw new Error(`Typegen config file not found: ${configPath}`, {cause: err})
+          spin.fail()
+          this.error(`Typegen config file not found: ${configPath}`, {exit: 1})
         }
 
         if (err instanceof Error && 'code' in err && err.code !== 'ENOENT') {
-          throw new Error(
-            `Error when checking if typegen config file exists: ${legacyConfigPath}`,
-            {
-              cause: err,
-            },
-          )
+          spin.fail()
+          this.error(`Error when checking if typegen config file exists: ${legacyConfigPath}`, {
+            exit: 1,
+          })
         }
       }
 
@@ -154,7 +153,7 @@ export class TypegenGenerateCommand extends SanityCommand<typeof TypegenGenerate
       }
     } catch (err) {
       spin.fail()
-      throw err
+      this.error(`An error occured during config loading ${err}`, {exit: 1})
     }
   }
 

src/utils/debug.ts

@@ -0,0 +1,3 @@
+import {subdebug} from '@sanity/cli-core'
+
+export const debug = subdebug('typegen:generate')