types.ts

import type { ParserPlugin } from '@babel/parser'

export interface Options {
  /**
   * Add a string prefix to the console log.
   *
   * @defaultValue ''
   */
  prefix?: string
  /**
   * Add a string suffix to the console log.
   *
   * @defaultValue ''
   */
  suffix?: string
  /**
   * Whether to disable the launch editor feature.
   *
   * @defaultValue false
   */
  disableLaunchEditor?: boolean
  /**
   * Whether to disable the highlight output feature.
   *
   * @defaultValue false
   */
  disableHighlight?: boolean
  /**
   * The specific service port of launch editor server.
   *
   * @defaultValue 3070
   */
  port?: number
  /**
   * Whether to show extended path name when the file's (or folder's) name contains an element in the array.
   *
   * @remarks
   *
   * Consider a project includes these files:
   *
   * /views/Feature1/index.vue
   *
   * /views/Feature2/index.vue
   *
   * Set extendedPathFileNames as ['index'] can show the extended path name in the console output.
   *
   * @defaultValue `[]`
   *
   */
  extendedPathFileNames?: string[]
  /**
   * The specific editor to launch.
   *
   * All available editors: https://github.com/yyx990803/launch-editor#supported-editors
   *
   * Linked issues:#33
   *
   * @defaultValue undefined
   *
   */
  specifiedEditor?: string | undefined

  /**
   * Babel parser plugins. `typescript` and `jsx` are enabled by default.
   *
   * https://babeljs.io/docs/en/babel-parser#plugins
   *
   * @defaultValue ['typescript', 'jsx']
   */
  babelParserPlugins?: ParserPlugin[]

  /**
   * Whether to pass server logs to the client.
   *
   * Set it to `false` to disable.
   *
   * @defaultValue true
   */
  passServerLogs?: boolean
}

export interface GenContext {
  options: Options
  originalLine: number
  originalColumn: number
  argsName: string
  argType: string
  id: string
}

export type Compiler = 'vanilla' | 'vue3' | 'vue2' | 'svelte'

export interface Context {
  code: string
  id: string
  options: Options
}

export interface CompileResult {
  script: string
  offset: number
  line: number
}

export type TCMethod = 'log' | 'error' | 'warn' | 'info'