@tryghost/jest-snapshot 0.1.0 → 0.3.2

package/lib/jest-snapshot.js

@@ -1,11 +1,11 @@
 const expect = require('expect');
-const SnapshotMatcher = require('./snapshot-matcher');
-const snapshotMatcher = new SnapshotMatcher();
+const SnapshotManager = require('./snapshot-manager');
+const snapshotManager = new SnapshotManager();
 
 function matchSnapshotAssertion(properties) {
     this.params = {operator: 'to match a stored snapshot'};
 
-    const result = snapshotMatcher.matchSnapshot(this.obj, properties);
+    const result = snapshotManager.match(this.obj, properties);
 
     this.params.message = result.message();
     this.assert(result.pass.should.eql(true));
@@ -13,12 +13,12 @@ function matchSnapshotAssertion(properties) {
 
 const mochaHooks = {
     beforeAll() {
-        snapshotMatcher.resetRegistry();
+        snapshotManager.resetRegistry();
     },
     beforeEach() {
         const {currentTest} = this;
 
-        snapshotMatcher.setCurrentTest({
+        snapshotManager.setCurrentTest({
             filename: currentTest.file + '.snap',
             nameTemplate: currentTest.fullTitle()
         });
@@ -29,8 +29,7 @@ const {any, anything, stringMatching} = expect;
 
 module.exports = {
     mochaHooks,
-    snapshotMatcher,
-    matchSnapshot: snapshotMatcher.matchSnapshot,
+    snapshotManager,
     matchSnapshotAssertion,
     any,
     anything,

package/lib/{snapshot-matcher.js → snapshot-manager.js}

@@ -1,11 +1,14 @@
 const {SnapshotState, toMatchSnapshot} = require('jest-snapshot');
+const errors = require('@tryghost/errors');
 const expect = require('expect');
 const utils = require('expect/build/utils');
+const path = require('path');
 
-class SnapshotMatcher {
+class SnapshotManageer {
     constructor() {
         this.registry = {};
         this.currentTest = {};
+        this.defaultSnapshotPath = '__snapshots__';
     }
 
     _getNameForSnapshot(snapshotFilename, snapshotNameTemplate) {
@@ -19,12 +22,31 @@ class SnapshotMatcher {
         return `${snapshotNameTemplate} ${nextCounter}`;
     }
 
+    _resolveSnapshotFilePath(testFile) {
+        const parsedPath = path.parse(testFile);
+
+        parsedPath.dir = path.join(parsedPath.dir, this.defaultSnapshotPath);
+
+        return path.format(parsedPath);
+    }
+
     _getConfig() {
-        const testFile = this.currentTest.filename;
+        if (!this.currentTest.filename || !this.currentTest.nameTemplate) {
+            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?'
+            });
+        }
+
+        let testFile = this.currentTest.filename;
         const testTitle = this.currentTest.nameTemplate;
         const snapshotName = this._getNameForSnapshot(testFile, testTitle);
         const willUpdate = process.env.SNAPSHOT_UPDATE ? 'all' : 'new';
 
+        // Set full path
+        testFile = this._resolveSnapshotFilePath(testFile);
+
         return {testFile, snapshotName, willUpdate};
     }
 
@@ -44,13 +66,13 @@ class SnapshotMatcher {
         });
     }
 
-    matchSnapshot(received, properties = {}) {
+    match(received, properties = {}, hint) {
         const {testFile, snapshotName, willUpdate} = this._getConfig();
 
         const snapshotState = this.getSnapshotState(testFile, willUpdate);
         // Equals is not exposed from the internals of expect
         // This truly bananananas workaround comes from here: https://github.com/facebook/jest/issues/11867
-        let equals = () => {};
+        let equals = null;
         expect.extend({
             __capture_equals__() {
                 equals = this.equals;
@@ -67,7 +89,7 @@ class SnapshotMatcher {
         });
 
         // Execute the matcher
-        const result = matcher(received, properties);
+        const result = matcher(received, properties, hint);
 
         // Store the state of snapshot, depending on updateSnapshot value
         snapshotState.save();
@@ -76,4 +98,4 @@ class SnapshotMatcher {
     }
 }
 
-module.exports = SnapshotMatcher;
+module.exports = SnapshotManageer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/jest-snapshot",
-  "version": "0.1.0",
+  "version": "0.3.2",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/jest-snapshot",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -25,8 +25,9 @@
     "sinon": "13.0.1"
   },
   "dependencies": {
+    "@tryghost/errors": "^1.2.2",
     "expect": "^27.5.0",
     "jest-snapshot": "^27.5.0"
   },
-  "gitHead": "ba2449737cd3a66d811e34b5b28b86f5d3538396"
+  "gitHead": "e954893434fda3f8c8de1970aaaa6f6a8b297f5d"
 }