fix(keyboard): add link to README in key descriptor error (#666)

testing-library · Apr 28, 2021 · ebc90d8 · ebc90d8
1 parent 1560b29
commit ebc90d8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/__tests__/keyboard/index.ts b/src/__tests__/keyboard/index.ts
@@ -95,7 +95,7 @@ describe('error', () => {
     expect(err).toHaveBeenCalledWith(expect.any(Error) as unknown)
     expect(err.mock.calls[0][0]).toHaveProperty(
       'message',
-      'Expected key descriptor but found "!" in "{!"',
+      expect.stringContaining('Expected key descriptor but found "!" in "{!"'),
     )
   })
 

diff --git a/src/keyboard/getNextKeyDef.ts b/src/keyboard/getNextKeyDef.ts
@@ -141,5 +141,7 @@ function getErrorMessage(
   found: string | undefined,
   text: string,
 ) {
-  return `Expected ${expected} but found "${found ?? ''}" in "${text}"`
+  return `Expected ${expected} but found "${found ?? ''}" in "${text}"
+    See https://github.com/testing-library/user-event/blob/master/README.md#keyboardtext-options
+    for more information about how userEvent parses your input.`
 }