# @lerna-lite/filter-packages

> Lerna-Lite common filtering utils used by a few optional commands (Exec/List/Run/Watch)

Latest version **3.9.3** (published 2024-10-08) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @lerna-lite/filter-packages
pnpm add @lerna-lite/filter-packages
yarn add @lerna-lite/filter-packages
bun add @lerna-lite/filter-packages
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.9.3 |
| Published | 2024-10-08 |
| First published | 2023-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | ^18.0.0 \|\| >=20.0.0 |
| Dependencies | 3 |
| Unpacked size | 14.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 567 |
| Author | Ghislain B. |
| Maintainers | ghiscoding |

## Links

- npm: https://www.npmjs.com/package/@lerna-lite/filter-packages
- Repository: https://github.com/lerna-lite/lerna-lite
- Issues: https://github.com/lerna-lite/lerna-lite/issues
- npm.io page: https://npm.io/package/@lerna-lite/filter-packages

## Dependencies (3)

- [multimatch](https://npm.io/package/multimatch.md) ^7.0.0
- [@lerna-lite/core](https://npm.io/package/@lerna-lite/core.md) 3.9.3
- [@lerna-lite/npmlog](https://npm.io/package/@lerna-lite/npmlog.md) 3.9.3

## Recent versions

- 3.9.3 (latest) — 2024-10-08
- 3.9.2 — 2024-09-28
- 3.9.1 — 2024-09-07
- 3.9.0 — 2024-08-30
- 3.8.0 — 2024-08-05
- 3.7.1 — 2024-07-13
- 3.7.0 — 2024-07-05
- 3.6.0 — 2024-06-27
- 3.5.1 — 2024-06-07
- 3.5.0 — 2024-06-03
- 3.4.0 — 2024-05-15
- 3.3.3 — 2024-04-15
- 3.3.2 — 2024-04-02
- 3.3.1 — 2024-03-04
- 3.3.0 — 2024-02-10
- … 24 more at https://npm.io/package/@lerna-lite/filter-packages/versions

## README

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![npm](https://img.shields.io/npm/dy/@lerna-lite/filter-packages?color=forest)](https://www.npmjs.com/package/@lerna-lite/filter-packages)
[![npm](https://img.shields.io/npm/v/@lerna-lite/filter-packages.svg?logo=npm&logoColor=fff&label=npm)](https://www.npmjs.com/package/@lerna-lite/filter-packages)

## Lerna-Lite filtering utils for optional commands (Exec/List/Run/Watch)

#### @lerna-lite/filter-packages

Shared common code for the following optional commands:

- [@lerna-lite/exec](https://github.com/lerna-lite/lerna-lite/tree/main/packages/exec)
- [@lerna-lite/list](https://github.com/lerna-lite/lerna-lite/tree/main/packages/list)
- [@lerna-lite/run](https://github.com/lerna-lite/lerna-lite/tree/main/packages/run)
- [@lerna-lite/watch](https://github.com/lerna-lite/lerna-lite/tree/main/packages/watch)

### Installation

Follow the instruction provided in the main [README](https://github.com/lerna-lite/lerna-lite#installation) page.

---

> Options for lerna sub-commands that need filtering

## Options

### `--scope <glob>`

Include only packages with names matching the given glob.

```sh
$ 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.

### **Running with `npx`**

When running `lerna` with `npx`, it is necessary to use an explicit "=" when passing glob arguments. This is to prevent `npx` from prematurely expanding the arguments.

For example:

```sh
$ npx lerna run --scope="toolbar-*" test
$ npx lerna run --scope="package-{1,2,5}" test
```

### `--ignore <glob>`

Exclude packages with names matching the given glob.

```sh
$ 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](https://github.com/lerna/lerna/blob/c0a750e0f482c16dda2f922f235861283efbe94d/commands/list/__tests__/list-command.test.js#L305-L356).

### `--no-private`

Exclude private packages. They are included by default.

### `--since [ref]`

Only include packages that have been changed since the specified `ref`. If no ref is passed, it defaults to the most-recent tag.

```sh
# List the contents of packages that have changed since the latest tag
$ lerna exec --since -- ls -la

# Run the tests for all packages that have changed since `main`
$ lerna run test --since main

# List all packages that have changed since `some-branch`
$ 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 the default branch 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`.

```sh
# example with lerna watch
$ lerna watch --scope=my-package-1 --include-dependents -- lerna run build --stream --scope=\$LERNA_PACKAGE_NAME --include-dependents
```

### `--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` (`ls`, `run`, `exec`, `watch`).
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.

This is useful for situations where you want to "set up" a single package that relies on other packages being set up.

```sh
# example with lerna watch, watch only package "package-4" and its dependencies and run the test script for the package that changed
$ lerna watch --scope="package-4" --include-dependencies -- lerna run test --scope=\$LERNA_PACKAGE_NAME
```


### `--include-merged-tags`

```sh
$ lerna exec --since --include-merged-tags -- ls -la
```

Include tags from merged branches when running a command with `--since`. This is only useful if you do a lot of publishing from feature branches, which is not generally recommended.

---
_Source: https://npm.io/package/@lerna-lite/filter-packages · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._