feat(jest-binary-data-matchers): remove unnecessary dependencies: jes…

…t-matcher-utils (#425)

* feat(jest-binary-data-matchers): remove unnecessary dependencies from core code: jest-matcher-utils

    `this.utils` is injected into all the matchers. `this.utils` is almost equal to the exports from `jest-matcher-utils`.
    see https://jestjs.io/docs/expect#thisutils

    Therefore, no need to include `jest-matcher-utils` in the dependencies.

* chore(jest-binary-data-matchers): remove `jest-matcher-utils`

* test(jest-binary-data-matchers): force enable Jest highlighting output using `--color` option

    Tests that require color output fail. Probably due to Jest color output being disabled.

* test(jest-binary-data-matchers): force enable Jest highlighting output using `--color=true` option

    Tests that require color output fail. Probably due to Jest color output being disabled.

* test(jest-binary-data-matchers): force enable Jest highlighting output using `FORCE_COLOR` env

    Tests that require color output fail. Probably due to Jest color output being disabled.

* test(jest-binary-data-matchers): remove `jest.setup.cjs`

    The `jest.setup.cjs` file was used to set the `FORCE_COLOR` environment variable within Jest's test environment.
    However, this is no longer necessary since `cross-env` is now used instead.

* refactor(jest-binary-data-matchers): reduce lines in `createCompareByteSizeMatcher()` function

    Code Climate reported:
    + Function `createCompareByteSizeMatcher` has 27 lines of code (exceeds 25 allowed). Consider refactoring.

* refactor(jest-binary-data-matchers): reduce similar blocks

    Code Climate reported:
    + Similar blocks of code found in 2 locations. Consider refactoring.

packages/jest-matchers/binary-data/jest.config.cjs

@@ -7,9 +7,6 @@ module.exports = {
       tsconfig: '<rootDir>/tests/tsconfig.json',
     },
   },
-  setupFilesAfterEnv: [
-    './jest.setup.cjs',
-  ],
   testEnvironment: 'node',
   testMatch: ['<rootDir>/tests/**/*.ts'],
   testPathIgnorePatterns: ['<rootDir>/tests/helpers/'],

packages/jest-matchers/binary-data/package.json

@@ -51,17 +51,17 @@
     "lint:tsc:src": "tsc -p ./src/ --noEmit",
     "lint:tsc:test": "tsc -p ./tests/ --noEmit",
     "test": "run-if-supported --verbose run-p test:*",
-    "test:jest": "jest"
+    "test:jest": "cross-env FORCE_COLOR=1 jest"
   },
   "dependencies": {
     "@sounisi5011/ts-type-util-is-readonly-array": "workspace:^1.0.0",
-    "jest-diff": "^28.0.0",
-    "jest-matcher-utils": "^27.3.1"
+    "jest-diff": "^28.0.0"
   },
   "devDependencies": {
     "@sounisi5011/run-if-supported": "workspace:^1.0.0",
     "@types/jest": "27.5.1",
     "@types/node": "12.20.52",
+    "cross-env": "7.0.3",
     "jest": "28.1.0",
     "pretty-format": "28.1.0",
     "ts-jest": "28.0.3",

packages/jest-matchers/binary-data/src/matchers.ts

@@ -1,8 +1,6 @@
-import { EXPECTED_COLOR, matcherHint, RECEIVED_COLOR } from 'jest-matcher-utils';
-import type { MatcherHintOptions } from 'jest-matcher-utils';
-
 import { BytesData, bytesEqual, byteSize, isBytesData, padTextColumns, toMessageFn } from './utils';
 import { ensureBytes, ensureByteSizeOrBytes, printBytesDiff } from './utils/jest';
+import type { MatcherHintOptions } from './utils/jest';
 
 function createCompareByteSizeMatcher(
     opts: {
@@ -31,21 +29,20 @@ function createCompareByteSizeMatcher(
             promise: this.promise,
         };
 
-        ensureByteSizeOrBytes(received, expected, matcherName, options);
+        ensureByteSizeOrBytes(this.utils, received, expected, matcherName, options);
         const expectedByteLength = isBytesData(expected) ? expected.byteLength : expected;
         const receivedByteLength = isBytesData(received) ? received.byteLength : received;
 
-        return {
-            message: toMessageFn(() => [
-                matcherHint(matcherName, undefined, undefined, options),
-                ``,
-                padTextColumns([
-                    ['Expected:', [isNot ? 'not' : '', operator], EXPECTED_COLOR(byteSize(expectedByteLength))],
-                    ['Received:', '', RECEIVED_COLOR(byteSize(receivedByteLength))],
-                ]),
+        const message = toMessageFn(() => [
+            this.utils.matcherHint(matcherName, undefined, undefined, options),
+            ``,
+            padTextColumns([
+                ['Expected:', [isNot ? 'not' : '', operator], this.utils.EXPECTED_COLOR(byteSize(expectedByteLength))],
+                ['Received:', '', this.utils.RECEIVED_COLOR(byteSize(receivedByteLength))],
             ]),
-            pass: passFn({ expected: expectedByteLength, received: receivedByteLength }),
-        };
+        ]);
+        const pass = passFn({ expected: expectedByteLength, received: receivedByteLength });
+        return { message, pass };
     };
 }
 
@@ -106,12 +103,12 @@ export function toBytesEqual(
         promise: this.promise,
     };
 
-    ensureBytes(received, expected, matcherName, options);
+    ensureBytes(this.utils, received, expected, matcherName, options);
     const pass = bytesEqual(expected, received);
     const message = toMessageFn(() => [
-        matcherHint(matcherName, undefined, undefined, options),
+        this.utils.matcherHint(matcherName, undefined, undefined, options),
         ``,
-        printBytesDiff(expected, received, {
+        printBytesDiff(this.utils, expected, received, {
             expectedLabel: 'Expected',
             receivedLabel: 'Received',
             expand: this.expand,

packages/jest-matchers/binary-data/src/utils/jest.ts

@@ -1,23 +1,17 @@
 import { diffLinesUnified2 } from 'jest-diff';
-import {
-    EXPECTED_COLOR,
-    matcherErrorMessage,
-    matcherHint,
-    printExpected,
-    printReceived,
-    printWithType,
-    RECEIVED_COLOR,
-} from 'jest-matcher-utils';
-import type { MatcherHintOptions } from 'jest-matcher-utils';
 
 import { bytes2DataView, BytesData, inspectSingleline, isBytesData, isNonNegativeInteger, or, padTextColumns } from '.';
 
+type MatcherUtils = jest.MatcherContext['utils'];
+export type MatcherHintOptions = Exclude<Parameters<MatcherUtils['matcherHint']>[3], undefined>;
+
 interface EnsureFuncPredicateOptions<T> {
     predicate: (value: unknown) => value is T;
     typeName: string;
 }
 
 type EnsureFunc<TActual> = (
+    utils: MatcherUtils,
     actual: unknown,
     expected: unknown,
     matcherName: string,
@@ -37,13 +31,14 @@ function printValues(valueNameList: readonly string[]): string {
  * @see https://github.com/facebook/jest/blob/v27.0.6/packages/jest-matcher-utils/src/index.ts#L218-L238
  */
 function createEnsure<T>(opts: EnsureFuncPredicateOptions<T>): EnsureFunc<T> {
-    return (actual, expected, matcherName, options) => {
+    return (utils, actual, expected, matcherName, options) => {
         const isValidActual = opts.predicate(actual);
         const isValidExpected = opts.predicate(expected);
         if (isValidActual && isValidExpected) return;
 
         const labelList: string[] = [];
         const specificList: string[] = [];
+        const { printWithType, printExpected, printReceived, EXPECTED_COLOR, RECEIVED_COLOR } = utils;
         if (!isValidActual) {
             labelList.push(RECEIVED_COLOR('received'));
             specificList.push(printWithType('Received', actual, printReceived));
@@ -53,8 +48,8 @@ function createEnsure<T>(opts: EnsureFuncPredicateOptions<T>): EnsureFunc<T> {
             specificList.push(printWithType('Expected', expected, printExpected));
         }
 
-        throw new Error(matcherErrorMessage(
-            matcherHint(matcherName, undefined, undefined, options),
+        throw new Error(utils.matcherErrorMessage(
+            utils.matcherHint(matcherName, undefined, undefined, options),
             `${printValues(labelList)} must be ${opts.typeName}`,
             specificList.join('\n\n'),
         ));
@@ -100,6 +95,7 @@ function getByteDataLines(byteData: BytesData): {
  * @see https://github.com/facebook/jest/blob/v27.0.6/packages/expect/src/matchers.ts#L955-L972
  */
 export function printBytesDiff(
+    utils: MatcherUtils,
     expected: BytesData,
     received: BytesData,
     options: {
@@ -127,9 +123,9 @@ export function printBytesDiff(
     }
 
     return padTextColumns([
-        ['Expected:', 'not', EXPECTED_COLOR(inspectSingleline(expected))],
+        ['Expected:', 'not', utils.EXPECTED_COLOR(inspectSingleline(expected))],
         expected.constructor !== received.constructor
-            ? ['Received:', '', RECEIVED_COLOR(inspectSingleline(received))]
+            ? ['Received:', '', utils.RECEIVED_COLOR(inspectSingleline(received))]
             : null,
     ]);
 }