fix: update docs to show global regex & add test

Signed-off-by: Chapman Pendery <[email protected]>
microsoft · Feb 29, 2024 · 7d81e1b · 7d81e1b
1 parent 8ddbcde
commit 7d81e1b
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -98,7 +98,7 @@ import { test, expect } from "@microsoft/tui-test";
 test("make a regex assertion", async ({ terminal }) => {
   terminal.write("ls -l\r")
 
-  await expect(terminal.getByText(/total [0-9]{3}/m)).toBeVisible();
+  await expect(terminal.getByText(/total [0-9]{3}/g)).toBeVisible();
 });
 ```
 

diff --git a/examples/assertions.test.ts b/examples/assertions.test.ts
@@ -8,7 +8,7 @@ test.use({ shell: Shell.Powershell });
 test("make a regex assertion", async ({ terminal }) => {
   terminal.write("dir | measure\r");
 
-  await expect(terminal.getByText(/Count\s*:\s*[0-9]{2}/m)).toBeVisible();
+  await expect(terminal.getByText(/Count\s*:\s*[0-9]{2}/g)).toBeVisible();
 });
 
 test("make a text assertion", async ({ terminal }) => {

diff --git a/package-lock.json b/package-lock.json
diff --git a/test/__snapshots__/e2e.test.ts.snap b/test/__snapshots__/e2e.test.ts.snap
@@ -1,5 +1,45 @@
 // TUI Test Snapshot v1
 
+exports[`ctrl+c 1`] = String.raw`
+╭────────────────────────────────────────────────────────────────────────────────╮
+│>                                                                               │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+╰────────────────────────────────────────────────────────────────────────────────╯
+`;
+
+exports[`ctrl+c 1 1`] = String.raw`
+╭────────────────────────────────────────────────────────────────────────────────╮
+│> ^C                                                                            │
+│>                                                                               │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+│                                                                                │
+╰────────────────────────────────────────────────────────────────────────────────╯
+`;
+
 exports[`resize 1`] = String.raw`
 ╭────────────────────────────────────────────────────────────────────────────────╮
 │> foo                                                                           │

diff --git a/test/e2e.test.ts b/test/e2e.test.ts
@@ -16,6 +16,22 @@ const isWindows = os.platform() == "win32";
 const isNotMacOS = os.platform() != "darwin";
 const isLinux = os.platform() == "linux";
 
+test.describe("locators", () => {
+  test.describe("getByText", () => {
+    test("string driven", async ({ terminal }) => {
+      await expect(terminal.getByText(">")).toBeVisible();
+    });
+
+    test("regex driven", async ({ terminal }) => {
+      await expect(terminal.getByText(/>/g)).toBeVisible();
+    });
+
+    test.fail("regex driven non-global regex", async ({ terminal }) => {
+      await expect(terminal.getByText(/>/m)).toBeVisible();
+    });
+  });
+});
+
 test.describe("key controls", () => {
   test("left key", async ({ terminal }) => {
     terminal.write("bar");