@tryghost/jest-snapshot 2.0.2 → 2.1.0

package/README.md

@@ -8,8 +8,7 @@ Tools for using jest snapshot without jest
 
 or
 
-`yarn add @tryghost/jest-snapshot`
-
+`pnpm add @tryghost/jest-snapshot`
 
 ## Purpose
 
@@ -17,29 +16,24 @@ Snapshot assertion utilities and state management for Jest-style snapshots in no
 
 ## Usage
 
-
 ## Develop
 
-This is a mono repository, managed with [lerna](https://lernajs.io/).
+This is a mono repository, managed with [Nx](https://nx.dev).
 
 Follow the instructions for the top-level repo.
-1. `git clone` this repo & `cd` into it as usual
-2. Run `yarn` to install top-level dependencies.
 
+1. `git clone` this repo & `cd` into it as usual
+2. Run `pnpm install` to install top-level dependencies.
 
 ## Run
 
-- `yarn dev`
-
+- `pnpm dev`
 
 ## Test
 
-- `yarn lint` run just eslint
-- `yarn test` run lint and tests
-
-
-
+- `pnpm lint` runs oxlint
+- `pnpm test` runs lint and tests
 
-# Copyright & License 
+# Copyright & License
 
-Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE).
+Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE).

package/lib/SnapshotManager.js

@@ -1,9 +1,9 @@
-const {SnapshotState, toMatchSnapshot, EXTENSION} = require('jest-snapshot');
+const { SnapshotState, toMatchSnapshot, EXTENSION } = require('jest-snapshot');
 const errors = require('@tryghost/errors');
 const utils = require('@jest/expect-utils');
 const assert = require('assert');
 const path = require('path');
-const {makeMessageFromMatchMessage} = require('./utils');
+const { makeMessageFromMatchMessage } = require('./utils');
 
 const DOT_EXTENSION = `.${EXTENSION}`;
 
@@ -12,12 +12,11 @@ const DOT_EXTENSION = `.${EXTENSION}`;
  * @returns {string} e.g. 'all' or 'new'
  */
 function willUpdate() {
-    const updateSnapshots = (
-        process.env.SNAPSHOT_UPDATE
-        || process.env.UPDATE_SNAPSHOT
-        || process.env.SNAPSHOTS_UPDATE
-        || process.env.UPDATE_SNAPSHOTS
-    );
+    const updateSnapshots =
+        process.env.SNAPSHOT_UPDATE ||
+        process.env.UPDATE_SNAPSHOT ||
+        process.env.SNAPSHOTS_UPDATE ||
+        process.env.UPDATE_SNAPSHOTS;
 
     return updateSnapshots ? 'all' : 'new';
 }
@@ -61,7 +60,7 @@ class SnapshotManager {
     _resolveSnapshotFilePath(testPath) {
         return path.join(
             path.join(path.dirname(testPath), this.defaultSnapshotRoot),
-            path.basename(testPath) + DOT_EXTENSION
+            path.basename(testPath) + DOT_EXTENSION,
         );
     }
 
@@ -74,17 +73,18 @@ class SnapshotManager {
         if (!this.currentTest.testPath || !this.currentTest.testTitle) {
             throw new errors.IncorrectUsageError({
                 message: 'Unable to run snapshot tests, current test was not configured',
-                context: 'Snapshot testing requires current test filename and nameTemplate to be set for each test',
-                help: 'Did you forget to do export.mochaHooks?'
+                context:
+                    'Snapshot testing requires current test filename and nameTemplate to be set for each test',
+                help: 'Did you forget to do export.mochaHooks?',
             });
         }
 
-        const {testPath, testTitle} = this.currentTest;
+        const { testPath, testTitle } = this.currentTest;
 
         const snapshotName = this._getNameForSnapshot(testPath, testTitle);
         const snapshotPath = this._resolveSnapshotFilePath(testPath);
 
-        return {snapshotPath, snapshotName};
+        return { snapshotPath, snapshotName };
     }
 
     /**
@@ -98,7 +98,7 @@ class SnapshotManager {
      * Resets the registry for the current test only
      */
     resetRegistryForCurrentTest() {
-        const {testPath, testTitle} = this.currentTest;
+        const { testPath, testTitle } = this.currentTest;
         if (testPath in this.registry && testTitle in this.registry[testPath]) {
             delete this.registry[testPath][testTitle];
         }
@@ -122,7 +122,7 @@ class SnapshotManager {
         // Initialize the SnapshotState, it’s responsible for actually matching
         // actual snapshot with expected one and storing results
         return new SnapshotState(snapshotPath, {
-            updateSnapshot: this.willUpdate
+            updateSnapshot: this.willUpdate,
         });
     }
 
@@ -134,7 +134,7 @@ class SnapshotManager {
      * @param {{properties: Object, field: string, error: Object, hint: string}} assertion
      */
     assertSnapshot(response, assertion) {
-        const {properties, field, error} = assertion;
+        const { properties, field, error } = assertion;
 
         if (!response[field]) {
             error.message = `Unable to match snapshot on undefined field ${field} ${error.contextString}`;
@@ -181,7 +181,7 @@ class SnapshotManager {
      * @returns {Object} result of the match
      */
     match(received, properties = {}, hint) {
-        const {snapshotPath, snapshotName} = this._getConfig();
+        const { snapshotPath, snapshotName } = this._getConfig();
 
         const snapshotState = this.getSnapshotState(snapshotPath);
 
@@ -189,7 +189,7 @@ class SnapshotManager {
             snapshotState,
             currentTestName: snapshotName,
             utils,
-            equals: utils.equals
+            equals: utils.equals,
         });
 
         // Execute the matcher

package/lib/jest-snapshot.js

@@ -1,9 +1,9 @@
-const {jestExpect} = require('@jest/expect');
+const { jestExpect } = require('@jest/expect');
 const SnapshotManager = require('./SnapshotManager');
 const snapshotManager = new SnapshotManager();
 
 function matchSnapshotAssertion(properties) {
-    this.params = {operator: 'to match a stored snapshot'};
+    this.params = { operator: 'to match a stored snapshot' };
 
     const result = snapshotManager.match(this.obj, properties);
 
@@ -12,7 +12,6 @@ function matchSnapshotAssertion(properties) {
 }
 
 const mochaHooks = {
-
     /**
      * Runs before all tests
      * Resets the registry so we start with a clean slate
@@ -27,7 +26,7 @@ const mochaHooks = {
      * If we're running a retry, reset the registry for this test only
      */
     beforeEach() {
-        const {currentTest} = this;
+        const { currentTest } = this;
 
         if (currentTest.currentRetry() > 0) {
             // Reset registry for this test only
@@ -36,12 +35,12 @@ const mochaHooks = {
 
         snapshotManager.setCurrentTest({
             testPath: currentTest.file,
-            testTitle: currentTest.fullTitle()
+            testTitle: currentTest.fullTitle(),
         });
-    }
+    },
 };
 
-const {any, anything, stringMatching} = jestExpect;
+const { any, anything, stringMatching } = jestExpect;
 
 module.exports = {
     mochaHooks,
@@ -49,5 +48,5 @@ module.exports = {
     matchSnapshotAssertion,
     any,
     anything,
-    stringMatching
+    stringMatching,
 };

package/lib/utils.js

@@ -4,7 +4,10 @@
  * @param {String} errorMessage
  * @returns {String}
  */
-module.exports.makeMessageFromMatchMessage = function makeMessageFromMatchMessage(message, errorMessage) {
+module.exports.makeMessageFromMatchMessage = function makeMessageFromMatchMessage(
+    message,
+    errorMessage,
+) {
     const messageLines = message.split('\n');
     messageLines.splice(0, 1, errorMessage);
     return messageLines.join('\n');

package/package.json

@@ -1,34 +1,34 @@
 {
   "name": "@tryghost/jest-snapshot",
-  "version": "2.0.2",
+  "version": "2.1.0",
+  "license": "MIT",
+  "author": "Ghost Foundation",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TryGhost/framework.git",
     "directory": "packages/jest-snapshot"
   },
-  "author": "Ghost Foundation",
-  "license": "MIT",
-  "main": "index.js",
-  "scripts": {
-    "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing vitest run --coverage --config ../../vitest.config.ts",
-    "lint": "eslint . --ext .js --cache",
-    "posttest": "yarn lint"
-  },
   "files": [
     "index.js",
     "lib"
   ],
+  "main": "index.js",
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@jest/expect": "30.3.0",
+    "@jest/expect-utils": "30.3.0",
+    "jest-snapshot": "30.3.0",
+    "@tryghost/errors": "3.1.0"
+  },
   "devDependencies": {
-    "sinon": "21.0.2"
+    "sinon": "21.1.2"
   },
-  "dependencies": {
-    "@jest/expect": "30.2.0",
-    "@jest/expect-utils": "30.2.0",
-    "@tryghost/errors": "^3.0.2",
-    "jest-snapshot": "30.2.0"
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing vitest run --coverage --config ../../vitest.config.ts",
+    "lint": "oxlint -c ../../.oxlintrc.json .",
+    "posttest": "pnpm run lint"
   }
-}
+}