Feat: pass along Jest testNamePattern argument if provided (#182)

FormidableLabs · Oct 3, 2024 · 15f3de0 · 15f3de0
1 parent 374043e
commit 15f3de0
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 6 deletions.
diff --git a/.changeset/great-mayflies-explain.md b/.changeset/great-mayflies-explain.md
@@ -0,0 +1,5 @@
+---
+'react-native-owl': minor
+---
+
+Ability to pass along Jest testNamePattern when the argument is provided
diff --git a/docs/cli/testing-the-app.mdx b/docs/cli/testing-the-app.mdx
@@ -11,11 +11,13 @@ Use the `test` command to run the app on the simulator, either comparing screens
 
 #### Options
 
-| Name               | Required | Default           | Options/Types   | Description                                     |
-| ------------------ | -------- | ----------------- | --------------- | ----------------------------------------------- |
-| `--config`, `-c`   | false    | ./owl.config.json | String          | Path to the configuration file                  |
-| `--platform`, `-p` | true     | -                 | `ios`,`android` | The platform the app should be built on         |
-| `--update`, `-u`   | true     | false             | Boolean         | A flag about rewriting existing baseline images |
+| Name                      | Required | Default           | Options/Types   | Description                                       |
+| ------------------------- | -------- | ----------------- | --------------- | ------------------------------------------------- |
+| `--config`, `-c`          | false    | ./owl.config.json | String          | Path to the configuration file                    |
+| `--platform`, `-p`        | true     | -                 | `ios`,`android` | The platform the app should be built on           |
+| `--update`, `-u`          | true     | false             | Boolean         | A flag about rewriting existing baseline images   |
+| `--testNamePattern`, `-t` | false    | false             | String          | Run only tests with a name that matches the regex |
+| `--testPathPattern`, `-p` | false    | false             | String          | A regexp string matched against all tests path    |
 
 When comparing images, any difference in the current vs baseline will fail the test.
 

diff --git a/lib/cli/index.ts b/lib/cli/index.ts
@@ -28,8 +28,14 @@ const updateOption: Options = {
   default: false,
 };
 
-const testPathPatternOption: Options = {
+const testNamePattern: Options = {
   alias: 't',
+  describe: 'Run only tests with a name that matches the regex',
+  type: 'string',
+};
+
+const testPathPatternOption: Options = {
+  alias: 'p',
   describe: 'Run Test for a matching path pattern',
   type: 'string',
   default: '',
@@ -44,6 +50,7 @@ const builderOptionsTest = {
   config: configOption,
   platform: plaformOption,
   update: updateOption,
+  testNamePattern: testNamePattern,
   testPathPattern: testPathPatternOption,
 };
 

diff --git a/lib/cli/run.ts b/lib/cli/run.ts
@@ -136,6 +136,10 @@ export const runHandler = async (args: CliRunOptions) => {
     jestCommandArgs.push(`--json --outputFile=${outputFile}`);
   }
 
+  if (args.testNamePattern) {
+    jestCommandArgs.push(`-t`, `${args.testNamePattern}`);
+  }
+
   const jestCommand = jestCommandArgs.join(' ');
 
   logger.print(

diff --git a/lib/types.ts b/lib/types.ts
@@ -11,6 +11,7 @@ export interface CliRunOptions extends Arguments {
   platform: Platform;
   config: string;
   update: boolean;
+  testNamePattern: string;
   testPathPattern: string;
 }