ConfigInput

Defined in: packages/core/src/types.ts:694

Input type for defineConfig function. All fields with defaults are optional in input.

Example

defineConfig({
  metaPattern: "app/**/screen.meta.ts",
  routesPattern: "app/**/page.tsx",
})

Properties

adoption?

optional adoption: AdoptionConfig

Defined in: packages/core/src/types.ts:740

Progressive adoption configuration

---

apiIntegration?

optional apiIntegration: ApiIntegrationConfig

Defined in: packages/core/src/types.ts:746

API integration configuration for auto-detecting dependencies from OpenAPI-generated clients

---

excludePatterns?

optional excludePatterns: string[]

Defined in: packages/core/src/types.ts:735

Patterns to exclude from route detection.

See

https://github.com/wadakatu/screenbook/issues/190

---

generate?

optional generate: GenerateConfig

Defined in: packages/core/src/types.ts:756

Configuration for screen ID generation in the generate command

---

ignore?

optional ignore: string[]

Defined in: packages/core/src/types.ts:729

Patterns to ignore when scanning. Defaults to node_modules and .git directories.

---

lint?

optional lint: LintConfig

Defined in: packages/core/src/types.ts:751

Lint configuration for controlling warning behavior

---

metaPattern?

optional metaPattern: string

Defined in: packages/core/src/types.ts:707

Glob pattern for screen metadata files

Default

"src/**/screen.meta.ts"

Example

"app/**/screen.meta.ts"

---

outDir?

optional outDir: string

Defined in: packages/core/src/types.ts:700

Output directory for generated files

Default

".screenbook"

Example

".screenbook"

---

routesFile?

optional routesFile: string

Defined in: packages/core/src/types.ts:723

Path to a router configuration file (for config-based routing). Use this for frameworks like Vue Router, React Router, etc. Cannot be used together with routesPattern.

Example

"src/router/routes.ts"

---

routesPattern?

optional routesPattern: string

Defined in: packages/core/src/types.ts:715

Glob pattern for route files (for generate/lint commands). Use this for file-based routing frameworks. Cannot be used together with routesFile.

Example

"src/pages/**/page.tsx"