From d4aacac1f94f37e456972ae9861d1974493d6460 Mon Sep 17 00:00:00 2001 From: Bruno Farias Date: Wed, 28 Sep 2022 10:10:03 +0100 Subject: [PATCH] Update filter CLI option docs (v29.1). Related to issue #13222 --- website/versioned_docs/version-29.1/CLI.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/versioned_docs/version-29.1/CLI.md b/website/versioned_docs/version-29.1/CLI.md index dde424ed1acd..c686f1e6b626 100644 --- a/website/versioned_docs/version-29.1/CLI.md +++ b/website/versioned_docs/version-29.1/CLI.md @@ -202,11 +202,13 @@ Alias: `-e`. Use this flag to show full diffs and errors instead of a patch. ### `--filter=` -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. +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 shape `{ filtered: Array<{ test: string }> }`. Especially useful when used in conjunction with a testing infrastructure to filter known broken tests, e.g. ```js title="my-filter.js" module.exports = testPaths => { - const allowedPaths = testPaths.filter(filteringFunction); // ["path1.spec.js", "path2.spec.js", etc] + const allowedPaths = testPaths.filter(filteringFunction) + .map(test => ({ test })); // [{ test: "path1.spec.js" }, { test: "path2.spec.js" }, etc] + return { filtered: allowedPaths, };