Reference
The optional broom.config.json file and the keys it accepts.
Configuration is optional. Broom reads broom.config.json at the project root, or a "broom" key in package.json. Unknown keys and wrong types are rejected with exit code 2.
{ "ignore": ["fixtures/**", "**/*.generated.ts"], "gitignore": true, "env": { "files": ["config/.env.shared"], "ignore": ["SOME_RUNTIME_VAR"] }, "clean": { "paths": ["public", "src", "assets"], "ignore": ["public/downloads/"], "entries": ["src/workers/*.ts"] }, "ports": [3000, 5173, 6006], "output": { "color": false }}| Key | Default | Description |
|---|---|---|
ignore | [] | Extra glob patterns excluded from every scan. |
gitignore | true | Apply .gitignore files (nested ones too) when scanning. |
env.files | [] | Extra env files or globs to read. |
env.ignore | [] | Variable names never reported. |
clean.paths | public src app pages components assets styles | Directories checked for unused files (per workspace package). |
clean.ignore | [] | .gitignore-style patterns never reported. |
clean.entries | [] | .gitignore-style patterns treated as entry points. |
ports | 3000 3001 4000 4173 5173 5174 8000 8080 8787 | Ports checked by broom ports. |
output.color | auto | Set false to disable colors. |
{ "name": "my-app", "broom": { "ignore": ["fixtures/**"], "ports": [3000, 6006] }}node_modules .git .next .nuxt .output .svelte-kit .turbo .vercel .netlify .cache .parcel-cache .vite .angular .expo .docusaurus .yarn .pnpm-store dist build out coverage .nyc_output storybook-static
broom.config.ts and broom.config.js are not supported in 0.1.0; Broom warns if it finds one.
Found a problem in these docs? Open an issue on GitHub.