feat: make jest snapshots easier to read/compare

solana-developers · Nov 9, 2023 · f011912 · f011912
1 parent 495aca4
commit f011912
Show file tree

Hide file tree

Showing 7 changed files with 5,940 additions and 1,058 deletions.
diff --git a/...anchor/src/generators/application/__snapshots__/application-anchor-generator.spec.ts.snap b/...anchor/src/generators/application/__snapshots__/application-anchor-generator.spec.ts.snap
diff --git a/packages/preset-anchor/src/generators/application/application-anchor-generator.spec.ts b/packages/preset-anchor/src/generators/application/application-anchor-generator.spec.ts
@@ -29,8 +29,7 @@ describe('application generator', () => {
 
     const config = readProjectConfiguration(tree, options.name)
     const contents = getRecursiveFileContents(tree, config.root)
-    const stringified = JSON.stringify(contents, null, 2)
-    expect(stringified).toMatchSnapshot()
+    expect(contents).toMatchSnapshot()
 
     const rootTsConfig = tree.read('tsconfig.base.json').toString()
     expect(rootTsConfig).toMatchSnapshot()

diff --git a/packages/preset-common/src/utils/get-gecursive-file-contents.ts b/packages/preset-common/src/utils/get-gecursive-file-contents.ts
@@ -2,7 +2,7 @@ import { Tree } from '@nx/devkit'
 
 export interface FileContents {
   path: string
-  content?: string
+  content?: string | string[]
   isBinary?: boolean
   children?: Record<string, FileContents>
 }
@@ -40,7 +40,7 @@ export function getRecursiveFileContents(tree: Tree, path: string, includeBinari
       contents[file] = {
         path: `${path}/${file}`,
         isBinary,
-        content: isBinary ? binaryContent : content.toString('utf-8'),
+        content: isBinary ? binaryContent : formatOutput(content.toString('utf-8')),
       }
     } else {
       contents[file] = {
@@ -52,3 +52,10 @@ export function getRecursiveFileContents(tree: Tree, path: string, includeBinari
 
   return contents
 }
+
+export function formatOutput(value: string) {
+  return value
+    .split('\n')
+    .map((line) => line.trim())
+    .filter((line) => line.length > 0)
+}
diff --git a/...set-next/src/generators/application/__snapshots__/application-next-generator.spec.ts.snap b/...set-next/src/generators/application/__snapshots__/application-next-generator.spec.ts.snap
diff --git a/packages/preset-next/src/generators/application/application-next-generator.spec.ts b/packages/preset-next/src/generators/application/application-next-generator.spec.ts
@@ -26,8 +26,7 @@ describe('application generator', () => {
       expect(anchorConfig).toBeDefined()
 
       const contents = getRecursiveFileContents(tree, '.')
-      const stringified = JSON.stringify(contents, null, 2)
-      expect(stringified).toMatchSnapshot()
+      expect(contents).toMatchSnapshot()
     })
   })