@lerna/filter-options
Options for lerna sub-commands that need filtering
Install lerna for access to the lerna
CLI.
Options
--scope <glob>
Include only packages with names matching the given glob.
$ lerna exec --scope my-component -- ls -la
$ lerna run --scope toolbar-* test
$ lerna run --scope package-1 --scope *-2 lint
Note: For certain globs, it may be necessary to quote the option argument to avoid premature shell expansion.
--ignore <glob>
Exclude packages with names matching the given glob.
$ lerna exec --ignore package-{1,2,5} -- ls -la
$ lerna run --ignore package-1 test
$ lerna run --ignore package-@(1|2) --ignore package-3 lint
More examples of filtering can be found here.
--no-private
Exclude private packages. They are included by default.
--since [ref]
Only include packages that have been updated since the specified ref
. If no ref is passed, it defaults to the most-recent tag.
$ lerna exec --since -- ls -la
$ lerna run test --since master
$ lerna ls --since some-branch
This can be particularly useful when used in CI, if you can obtain the target branch a PR will be going into, because you can use that as the ref
to the --since
option. This works well for PRs going into master as well as feature branches.
--exclude-dependents
Exclude all transitive dependents when running a command with --since
, overriding the default "changed" algorithm.
This flag has no effect without --since
, and will throw an error in that case.
--include-dependents
Include all transitive dependents when running a command regardless of --scope
, --ignore
, or --since
.
--include-dependencies
Include all transitive dependencies when running a command regardless of --scope
, --ignore
, or --since
.
Used in combination with any command that accepts --scope
(bootstrap
, clean
, ls
, run
, exec
).
Ensures that all dependencies (and dev dependencies) of any scoped packages (either through --scope
or --ignore
) are operated on as well.
Note: This will override the --scope
and --ignore
flags.
i.e. A package matched by the --ignore
flag will still be bootstrapped if it is depended on by another package that is being bootstrapped.
This is useful for situations where you want to "set up" a single package that relies on other packages being set up.
$ lerna bootstrap --scope my-component --include-dependencies
$ lerna bootstrap --scope "package-*" --ignore "package-util-*" --include-dependencies