Config

Type for Docflow configuration files. Includes project settings, command settings, and plugin settings.

Signature

type Config = z.infer<typeof configSchema>;

Parameters

• projectRequired · object
  

  Project configuration information

  • rootRequired · string
    

    Project root directory

  • packageManagerRequired · "yarn" | "pnpm" | "npm"
    

    Package manager to use

  • workspaceRequired · object
    

    Workspace configuration

  • workspace.includeRequired · string[]
    

    Package patterns to include in build

  • workspace.excludeRequired · string[]
    

    Package patterns to exclude from build

• commandsRequired · object
  

  Command settings

  • buildRequired · object
    

    Build command settings

  • checkRequired · object
    

    Check command settings

  • generateRequired · object
    

    Generate command settings

• plugins · object[]
  

  Plugin settings

  • nameRequired · string
    

    Plugin name

  • pluginRequired · function
    

    Factory function that returns plugin instance

  • options · object
    

    Plugin options