fix: non-jest framework error throwing, make auto-cleanup optional

Author: crutchcorn

src/events.js

@@ -1,5 +1,9 @@
 import {eventMap} from './event-map'
 
+/**
+ * Silence TypeScript errors
+ * @type {*}
+ */
 const fireEvent = Object.entries(eventMap).reduce(
   (prev, [eventName, eventFn]) => {
     prev[eventName] = ((instance, ...props) => {

src/helpers.js

@@ -1,5 +1,3 @@
-import {fireEvent} from "./events";
-
 function jestFakeTimersAreEnabled() {
     /* istanbul ignore else */
     if (typeof jest !== 'undefined' && jest !== null) {
@@ -16,31 +14,24 @@ function jestFakeTimersAreEnabled() {
 
 const instance = {current: undefined};
 
-/**
- * Should not rely directly on `afterEach` without library detection
- * @see https://testing-library.com/docs/react-testing-library/setup/#skipping-auto-cleanup
- */
-afterEach(() => {
-    /**
-     * Behavior should be customizability like it is with `react-testing-library`
-     * @see https://testing-library.com/docs/react-testing-library/setup/#skipping-auto-cleanup
-     */
-    if (instance.current) fireEvent.sigkill(instance.current);
-    instance.current = undefined;
-})
+if (typeof afterEach === 'function') {
+    afterEach(() => {
+        instance.current = undefined;
+    })
+}
 
 function getCurrentInstance() {
     /**
      * Worth mentioning that this deviates from the upstream implementation
-     * of `dom-testing-library`'s `getDocument`, which throws an error whenever
+     * of `dom-testing-library`'s `getDocument` in waitFor, which throws an error whenever
      * `window` is not defined.
      *
      * Admittedly, this is another way that `cli-testing-library` will need to figure out
      * the right solution to this problem, since there is no omni-present parent `instance`
      * in a CLI like there is in a browser. (although FWIW, "process" might work)
      *
      * Have ideas how to solve? Please let us know:
-     * https://github.com/crutchcorn/cli-testing-library/issues/2
+     * https://github.com/crutchcorn/cli-testing-library/issues/
      */
     return instance.current
 }

src/index.js

@@ -1,6 +1,30 @@
+import {cleanup} from "./pure";
+
+// if we're running in a test runner that supports afterEach
+// or teardown then we'll automatically run cleanup afterEach test
+// this ensures that tests run in isolation from each other
+// if you don't like this then set the CTL_SKIP_AUTO_CLEANUP env variable to 'true'.
+if (typeof process === 'undefined' || !process.env?.CTL_SKIP_AUTO_CLEANUP) {
+    // ignore teardown() in code coverage because Jest does not support it
+    /* istanbul ignore else */
+    if (typeof afterEach === 'function') {
+        afterEach(() => {
+            cleanup();
+        })
+    } else if (typeof teardown === 'function') {
+        // Block is guarded by `typeof` check.
+        // eslint does not support `typeof` guards.
+        // eslint-disable-next-line no-undef
+        teardown(() => {
+            cleanup()
+        })
+    }
+}
+
 export * from './helpers'
 export * from './events'
 export * from './pure'
 export * from './matches'
 export * from './mutation-observer'
 export * from './wait-for'
+

src/pure.ts

@@ -1,18 +1,15 @@
-/**
- * I'm not going to pretend to know why `react-testing-library` calls a very similar
- * file "pure", but I am familiar enough with the concept of "pure" methods or whatnot
- * that I am not confident we are using it here properly. Plz no yell for the name
- * but suggestions for alternatives welcome in GH issues 😭🙏💯
- */
 import childProcess from 'child_process'
 import stripFinalNewline from 'strip-final-newline'
 import {RenderOptions, RenderResult, TestInstance} from '../types/pure'
 import {_runObservers} from './mutation-observer'
 import {getQueriesForElement} from './get-queries-for-instance'
-import {getFireEventForElement} from './events'
+import {fireEvent, getFireEventForElement} from './events'
 import {debounce, setCurrentInstance} from "./helpers";
 import {getConfig} from "./config";
 
+
+const mountedInstances = new Set<TestInstance>()
+
 async function render(
   command: string,
   args: string[] = [],
@@ -50,6 +47,8 @@ async function render(
     set stdoutStr(val: string) {},
   }
 
+  mountedInstances.add(execOutputAPI as unknown as TestInstance)
+
   /**
    * This method does not throw errors after-the-fact,
    * meaning that if post-render errors are thrown,
@@ -127,4 +126,16 @@ async function render(
   ) as TestInstance as RenderResult
 }
 
-export {render}
+function cleanup() {
+  mountedInstances.forEach(cleanupAtInstance)
+}
+
+// maybe one day we'll expose this (perhaps even as a utility returned by render).
+// but let's wait until someone asks for it.
+function cleanupAtInstance(instance: TestInstance) {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+  fireEvent.sigkill(instance)
+  mountedInstances.delete(instance)
+}
+
+export {render, cleanup}