Config
Defined in: packages/core/src/types.ts:605
Screenbook configuration options.
Properties
Section titled “Properties”adoption?
Section titled “adoption?”
optionaladoption:AdoptionConfig
Defined in: packages/core/src/types.ts:660
Progressive adoption configuration for gradual rollout
Example
Section titled “Example”{ mode: "progressive", includePatterns: ["src/pages/billing/**"], minimumCoverage: 80 }apiIntegration?
Section titled “apiIntegration?”
optionalapiIntegration:ApiIntegrationConfig
Defined in: packages/core/src/types.ts:667
API integration configuration for auto-detecting dependencies from OpenAPI-generated clients (Orval, openapi-typescript, etc.)
Example
Section titled “Example”{ clientPackages: ["@/api/generated"] }excludePatterns?
Section titled “excludePatterns?”
optionalexcludePatterns:string[]
Defined in: packages/core/src/types.ts:654
Patterns to exclude from route detection. Directories matching these patterns are ignored when checking for screen.meta.ts. Useful for excluding component directories like “components/”, “hooks/”, etc.
https://github.com/wadakatu/screenbook/issues/190
generate?
Section titled “generate?”
optionalgenerate:GenerateConfig
Defined in: packages/core/src/types.ts:679
Configuration for screen ID generation in the generate command
Example
Section titled “Example”{ smartParameterNaming: true }ignore
Section titled “ignore”ignore:
string[]
Defined in: packages/core/src/types.ts:646
Patterns to ignore when scanning (glob patterns). Defaults to node_modules and .git directories.
optionallint:LintConfig
Defined in: packages/core/src/types.ts:673
Lint configuration for controlling warning behavior
Example
Section titled “Example”{ orphans: "off" }metaPattern
Section titled “metaPattern”metaPattern:
string
Defined in: packages/core/src/types.ts:621
Glob pattern for screen metadata files. Supports colocation: place screen.meta.ts alongside your route files.
Default
Section titled “Default”"src/**/screen.meta.ts"Examples
Section titled “Examples”"src/**/screen.meta.ts""app/**/screen.meta.ts"outDir
Section titled “outDir”outDir:
string
Defined in: packages/core/src/types.ts:612
Output directory for generated files
Default
Section titled “Default”".screenbook"Examples
Section titled “Examples”".screenbook""dist/screenbook"routesFile?
Section titled “routesFile?”
optionalroutesFile:string
Defined in: packages/core/src/types.ts:640
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.
Examples
Section titled “Examples”"src/router/routes.ts""src/router/index.ts"routesPattern?
Section titled “routesPattern?”
optionalroutesPattern:string
Defined in: packages/core/src/types.ts:631
Glob pattern for route files (for generate/lint commands). Use this for file-based routing frameworks (Next.js, Nuxt, Remix, etc.). Cannot be used together with routesFile.
Examples
Section titled “Examples”"src/pages/**/page.tsx""app/**/page.tsx""src/routes/**/*.tsx"