@tryghost/jest-snapshot 0.2.0 → 0.3.3

package/lib/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 SnapshotManageer {
     constructor() {
         this.registry = {};
         this.currentTest = {};
+        this.defaultSnapshotPath = '__snapshots__';
     }
 
     _getNameForSnapshot(snapshotFilename, snapshotNameTemplate) {
@@ -19,12 +22,31 @@ class SnapshotManageer {
         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 SnapshotManageer {
         });
     }
 
-    match(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 SnapshotManageer {
         });
 
         // 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();

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@tryghost/jest-snapshot",
-  "version": "0.2.0",
+  "version": "0.3.3",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/jest-snapshot",
   "author": "Ghost Foundation",
   "license": "MIT",
   "main": "index.js",
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing c8 --all --check-coverage --reporter html --reporter text-summary mocha './test/**/*.test.js'",
+    "test": "NODE_ENV=testing c8 --all --check-coverage --reporter html --reporter text-summary --reporter cobertura mocha './test/**/*.test.js'",
     "lint": "eslint . --ext .js --cache",
     "posttest": "yarn lint"
   },
@@ -20,13 +20,14 @@
   },
   "devDependencies": {
     "c8": "7.11.0",
-    "mocha": "9.2.0",
+    "mocha": "9.2.1",
     "should": "13.2.3",
     "sinon": "13.0.1"
   },
   "dependencies": {
+    "@tryghost/errors": "^1.2.3",
     "expect": "^27.5.0",
     "jest-snapshot": "^27.5.0"
   },
-  "gitHead": "1750e2bdc5b8f659a4439490c79a8c262a74e66f"
+  "gitHead": "64606b3f53d3ec8e6bf988f694d9dc4bbf5fac70"
 }