Skip to main content

Module dev_config

Module dev_config 

Source
Expand description

Development configuration for plugin builds and file watching.

Reads optional broccoli.dev.toml from the plugin directory. When absent, all values fall back to sensible defaults derived from plugin.toml.

§File format

[watch]
# Extra glob patterns to ignore (extends built-in ignores).
# Built-in: target/, .git/, node_modules/, and [web].root from plugin.toml
ignore = ["*.log", "tmp/", "coverage/"]

[build]
# Directory containing the frontend source (has package.json).
# Default: auto-detected from [web].root parent, then web/, frontend/, or root.
frontend_dir = "client"

# Command to install frontend dependencies. Default: "pnpm install --ignore-workspace"
frontend_install_cmd = "npm install"

# Command to build the frontend (one-shot). Default: "pnpm build"
frontend_build_cmd = "npm run build"

# Command to start the frontend dev server (long-running, used by `watch`).
# Default: "pnpm dev"
frontend_dev_cmd = "npm run dev"

Structs§

ResolvedDevConfig
The parsed dev config with defaults applied.

Enums§

FileKind
Classify a changed file as backend, frontend, or unknown.

Constants§

BUILTIN_IGNORE_DIRS
Directories always ignored by the watcher (non-configurable).

Functions§

classify_file
resolve
Resolve the dev config for a plugin directory.
should_ignore
Check whether a path component matches any of the built-in or extra ignore patterns.