# Configuration

When running create-schemas from the command line, it will automatically try to resolve a config file named create-schemas.config.ts inside project root (other JS and TS extensions are also supported).

The most basic config file looks like this:

create-schemas.config.ts
export default {
  // config options
}

You can use the defineConfig helper which should provide intellisense:

create-schemas.config.ts
import { defineConfig } from '@workleap/create-schemas'

export default defineConfig({
  // example
})

# root

Type: string
Default: process.cwd()

Project root directory used to resolve relative paths. Can be an absolute path, or a path relative to the current working directory.

# input

Type: string

Path to the OpenAPI schema file. Can be a local path or URL to a remote file.

# outdir

Type: string
Default: "./dist"

Output directory path. The files that will be generated in this directory depends on the plugins being used.

# watch

Type: boolean
Default: false

Enable watch mode. Watch mode will regenerate the code whenever the input file or the configuration file changes.

# plugins

Type: Plugin[]
Default: []

Array of plugins to use. See Using Plugins for more details.

# openApiTsOptions

Type: OpenApiTsOptions
Default: {}

Options passed to OpenAPI TypeScript for type generation. You normally should not have to change them.

See OpenAPI TypeScript options

https://openapi-ts.pages.dev/cli#flags