Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for --filter CLI option (see #12260) #12799

Merged
merged 4 commits into from
May 5, 2022
Merged

Update documentation for --filter CLI option (see #12260) #12799

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
613f25b
Update documentation (see #12260)
gramsco May 3, 2022
e02f6b3
Update CHANGELOG.md
gramsco May 3, 2022
978629d
Update website/versioned_docs/version-28.0/CLI.md
gramsco May 3, 2022
5911976
update docs/CLI.mod
May 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

### Chore & Maintenance

- `[docs]` Specified documentation about `--filter` CLI docs ([#12799](https://github.com/facebook/jest/pull/12799))
- `[@jest-reporters]` Move helper functions from `utils.ts` into separate files ([#12782](https://github.com/facebook/jest/pull/12782))
- `[jest-resolve]` Replace `process.versions.pnp` type declaration with `@types/pnpapi` devDependency ([#12783](https://github.com/facebook/jest/pull/12783))

Expand Down
13 changes: 12 additions & 1 deletion website/versioned_docs/version-28.0/CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,18 @@ Alias: `-e`. Use this flag to show full diffs and errors instead of a patch.

### `--filter=<file>`

Path to a module exporting a filtering function. This method receives a list of tests which can be manipulated to exclude tests from running. Especially useful when used in conjunction with a testing infrastructure to filter known broken.
Path to a module exporting a filtering function. This asynchronous function receives a list of test paths which can be manipulated to exclude tests from running by returning an object with the "filtered" property. Especially useful when used in conjunction with a testing infrastructure to filter known broken, e.g.

```javascript
// my-filter.js
gramsco marked this conversation as resolved.
Show resolved Hide resolved
module.exports = (testPaths) => {
const allowedPaths = testPaths.filter(filteringFunction) // ["path1.spec.js", "path2.spec.js", etc]
return {
filtered : allowedPaths,
}
}
```


### `--findRelatedTests <spaceSeparatedListOfSourceFiles>`

Expand Down