feat(plugin-testing): support -u option to update snapshot (#5022)

web-infra-dev · Nov 30, 2023 · a8923ca · a8923ca
1 parent b182eb2
commit a8923ca
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 4 deletions.
diff --git a/.changeset/twenty-ways-tickle.md b/.changeset/twenty-ways-tickle.md
@@ -0,0 +1,7 @@
+---
+'@modern-js/plugin-testing': patch
+---
+
+feat(plugin-testing): support -u option to update snapshot
+
+feat(plugin-testing): 支持 -u 选项来更新快照
diff --git a/packages/document/main-doc/docs/en/apis/app/commands.mdx b/packages/document/main-doc/docs/en/apis/app/commands.mdx
@@ -276,7 +276,9 @@ Normally, only the part of the code modified by this commit needs to be checked
 Usage: modern test [options]
 
 Options:
-  -h, --help  show command help
+  -u --updateSnapshot  use this flag to re-record snapshots.
+  --watch              watch files for changes and rerun tests related to changed files.
+  -h, --help           show command help
 ```
 
 :::tip

diff --git a/packages/document/main-doc/docs/zh/apis/app/commands.mdx b/packages/document/main-doc/docs/zh/apis/app/commands.mdx
@@ -278,7 +278,9 @@ Options:
 Usage: modern test [options]
 
 Options:
-  -h, --help  显示命令帮助
+  -u --updateSnapshot  使用此选项来更新快照
+  --watch              监视文件的变更并重新运行相关的测试
+  -h, --help           显示命令帮助
 ```
 
 :::tip

diff --git a/packages/document/module-doc/docs/en/guide/basic/command-preview.md b/packages/document/module-doc/docs/en/guide/basic/command-preview.md
@@ -87,7 +87,9 @@ The officially supported debugging tool is [Rspress](https://rspress.dev/), so y
 Usage: modern test [options]
 
 Options:
-  -h, --help display help for command
+  -u --updateSnapshot  use this flag to re-record snapshots.
+  --watch              watch files for changes and rerun tests related to changed files.
+  -h, --help           show command help
 ```
 
 You need to execute `modern new` to turn on the test function before you can execute the `modern test` command.

diff --git a/packages/document/module-doc/docs/zh/guide/basic/command-preview.md b/packages/document/module-doc/docs/zh/guide/basic/command-preview.md
@@ -87,7 +87,9 @@ Modern.js Module 提供了使用调试工具的能力，可以通过 `modern dev
 Usage: modern test [options]
 
 Options:
-  -h, --help  display help for command
+  -u --updateSnapshot  使用此选项来更新快照
+  --watch              监视文件的变更并重新运行相关的测试
+  -h, --help           显示命令帮助
 ```
 
 需要先执行 `modern new` 开启测试功能，然后才可以执行 `modern test` 命令。

diff --git a/packages/runtime/plugin-testing/src/base/runJest.ts b/packages/runtime/plugin-testing/src/base/runJest.ts
@@ -41,6 +41,12 @@ const buildArgv = async (
     result.config = JSON.stringify(config);
   }
 
+  // `-u` is the shorthand of `--updateSnapshot`
+  if (result.u === true) {
+    result.updateSnapshot = true;
+    delete result.u;
+  }
+
   return result;
 };
 

diff --git a/packages/runtime/plugin-testing/src/cli/index.ts b/packages/runtime/plugin-testing/src/cli/index.ts
@@ -69,6 +69,14 @@ export const testingPlugin = (): CliPlugin<{
         commands: ({ program }: any) => {
           program
             .command('test')
+            .option(
+              '-u --updateSnapshot',
+              'use this flag to re-record snapshots',
+            )
+            .option(
+              '--watch',
+              'watch files for changes and rerun tests related to changed files',
+            )
             .allowUnknownOption()
             .usage('<regexForTestFiles> --[options]')
             .action(async () => {