跳到主内容
版本:Next

过滤

过滤允许您将命令限制于包的特定子集。

pnpm 支持丰富选择器语法,可以通过名称或关系选择包。

可通过 --filter (或 -F) 标志制定选择器:

pnpm --filter <package_selector> <command>

匹配

--filter <package_name>

要选择准确的包,只需指定其名称 (@scope/pkg) 或使用 模式来选择一组包 (@scope/*)。

示例:

pnpm --filter "@babel/core" test
pnpm --filter "@babel/*" test
pnpm --filter "*core" test

指定包的范围是可选的,因此如果未找到 core--filter=core 将选择 @babel/core。 但是,如果工作区有多个同名的包(例如,@babel/core@types/core),则没有范围的过滤将不会选择任何内容。

--filter <package_name>...

要选择一个软件包及其依赖项 (直接和非直接) 在包名称后加上省略号: <package_name>...。 例如,下一个命令将运行 foo 及其所有依赖的测试:

pnpm --filter foo... test

您可以使用通配符来选择一组根目录包:

pnpm --filter "@babel/preset-*..." test

--filter <package_name>^...

要只选择一个包的依赖项(直接和非直接), 在包名前添加一个山形符号加上上面提到的省略号。 例如,下面的命令将运行所有 foo 的依赖项的测试:

pnpm --filter "foo^..." test

--filter ...<package_name>

要选择一个包及被其依赖的包(直接和非直接),在包名前添加一个省略号: ...<package_name>。 例如,这将运行 foo 以及依赖于它的所有包的测试:

pnpm --filter ...foo test

--filter "...^<package_name>"

要只选择一个包的被依赖项 (直接和非直接) ,在包名前添加一个省略号与山形符号。 例如,这将运行所有依赖于 foo 的包的测试:

pnpm --filter "...^foo" test

--filter ./<glob>, --filter {<glob>}

相对于当前工作目录匹配项目的全局模式。

pnpm --filter "./packages/**" <cmd>

包括指定目录下的所有项目。

也可以使用省略号与山形符号来选择依赖项与被依赖项:

pnpm --filter ...{<directory>} <cmd>
pnpm --filter {<directory>}... <cmd>
pnpm --filter ...{<directory>}... <cmd>

也可以与 [<since>] 合并使用。 例如,要在某个目录中选择所有已更改的项目:

pnpm --filter "{packages/**}[origin/master]" <cmd>
pnpm --filter "...{packages/**}[origin/master]" <cmd>
pnpm --filter "{packages/**}[origin/master]..." <cmd>
pnpm --filter "...{packages/**}[origin/master]..." <cmd>

或者你可以从某个目录中选择符合给定的通配符的所有包:

pnpm --filter "@babel/*{components/**}" <cmd>
pnpm --filter "@babel/*{components/**}[origin/master]" <cmd>
pnpm --filter "...@babel/*{components/**}[origin/master]" <cmd>

--filter "[<since>]"

选择自指定的 commit / branch 以来有更改的所有包。 可以在前后添加 ... 来包括依赖项/被依赖项:

例如,以下命令将运行自 master 以来所有变动过的包以及被其依赖的包的测试:

pnpm --filter "...[origin/master]" test

--fail-if-no-match

Added in: v8.13.1

Use this flag if you want the CLI to fail if no packages have matched the filters.

排除

任何过滤规则选择器都可以作为排除项,只要在开头添加一个"!"。 在 zsh (可能还有其他shells) 中, "!" 应转义: \!.

例如,这将在除 foo 以外的所有项目中运行一个命令:

pnpm --filter=!foo <cmd>

然后这将在所有不在 lib目录下的项目中运行一个命令:

pnpm --filter=!./lib <cmd>

多重性

当包被过滤时,每个都会被匹配到至少一个选择器。 你可以使用无限数量的过滤器:

pnpm --filter ...foo --filter bar --filter baz... test

--filter-prod <filtering_pattern>

在从工作区选择依赖项时,会忽略 devDependencies,其余行为与 --filter 一致。

--test-pattern <glob>

test-pattern 允许检测修改后的文件是否与测试有关。 如果是这样,经这种修改的包的被依赖包并不包括在内。

此选项对 "changed since" 过滤器很有用。 例如,以下命令将在所有更改的包中运行测试, 如果报的源码发生变更,则测试也将在其依赖的包中运行:

pnpm --filter="...[origin/master]" --test-pattern="test/*" test

--changed-files-ignore-pattern <glob>

在筛选自指定提交/分支以来更改的项目时,允许通过glob模式忽略已更改的文件。

用法示例:

pnpm --filter="...[origin/master]" --changed-files-ignore-pattern="**/README.md" run build