docs: add missing Vitest spy docs

JoshuaKGoldberg · Sep 8, 2023 · ca28afb · ca28afb
1 parent 398a1b3
commit ca28afb
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -302,6 +302,25 @@ require("console-fail-test").cft({
         </a>
       </td>
     </tr>
+    <tr>
+      <td>Vitest</td>
+      <td>
+        ✅️
+      </td>
+      <td>
+        <code>"vitest"</code>
+      </td>
+      <td>
+        <a href="https://vitest.dev/guide/mocking.html#functions">
+          <code>vi.fn()</code>
+        </a>
+      </td>
+      <td>
+        <a href="./docs/Vitest.md#spies">
+          <code>Vitest.md#spies</code>
+        </a>
+      </td>
+    </tr>
   </tbody>
 </table>
 

diff --git a/docs/Vitest.md b/docs/Vitest.md
@@ -24,3 +24,9 @@ import * as vitest from "vitest";
 
 require("console-fail-test").cft();
 ```
+
+## Spies
+
+Global `console` methods will be replaced by `vi.fn()` spies.
+You can inspect them at runtime as usual per vitest spies.
+See vitest's [mock functions docs](https://vitest.dev/guide/mocking.html#functions).