From eaa676cb2405d1524cc828ab800522f8c2c9a273 Mon Sep 17 00:00:00 2001
From: Josh Goldberg <git@joshuakgoldberg.com>
Date: Tue, 5 Sep 2023 17:56:51 -0400
Subject: [PATCH] docs: explain globals in RuleTester for Mocha and Vitest

---
 docs/packages/Rule_Tester.mdx | 40 +++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/docs/packages/Rule_Tester.mdx b/docs/packages/Rule_Tester.mdx
index 47589dde9330..de9d2ce7a33b 100644
--- a/docs/packages/Rule_Tester.mdx
+++ b/docs/packages/Rule_Tester.mdx
@@ -193,6 +193,46 @@ ruleTester.run('my-rule', rule, {
 
 All dependencies provided in the `dependencyConstraints` object must match their given ranges in order for a test to not be skipped.
 
+### With Specific Frameworks
+
+ESLint's `RuleTester` relies on some global hooks for tests.
+If they aren't available globally, your tests will fail with an error like:
+
+> ```plaintext
+> Error: Missing definition for `afterAll` - you must set one using `RuleTester.afterAll` or there must be one defined globally as `afterAll`.
+> ```
+
+:::tip
+Be sure to set `RuleTester`'s static properties _before_ calling `new RuleTester(...)` for the first time.
+:::
+
+#### Mocha
+
+Consider setting up `RuleTester`'s static properties in a [`mochaGlobalSetup` fixture](https://mochajs.org/#global-setup-fixtures):
+
+```ts
+import * as mocha from 'mocha';
+import { RuleTester } from '@typescript-eslint/rule-tester';
+
+RuleTester.afterAll = mocha.after;
+```
+
+#### Vitest
+
+Consider setting up `RuleTester`'s static properties in a [`globalSetup` script](https://vitest.dev/config/#globalsetup):
+
+```ts
+import * as vitest from 'vitest';
+import { RuleTester } from '@typescript-eslint/rule-tester';
+
+RuleTester.afterAll = vitest.afterAll;
+
+// If you are not using vitest with globals: true (https://vitest.dev/config/#globals):
+RuleTester.it = vitest.it;
+RuleTester.itOnly = vitest.it.only;
+RuleTester.describe = vitest.describe;
+```
+
 ## Options
 
 ### `RuleTester` constructor options