snap-shot-core - npm Package Compare versions

Comparing version 2.0.0 to 3.0.0

package.json

 {
   "name": "snap-shot-core",
   "description": "Save / load named snapshots, useful for tests",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "author": "Gleb Bahmutov <[e-mail]>",
@@ -87,2 +87,3 @@ "bugs": "https://github.com/bahmutov/snap-shot-core/issues",
     "deps-ok": "1.2.1",
+    "disparity": "2.0.0",
     "dont-crack": "1.2.1",
@@ -89,0 +90,0 @@ "git-issues": "1.3.1",

README.md

@@ -54,2 +54,6 @@ # snap-shot-core
 
+Note: by default multi line text is saves using ES6 template string, while
+everything else is saved using normal serialization using
+[jsesc](https://github.com/mathiasbynens/jsesc).
+
 ## Compare function
@@ -85,5 +89,7 @@
 Note input is an object `{expected, value}` and if there is a difference
-you should describe it as a string `Result.Error(<difference string>)`
+you should describe it as a string `Result.Error(<difference string>)`.
+Why does it return a `Result`? Because it makes [life easier][result post].
 
 [result]: http://folktale.origamitower.com/api/v2.0.0/en/folktale.result.html
+[result post]: https://glebbahmutov.com/blog/use-a-little-bit-of-fp/#result-either-for-utility-functions
 
@@ -90,0 +96,0 @@ ## Raise function

src/file-system.js

@@ -66,2 +66,17 @@ 'use strict'
 
+function exportText (name, value) {
+  la(is.unemptyString(name), 'expected name', name)
+  la(is.unemptyString(value), 'expected string value', value)
+  return `exports['${name}'] = \`${value}\`\n\n`
+}
+
+function exportObject (name, value) {
+  const serialized = jsesc(value, {
+    json: true,
+    compact: false,
+    indent: '  '
+  })
+  return `exports['${name}'] = ${serialized}\n\n`
+}
+
 function saveSnapshots (specFile, snapshots, ext) {
@@ -77,8 +92,8 @@ mkdirp.sync(snapshotsFolder)
     const value = snapshots[testName]
-    const serialized = jsesc(value, {
-      json: true,
-      compact: false,
-      indent: '  '
-    })
-    s += `exports['${escapeQuotes(testName)}'] = ${serialized}\n\n`
+    const escapedName = escapeQuotes(testName)
+    if (is.string(value)) {
+      s += exportText(escapedName, value)
+    } else {
+      s += exportObject(escapedName, value)
+    }
   })
@@ -85,0 +100,0 @@ fs.writeFileSync(filename, s, 'utf8')

No alert changes

Improved metrics

Total package byte prevSize

25512

3.18%

Lines of code

480

2.78%

Number of lines in readme file

236

2.61%

Worsened metrics

Dev dependency count

16

6.67%

No dependency changes