@procore/hammer-test-jest 0.3.0 → 0.4.0

package/README.md

@@ -38,10 +38,13 @@ This project uses [`yarn`][yarn], and supports the following commands:
 - `clean`: deletes the output directory and any built files.
 - `format`: runs [`prettier`][prettier] on the project.
 - `format:check`: uses [`prettier`][prettier] to validate code format.
+- `lint:code`: uses [`eslint`][eslint] to lint code.
+- `lint:types`: uses [`TypeScript`][typescript] to validate types.
 - `test`: runs the unit test suite.
 - `test:ci`: run the unit test suite, reporting coverage.
 
+[eslint]: https://eslint.org/
 [jest]: https://jestjs.io/
 [prettier]: https://prettier.io/
-[tsup]: https://tsup.egoist.dev/
+[typescript]: https://www.typescriptlang.org/
 [yarn]: https://classic.yarnpkg.com/

package/dist/index.d.mts

@@ -1,19 +1,10 @@
-import { Config } from 'jest';
+import * as _procore_hammer_types from '@procore/hammer-types';
 
-type OverrideFn = (config: Config) => Config;
-type PluginOptions = {
-    watch?: boolean;
-    W?: boolean;
-    coverage?: boolean;
-    ci?: boolean;
-    silent?: boolean;
-    config: {
-        testJest?: OverrideFn;
-    };
-    rootDir: string;
-};
+declare const test: (rootDir: string, config: _procore_hammer_types.HammerConfig, options: {
+    watch: boolean;
+    coverage: boolean;
+    ci: boolean;
+    silent: boolean;
+}) => Promise<void>;
 
-declare function test(options: PluginOptions): Promise<void>;
-declare function inspect(options: PluginOptions): Promise<void>;
-
-export { inspect, test };
+export { test };

package/dist/index.d.ts

@@ -1,19 +1,10 @@
-import { Config } from 'jest';
+import * as _procore_hammer_types from '@procore/hammer-types';
 
-type OverrideFn = (config: Config) => Config;
-type PluginOptions = {
-    watch?: boolean;
-    W?: boolean;
-    coverage?: boolean;
-    ci?: boolean;
-    silent?: boolean;
-    config: {
-        testJest?: OverrideFn;
-    };
-    rootDir: string;
-};
+declare const test: (rootDir: string, config: _procore_hammer_types.HammerConfig, options: {
+    watch: boolean;
+    coverage: boolean;
+    ci: boolean;
+    silent: boolean;
+}) => Promise<void>;
 
-declare function test(options: PluginOptions): Promise<void>;
-declare function inspect(options: PluginOptions): Promise<void>;
-
-export { inspect, test };
+export { test };

package/dist/index.js

@@ -30,7 +30,6 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  inspect: () => inspect,
   test: () => test
 });
 module.exports = __toCommonJS(src_exports);
@@ -39,8 +38,8 @@ module.exports = __toCommonJS(src_exports);
 var getImportMetaUrl = () => typeof document === "undefined" ? new URL("file:" + __filename).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
 var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
 
-// src/index.ts
-var import_node_process = __toESM(require("process"));
+// src/performTest.ts
+var jest = __toESM(require("jest-cli"));
 
 // src/config/utils.ts
 var import_fs2 = __toESM(require("fs"));
@@ -194,26 +193,9 @@ function getConfig(options) {
   return options.config.testJest ? options.config.testJest(config) : config;
 }
 
-// src/utils/terminal.ts
-var import_cli_highlight = require("cli-highlight");
-function toHighlightedString(input) {
-  const inputAsString = JSON.stringify(
-    input,
-    function(_key, value) {
-      return typeof value === "function" ? value.toString() : value;
-    },
-    2
-  );
-  return (0, import_cli_highlight.highlight)(inputAsString, { language: "js" });
-}
-
-// src/performTest.ts
-var jest = __toESM(require("jest-cli"));
-
 // src/utils/argvForJest.ts
 var allowedFlags = [
   "watch",
-  "W",
   "coverage",
   "ci",
   "silent"
@@ -235,17 +217,12 @@ async function performTest(options) {
 }
 
 // src/index.ts
-async function test(options) {
-  await performTest(options);
-}
-async function inspect(options) {
-  const highlightedConfig = toHighlightedString(getConfig(options));
-  import_node_process.default.stdout.write(`
-${highlightedConfig}
-`);
-}
+var { test } = {
+  test: async function test2(rootDir, config, options) {
+    await performTest({ ...options, rootDir, config });
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  inspect,
   test
 });

package/dist/index.mjs

@@ -1,5 +1,5 @@
-// src/index.ts
-import process from "node:process";
+// src/performTest.ts
+import * as jest from "jest-cli";
 
 // src/config/utils.ts
 import fs2 from "fs";
@@ -153,26 +153,9 @@ function getConfig(options) {
   return options.config.testJest ? options.config.testJest(config) : config;
 }
 
-// src/utils/terminal.ts
-import { highlight } from "cli-highlight";
-function toHighlightedString(input) {
-  const inputAsString = JSON.stringify(
-    input,
-    function(_key, value) {
-      return typeof value === "function" ? value.toString() : value;
-    },
-    2
-  );
-  return highlight(inputAsString, { language: "js" });
-}
-
-// src/performTest.ts
-import * as jest from "jest-cli";
-
 // src/utils/argvForJest.ts
 var allowedFlags = [
   "watch",
-  "W",
   "coverage",
   "ci",
   "silent"
@@ -194,16 +177,11 @@ async function performTest(options) {
 }
 
 // src/index.ts
-async function test(options) {
-  await performTest(options);
-}
-async function inspect(options) {
-  const highlightedConfig = toHighlightedString(getConfig(options));
-  process.stdout.write(`
-${highlightedConfig}
-`);
-}
+var { test } = {
+  test: async function test2(rootDir, config, options) {
+    await performTest({ ...options, rootDir, config });
+  }
+};
 export {
-  inspect,
   test
 };

package/dist/transforms/file.test.js

@@ -7777,7 +7777,14 @@ function clone(val, seen, options = defaultCloneOptions) {
       if (!descriptor)
         continue;
       const cloned = clone(val[k22], seen, options);
-      if ("get" in descriptor) {
+      if (options.forceWritable) {
+        Object.defineProperty(out, k22, {
+          enumerable: descriptor.enumerable,
+          configurable: true,
+          writable: true,
+          value: cloned
+        });
+      } else if ("get" in descriptor) {
         Object.defineProperty(out, k22, {
           ...descriptor,
           get() {
@@ -7787,7 +7794,6 @@ function clone(val, seen, options = defaultCloneOptions) {
       } else {
         Object.defineProperty(out, k22, {
           ...descriptor,
-          writable: options.forceWritable ? true : descriptor.writable,
           value: cloned
         });
       }
@@ -7949,7 +7955,7 @@ function objDisplay(obj, options = {}) {
   if (options.truncate && str.length >= options.truncate) {
     if (type2 === "[object Function]") {
       const fn2 = obj;
-      return !fn2.name || fn2.name === "" ? "[Function]" : `[Function: ${fn2.name}]`;
+      return !fn2.name ? "[Function]" : `[Function: ${fn2.name}]`;
     } else if (type2 === "[object Array]") {
       return `[ Array(${obj.length}) ]`;
     } else if (type2 === "[object Object]") {
@@ -8389,6 +8395,7 @@ function joinAlignedDiffsExpand(diffs, options) {
 }
 var noColor = (string3) => string3;
 var DIFF_CONTEXT_DEFAULT = 5;
+var DIFF_TRUNCATE_THRESHOLD_DEFAULT = 0;
 function getDefaultOptions() {
   const c2 = getColors();
   return {
@@ -8409,7 +8416,10 @@ function getDefaultOptions() {
     expand: true,
     includeChangeCounts: false,
     omitAnnotationLines: false,
-    patchColor: c2.yellow
+    patchColor: c2.yellow,
+    truncateThreshold: DIFF_TRUNCATE_THRESHOLD_DEFAULT,
+    truncateAnnotation: "... Diff result is truncated",
+    truncateAnnotationColor: noColor
   };
 }
 function getCompareKeys(compareKeys) {
@@ -8477,16 +8487,21 @@ ${bColor(b2)}
 
 `;
 }
-function printDiffLines(diffs, options) {
-  return printAnnotation(options, countChanges(diffs)) + (options.expand ? joinAlignedDiffsExpand(diffs, options) : joinAlignedDiffsNoExpand(diffs, options));
+function printDiffLines(diffs, truncated, options) {
+  return printAnnotation(options, countChanges(diffs)) + (options.expand ? joinAlignedDiffsExpand(diffs, options) : joinAlignedDiffsNoExpand(diffs, options)) + (truncated ? options.truncateAnnotationColor(`
+${options.truncateAnnotation}`) : "");
 }
 function diffLinesUnified(aLines, bLines, options) {
+  const normalizedOptions = normalizeDiffOptions(options);
+  const [diffs, truncated] = diffLinesRaw(
+    isEmptyString(aLines) ? [] : aLines,
+    isEmptyString(bLines) ? [] : bLines,
+    normalizedOptions
+  );
   return printDiffLines(
-    diffLinesRaw(
-      isEmptyString(aLines) ? [] : aLines,
-      isEmptyString(bLines) ? [] : bLines
-    ),
-    normalizeDiffOptions(options)
+    diffs,
+    truncated,
+    normalizedOptions
   );
 }
 function diffLinesUnified2(aLinesDisplay, bLinesDisplay, aLinesCompare, bLinesCompare, options) {
@@ -8501,7 +8516,7 @@ function diffLinesUnified2(aLinesDisplay, bLinesDisplay, aLinesCompare, bLinesCo
   if (aLinesDisplay.length !== aLinesCompare.length || bLinesDisplay.length !== bLinesCompare.length) {
     return diffLinesUnified(aLinesDisplay, bLinesDisplay, options);
   }
-  const diffs = diffLinesRaw(aLinesCompare, bLinesCompare);
+  const [diffs, truncated] = diffLinesRaw(aLinesCompare, bLinesCompare, options);
   let aIndex = 0;
   let bIndex = 0;
   diffs.forEach((diff2) => {
@@ -8520,11 +8535,14 @@ function diffLinesUnified2(aLinesDisplay, bLinesDisplay, aLinesCompare, bLinesCo
         bIndex += 1;
     }
   });
-  return printDiffLines(diffs, normalizeDiffOptions(options));
-}
-function diffLinesRaw(aLines, bLines) {
-  const aLength = aLines.length;
-  const bLength = bLines.length;
+  return printDiffLines(diffs, truncated, normalizeDiffOptions(options));
+}
+function diffLinesRaw(aLines, bLines, options) {
+  const truncate2 = (options == null ? void 0 : options.truncateThreshold) ?? false;
+  const truncateThreshold = Math.max(Math.floor((options == null ? void 0 : options.truncateThreshold) ?? 0), 0);
+  const aLength = truncate2 ? Math.min(aLines.length, truncateThreshold) : aLines.length;
+  const bLength = truncate2 ? Math.min(bLines.length, truncateThreshold) : bLines.length;
+  const truncated = aLength !== aLines.length || bLength !== bLines.length;
   const isCommon = (aIndex2, bIndex2) => aLines[aIndex2] === bLines[bIndex2];
   const diffs = [];
   let aIndex = 0;
@@ -8543,7 +8561,7 @@ function diffLinesRaw(aLines, bLines) {
     diffs.push(new Diff(DIFF_DELETE, aLines[aIndex]));
   for (; bIndex !== bLength; bIndex += 1)
     diffs.push(new Diff(DIFF_INSERT, bLines[bIndex]));
-  return diffs;
+  return [diffs, truncated];
 }
 function getCommonMessage(message, options) {
   const { commonColor } = normalizeDiffOptions(options);
@@ -9733,10 +9751,10 @@ function createSuiteCollector(name, factory = () => {
     }
     if (runner.config.includeTaskLocation) {
       const limit = Error.stackTraceLimit;
-      Error.stackTraceLimit = 10;
+      Error.stackTraceLimit = 15;
       const error = new Error("stacktrace").stack;
       Error.stackTraceLimit = limit;
-      const stack = findStackTrace(error, task2.each ?? false);
+      const stack = findTestFileStackTrace(error, task2.each ?? false);
       if (stack)
         task2.location = stack;
     }
@@ -9789,18 +9807,12 @@ function createSuiteCollector(name, factory = () => {
     };
     if (runner && includeLocation && runner.config.includeTaskLocation) {
       const limit = Error.stackTraceLimit;
-      Error.stackTraceLimit = 5;
+      Error.stackTraceLimit = 15;
       const error = new Error("stacktrace").stack;
       Error.stackTraceLimit = limit;
-      const stack = parseSingleStack(error.split("\n")[5]);
-      if (stack) {
-        suite2.location = {
-          line: stack.line,
-          // because source map is boundary based, this line leads to ")" in test.each()[(]),
-          // but it should be the next opening bracket - here we assume it's on the same line
-          column: each ? stack.column + 1 : stack.column
-        };
-      }
+      const stack = findTestFileStackTrace(error, suite2.each ?? false);
+      if (stack)
+        suite2.location = stack;
     }
     setHooks(suite2, createSuiteHooks());
   }
@@ -9944,8 +9956,8 @@ function formatTemplateString(cases, args) {
   }
   return res;
 }
-function findStackTrace(error, each) {
-  const lines = error.split("\n").slice(4);
+function findTestFileStackTrace(error, each) {
+  const lines = error.split("\n").slice(1);
   for (const line of lines) {
     const stack = parseSingleStack(line);
     if (stack && stack.file === getTestFilepath()) {
@@ -10084,7 +10096,7 @@ function isFirstRun() {
   return firstRun;
 }
 
-// ../../node_modules/vitest/dist/vendor/vi.JYQecGiw.js
+// ../../node_modules/vitest/dist/vendor/vi.Y_w82WR8.js
 init_cjs_shims();
 
 // ../../node_modules/chai/index.mjs
@@ -10612,7 +10624,7 @@ function iterableEquality(a, b2, customTesters = [], aStack = [], bStack = []) {
     return iterableEquality(
       a2,
       b22,
-      [...filteredCustomTesters],
+      [...customTesters],
       [...aStack],
       [...bStack]
     );
@@ -10690,7 +10702,7 @@ function subsetEquality(object2, subset, customTesters = []) {
     if (!isObjectWithKeys(subset2))
       return void 0;
     return Object.keys(subset2).every((key) => {
-      if (isObjectWithKeys(subset2[key])) {
+      if (typeof subset2[key] === "object") {
         if (seenReferences.has(subset2[key]))
           return equals(object22[key], subset2[key], filteredCustomTesters);
         seenReferences.set(subset2[key], true);
@@ -10754,6 +10766,57 @@ Received: serializes to the same string
 function pluralize(word, count) {
   return `${count} ${word}${count === 1 ? "" : "s"}`;
 }
+function getObjectKeys(object2) {
+  return [
+    ...Object.keys(object2),
+    ...Object.getOwnPropertySymbols(object2).filter(
+      (s) => {
+        var _a2;
+        return (_a2 = Object.getOwnPropertyDescriptor(object2, s)) == null ? void 0 : _a2.enumerable;
+      }
+    )
+  ];
+}
+function getObjectSubset(object2, subset, customTesters = []) {
+  let stripped = 0;
+  const getObjectSubsetWithContext = (seenReferences = /* @__PURE__ */ new WeakMap()) => (object22, subset2) => {
+    if (Array.isArray(object22)) {
+      if (Array.isArray(subset2) && subset2.length === object22.length) {
+        return subset2.map(
+          (sub, i2) => getObjectSubsetWithContext(seenReferences)(object22[i2], sub)
+        );
+      }
+    } else if (object22 instanceof Date) {
+      return object22;
+    } else if (isObject(object22) && isObject(subset2)) {
+      if (equals(object22, subset2, [
+        ...customTesters,
+        iterableEquality,
+        subsetEquality
+      ])) {
+        return subset2;
+      }
+      const trimmed = {};
+      seenReferences.set(object22, trimmed);
+      for (const key of getObjectKeys(object22)) {
+        if (hasPropertyInObject(subset2, key)) {
+          trimmed[key] = seenReferences.has(object22[key]) ? seenReferences.get(object22[key]) : getObjectSubsetWithContext(seenReferences)(object22[key], subset2[key]);
+        } else {
+          if (!seenReferences.has(object22[key])) {
+            stripped += 1;
+            if (isObject(object22[key]))
+              stripped += getObjectKeys(object22[key]).length;
+            getObjectSubsetWithContext(seenReferences)(object22[key], subset2[key]);
+          }
+        }
+      }
+      if (getObjectKeys(trimmed).length > 0)
+        return trimmed;
+    }
+    return object22;
+  };
+  return { subset: getObjectSubsetWithContext()(object2, subset), stripped };
+}
 var AsymmetricMatcher3 = class {
   constructor(sample, inverse = false) {
     this.sample = sample;
@@ -11181,16 +11244,30 @@ var JestChaiExpect = (chai3, utils) => {
   });
   def("toMatchObject", function(expected) {
     const actual = this._obj;
-    return this.assert(
-      equals(actual, expected, [...customTesters, iterableEquality, subsetEquality]),
-      "expected #{this} to match object #{exp}",
-      "expected #{this} to not match object #{exp}",
-      expected,
-      actual
-    );
+    const pass = equals(actual, expected, [...customTesters, iterableEquality, subsetEquality]);
+    const isNot = utils.flag(this, "negate");
+    const { subset: actualSubset, stripped } = getObjectSubset(actual, expected);
+    if (pass && isNot || !pass && !isNot) {
+      const msg = utils.getMessage(
+        this,
+        [
+          pass,
+          "expected #{this} to match object #{exp}",
+          "expected #{this} to not match object #{exp}",
+          expected,
+          actualSubset,
+          false
+        ]
+      );
+      const message = stripped === 0 ? msg : `${msg}
+(${stripped} matching ${stripped === 1 ? "property" : "properties"} omitted from actual)`;
+      throw new AssertionError2(message, { showDiff: true, expected, actual: actualSubset });
+    }
   });
   def("toMatch", function(expected) {
     const actual = this._obj;
+    if (typeof actual !== "string")
+      throw new TypeError(`.toMatch() expects to receive a string, but got ${typeof actual}`);
     return this.assert(
       typeof expected === "string" ? actual.includes(expected) : actual.match(expected),
       `expected #{this} to match #{exp}`,
@@ -11532,12 +11609,15 @@ Number of calls: ${c2().bold(spy.mock.calls.length)}
     const spy = getSpy(this);
     const spyName = spy.getMockName();
     const nthCall = spy.mock.calls[times - 1];
+    const callCount = spy.mock.calls.length;
+    const isCalled = times <= callCount;
     this.assert(
       equals(nthCall, args, [...customTesters, iterableEquality]),
-      `expected ${ordinalOf(times)} "${spyName}" call to have been called with #{exp}`,
+      `expected ${ordinalOf(times)} "${spyName}" call to have been called with #{exp}${isCalled ? `` : `, but called only ${callCount} times`}`,
       `expected ${ordinalOf(times)} "${spyName}" call to not have been called with #{exp}`,
       args,
-      nthCall
+      nthCall,
+      isCalled
     );
   });
   def(["toHaveBeenLastCalledWith", "lastCalledWith"], function(...args) {
@@ -13308,7 +13388,7 @@ function resetDate() {
   globalThis.Date = RealDate;
 }
 
-// ../../node_modules/vitest/dist/vendor/vi.JYQecGiw.js
+// ../../node_modules/vitest/dist/vendor/vi.Y_w82WR8.js
 function resetModules(modules, resetMocks = false) {
   const skipPaths = [
     // Vitest
@@ -15433,12 +15513,14 @@ function createVitest() {
   let _mockedDate = null;
   let _config = null;
   const workerState = getWorkerState();
-  const _timers = new FakeTimers({
+  let _timers;
+  const timers = () => _timers || (_timers = new FakeTimers({
     global: globalThis,
     config: workerState.config.fakeTimers
-  });
+  }));
   const _stubsGlobal = /* @__PURE__ */ new Map();
   const _stubsEnv = /* @__PURE__ */ new Map();
+  const _envBooleans = ["PROD", "DEV", "SSR"];
   const getImporter = () => {
     const stackTrace = createSimpleStackTrace({ stackTraceLimit: 4 });
     const importerStack = stackTrace.split("\n")[4];
@@ -15456,73 +15538,73 @@ function createVitest() {
         }
       }
       if (config2)
-        _timers.configure({ ...workerState.config.fakeTimers, ...config2 });
+        timers().configure({ ...workerState.config.fakeTimers, ...config2 });
       else
-        _timers.configure(workerState.config.fakeTimers);
-      _timers.useFakeTimers();
+        timers().configure(workerState.config.fakeTimers);
+      timers().useFakeTimers();
       return utils;
     },
     isFakeTimers() {
-      return _timers.isFakeTimers();
+      return timers().isFakeTimers();
     },
     useRealTimers() {
-      _timers.useRealTimers();
+      timers().useRealTimers();
       _mockedDate = null;
       return utils;
     },
     runOnlyPendingTimers() {
-      _timers.runOnlyPendingTimers();
+      timers().runOnlyPendingTimers();
       return utils;
     },
     async runOnlyPendingTimersAsync() {
-      await _timers.runOnlyPendingTimersAsync();
+      await timers().runOnlyPendingTimersAsync();
       return utils;
     },
     runAllTimers() {
-      _timers.runAllTimers();
+      timers().runAllTimers();
       return utils;
     },
     async runAllTimersAsync() {
-      await _timers.runAllTimersAsync();
+      await timers().runAllTimersAsync();
       return utils;
     },
     runAllTicks() {
-      _timers.runAllTicks();
+      timers().runAllTicks();
       return utils;
     },
     advanceTimersByTime(ms) {
-      _timers.advanceTimersByTime(ms);
+      timers().advanceTimersByTime(ms);
       return utils;
     },
     async advanceTimersByTimeAsync(ms) {
-      await _timers.advanceTimersByTimeAsync(ms);
+      await timers().advanceTimersByTimeAsync(ms);
       return utils;
     },
     advanceTimersToNextTimer() {
-      _timers.advanceTimersToNextTimer();
+      timers().advanceTimersToNextTimer();
       return utils;
     },
     async advanceTimersToNextTimerAsync() {
-      await _timers.advanceTimersToNextTimerAsync();
+      await timers().advanceTimersToNextTimerAsync();
       return utils;
     },
     getTimerCount() {
-      return _timers.getTimerCount();
+      return timers().getTimerCount();
     },
     setSystemTime(time) {
       const date = time instanceof Date ? time : new Date(time);
       _mockedDate = date;
-      _timers.setSystemTime(date);
+      timers().setSystemTime(date);
       return utils;
     },
     getMockedSystemTime() {
       return _mockedDate;
     },
     getRealSystemTime() {
-      return _timers.getRealSystemTime();
+      return timers().getRealSystemTime();
     },
     clearAllTimers() {
-      _timers.clearAllTimers();
+      timers().clearAllTimers();
       return utils;
     },
     // mocks
@@ -15601,7 +15683,10 @@ function createVitest() {
     stubEnv(name, value) {
       if (!_stubsEnv.has(name))
         _stubsEnv.set(name, process.env[name]);
-      process.env[name] = value;
+      if (_envBooleans.includes(name))
+        process.env[name] = value ? "1" : "";
+      else
+        process.env[name] = String(value);
       return utils;
     },
     unstubAllGlobals() {
@@ -15646,7 +15731,7 @@ function createVitest() {
 var vitest = createVitest();
 var vi = vitest;
 
-// ../../node_modules/vitest/dist/vendor/index.BeX1oZht.js
+// ../../node_modules/vitest/dist/vendor/index.0RrMQKD8.js
 init_cjs_shims();
 function getRunningMode() {
   return process.env.VITEST_MODE === "WATCH" ? "watch" : "run";