chore: drastically improve logic of toBeInTheConsole

Author: crutchcorn

src/__tests__/matchers.js

@@ -1,11 +1,22 @@
 const {resolve} = require('path')
 const {render} = require('../pure')
 
-test('Should handle argument passing', async () => {
+test('toBeInTheConsole should pass when something is in console', async () => {
   const {findByText} = await render('node', [
     resolve(__dirname, './execute-scripts/list-args.js'),
     '--version',
   ])
 
-  expect(await findByText('--version')).toBeInTheConsole()
+  await expect(
+      (async () => expect(await findByText('--version')).toBeInTheConsole())()
+  ).resolves.not.toThrow()
+})
+
+test('toBeInTheConsole should fail when something is not console', async () => {
+  const {queryByText} = await render('node', [
+    resolve(__dirname, './execute-scripts/list-args.js'),
+    '--version',
+  ])
+
+  expect(() => expect(queryByText('NotHere')).toBeInTheConsole()).toThrow(/value must be a TestInstance/)
 })

src/matchers/to-be-in-the-console.js

@@ -1,27 +1,15 @@
-import {
-  ensureNoExpected,
-  matcherHint,
-  printReceived,
-} from 'jest-matcher-utils';
+import {checkCliInstance} from "./utils";
 
-export function toBeInTheConsole(instance, expected) {
-  // This code is 1:1 with Jest's built-in "ToBeTruthy"
-  // @see https://github.com/facebook/jest/blob/main/packages/expect/src/matchers.ts#L398-L414
-  const matcherName = 'toBeTruthy';
-  const options = {
+export function toBeInTheConsole(instance) {
+  // eslint-disable-next-line @babel/no-invalid-this
+  if (instance !== null || !this.isNot) {
     // eslint-disable-next-line @babel/no-invalid-this
-    isNot: this.isNot,
-    // eslint-disable-next-line @babel/no-invalid-this
-    promise: this.promise,
-  };
-  ensureNoExpected(expected, matcherName, options);
-
-  const pass = !!instance;
-
-  const message = () =>
-      `${matcherHint(matcherName, undefined, '', options) 
-      }\n\n` +
-      `Received: ${printReceived(instance)}`;
-
-  return {message, pass};
+    checkCliInstance(instance, toBeInTheConsole, this)
+  }
+
+  // Assuming it passed above, it must have passed
+  return {
+    pass: true,
+    message: () => []
+  }
 }

src/matchers/utils.js

@@ -0,0 +1,57 @@
+class GenericTypeError extends Error {
+    constructor(expectedString, received, matcherFn, context) {
+        super()
+
+        /* istanbul ignore next */
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, matcherFn)
+        }
+        let withType = ''
+        try {
+            withType = context.utils.printWithType(
+                'Received',
+                received,
+                context.utils.printReceived,
+            )
+        } catch (e) {
+            // Can throw for Document:
+            // https://github.com/jsdom/jsdom/issues/2304
+        }
+        this.message = [
+            context.utils.matcherHint(
+                `${context.isNot ? '.not' : ''}.${matcherFn.name}`,
+                'received',
+                '',
+            ),
+            '',
+            // eslint-disable-next-line @babel/new-cap
+            `${context.utils.RECEIVED_COLOR(
+                'received',
+            )} value must ${expectedString}.`,
+            withType,
+        ].join('\n')
+    }
+}
+
+class CliInstanceTypeError extends GenericTypeError {
+    constructor(...args) {
+        super('be a TestInstance', ...args)
+    }
+}
+
+/**
+ * @param {TestInstance} cliInstance
+ * @param args
+ */
+function checkCliInstance(cliInstance, ...args) {
+       if (
+        !(cliInstance && cliInstance.process && cliInstance.process.stdout)
+    ) {
+        throw new CliInstanceTypeError(cliInstance, ...args)
+    }
+}
+
+export {
+    CliInstanceTypeError,
+    checkCliInstance,
+}