Add Jest snaphost resolver

Author: miles170

.eslintignore

@@ -2,5 +2,5 @@
 dist/
 types/
 /test/restDocs/*.json
-/test/restDocs/results/
-/test/restDocs/snapshots/
+/test/restDocs/__tests__/
+/test/restDocs/__snapshots__/

.prettierignore

@@ -3,5 +3,5 @@
 /dist
 /test/*cache.json
 /test/restDocs/*.json
-/test/restDocs/results/
-/test/restDocs/snapshots/
+/test/restDocs/__tests__/
+/test/restDocs/__snapshots__/

bin/cspell.ts

@@ -5,6 +5,6 @@ const files = (await sh.runSh('npx -y ls-ignore --paths')).stdout
   .split('\n')
   .filter(x => x.trim() !== '')
   .filter(x => !(x.startsWith('test/restDocs') && x.endsWith('.json')))
-  .filter(x => !x.startsWith('test/restDocs/results/'))
-  .filter(x => !x.startsWith('test/restDocs/snapshots/'));
+  .filter(x => !x.startsWith('test/restDocs/__tests__/'))
+  .filter(x => !x.startsWith('test/restDocs/__snapshots__/'));
 await sh.runSh(`npx -y cspell ${files.join(' ')}`);

custom-resolver.cjs

@@ -0,0 +1,36 @@
+const path = require('path');
+var fs = require('fs');
+const restDocs = fs.realpathSync('./test/restDocs');
+
+const isChildOf = (parent, child) => {
+  const relative = path.relative(parent, child);
+  return relative && !relative.startsWith('..') && !path.isAbsolute(relative);
+};
+
+module.exports = {
+  // resolves from test to snapshot path
+  resolveSnapshotPath: (testPath, snapshotExtension) => {
+    if (isChildOf(restDocs, testPath)) {
+      return testPath.replace('__tests__', '__snapshots__') + snapshotExtension;
+    }
+    return path.join(
+      path.join(path.dirname(testPath), '__snapshots__'),
+      path.basename(testPath) + snapshotExtension
+    );
+  },
+  // resolves from snapshot to test path
+  resolveTestPath: (snapshotFilePath, snapshotExtension) => {
+    if (isChildOf(restDocs, snapshotFilePath)) {
+      return snapshotFilePath
+        .replace('__snapshots__', '__tests__')
+        .slice(0, -snapshotExtension.length);
+    }
+    return path.join(
+      path.dirname(snapshotFilePath),
+      '..',
+      path.basename(snapshotFilePath, snapshotExtension)
+    );
+  },
+  // Example test path, used for preflight consistency check of the implementation above
+  testPathForConsistencyCheck: 'some/__tests__/example.test.js',
+};

jest.config.ts

@@ -13,6 +13,8 @@ const config: JestConfigWithTsJest = {
   moduleNameMapper: {
     '^(\\.{1,2}/.*)\\.js$': '$1',
   },
+  // TODO: replace with ts after https://github.com/facebook/jest/pull/12014 is resolved
+  snapshotResolver: './custom-resolver.cjs',
   testRegex: '/test/.*(?<!\\.integration)\\.spec\\.ts$',
 };
 

test/restDocs/.gitignore

@@ -1 +1 @@
-results/
+__tests__/