--filter(或 -F)标志按模式选择 monorepo 中的包。模式可以是包名称 glob、./path glob、{dir} 目录选择器或 ... 依赖关系。
bun run、bun install、bun add、bun remove、bun update、bun outdated、bun prune 和 bun pm licenses 均支持该标志。对于包管理器命令,请将标志放在子命令之后(bun install --filter api),因为 bun --filter <pattern> <word> 会将 <word> 作为脚本运行。
匹配
包名 --filter <pattern>
名称模式根据 package.json 中的 name 字段选择包。例如,如果有包 pkg-a、pkg-b 和 other,可以使用 * 匹配所有包,使用 pkg* 仅匹配 pkg-a 和 pkg-b,也可以使用包的完整名称匹配指定包。
包路径 --filter ./<glob>
路径模式以 ./ 开头,并选择目录中匹配该模式的所有包。例如,要匹配 packages 子目录中的所有包,请使用 --filter './packages/**'。要匹配 packages/foo 中的包,请使用 --filter ./packages/foo。
名称模式匹配完整的包名称(core 不会匹配 @acme/core;请使用 @acme/*),并且 * 不会跨越 /。路径模式必须匹配工作区目录本身:./packages 不会选择任何内容,./packages/* 会选择其中的每个直接工作区。
目录 --filter '{<dir>}'
大括号中的目录会选择该目录中或其任意下级目录中的所有工作区,目录路径相对于当前目录解析。--filter '{packages}' 会选择 packages/ 下的所有内容;--filter '{.}' 会选择当前目录的工作区及其下的所有内容。
依赖关系 --filter 'foo...'
在模式后添加 ...,还会选择通过工作区依赖关系关联的工作区:
foo 可以是名称 glob 或目录选择器(...{./packages/api})。要排除内容,请将 ! 放在最前面:--filter '!...foo'。
terminal
bun install 和 bun outdated
默认情况下,bun install 会为 monorepo 中的每个包安装依赖。要为特定包安装依赖,请使用 --filter。
多个 --filter 标志会组合使用:选择所有与正向模式匹配的内容,再排除与 ! 模式匹配的内容。没有匹配任何内容的模式会打印警告。对于 bun add、bun remove、bun update、bun prune 和 bun pm licenses,如果完全没有选择工作区,则会报错。
Given a monorepo with workspaces pkg-a, pkg-b, and pkg-c under ./packages:
terminal
bun outdated 会显示 monorepo 中所有包的过期依赖,而 --filter 会将命令限制为其中的部分包:
terminal
bun install 和 bun outdated。
使用 --filter 运行脚本
使用 --filter 标志可以一次在多个包中执行脚本:
terminal
packages/api 和 packages/frontend,它们都有一个用于启动本地开发服务器的 dev 脚本。通常,你需要打开两个终端标签页,分别切换到每个包的目录,然后运行 bun dev:
terminal
--filter,你可以同时在这两个包中运行 dev 脚本:
terminal
terminal
name 的 package.json 只能通过 ./path 模式选择。如果所选包中没有任何包包含该脚本,bun run 会退出并报错(传入 --if-present 则会改为以 0 退出)。
在工作区中运行脚本
过滤器遵循你的工作区配置:如果你的package.json 指定了哪些包属于工作区,--filter 只会匹配这些包。在工作区中,--filter 还可以运行位于工作区任意位置的包中的脚本:
terminal
并行和顺序模式
结合--filter 或 --workspaces 与 --parallel 或 --sequential,可以跨工作区包运行脚本,并带有 Foreman 风格的前缀输出:
terminal
pkg-a:build | ...)。不使用 --filter/--workspaces 时,前缀仅为脚本名称(build | ...)。当某个包的 package.json 没有 name 字段时,Bun 会改用相对于工作区根目录的路径。
使用 --if-present 与 --workspaces 一起,可跳过没有指定脚本的包,而不报错。
依赖顺序
Bun 会在运行脚本时遵循包的依赖顺序。假设你有一个包foo,它依赖于工作区中的另一个包 bar,并且两者都有一个 build 脚本。当你运行 bun --filter '*' build 时,只有在 bar 完成后,foo 才会开始运行。