From 3cfae384011a8b291cc82cc02b56bc114557a9e5 Mon Sep 17 00:00:00 2001
From: Jordan Harband <ljharb@gmail.com>
Date: Thu, 6 Jan 2022 11:12:25 -0800
Subject: [PATCH] [arborist] [refactor] `Shrinkwrap`: add `toJSON`/`toString`
 methods to get shrinkwrap contents without saving (#4181)

---
 workspaces/arborist/lib/shrinkwrap.js         | 19 +++++++++++++++----
 .../tap-snapshots/test/shrinkwrap.js.test.cjs | 19 +++++++++++++++++++
 workspaces/arborist/test/shrinkwrap.js        | 19 +++++++++++++++++++
 3 files changed, 53 insertions(+), 4 deletions(-)

diff --git a/workspaces/arborist/lib/shrinkwrap.js b/workspaces/arborist/lib/shrinkwrap.js
index 2f0c0877cf8e0..a7a68c98c6d6d 100644
--- a/workspaces/arborist/lib/shrinkwrap.js
+++ b/workspaces/arborist/lib/shrinkwrap.js
@@ -1085,18 +1085,29 @@ class Shrinkwrap {
     return lock
   }
 
-  save (options = {}) {
+  toJSON () {
     if (!this.data) {
-      throw new Error('run load() before saving data')
+      throw new Error('run load() before getting or setting data')
     }
 
+    return this.commit()
+  }
+
+  toString (options = {}) {
+    const data = this.toJSON()
     const { format = true } = options
     const defaultIndent = this.indent || 2
     const indent = format === true ? defaultIndent
       : format || 0
     const eol = format ? this.newline || '\n' : ''
-    const data = this.commit()
-    const json = stringify(data, swKeyOrder, indent).replace(/\n/g, eol)
+    return stringify(data, swKeyOrder, indent).replace(/\n/g, eol)
+  }
+
+  save (options = {}) {
+    if (!this.data) {
+      throw new Error('run load() before saving data')
+    }
+    const json = this.toString(options)
     return Promise.all([
       writeFile(this.filename, json).catch(er => {
         if (this.hiddenLockfile) {
diff --git a/workspaces/arborist/tap-snapshots/test/shrinkwrap.js.test.cjs b/workspaces/arborist/tap-snapshots/test/shrinkwrap.js.test.cjs
index 39b1d97ecce65..93f6e8a89b59b 100644
--- a/workspaces/arborist/tap-snapshots/test/shrinkwrap.js.test.cjs
+++ b/workspaces/arborist/tap-snapshots/test/shrinkwrap.js.test.cjs
@@ -14240,6 +14240,25 @@ exports[`test/shrinkwrap.js TAP saving dependency-free shrinkwrap object load fi
 
 `
 
+exports[`test/shrinkwrap.js TAP saving dependency-free shrinkwrap object load the unindented file, and generate expected contents > indented json object output 1`] = `
+Object {
+  "dependencies": Object {},
+  "lockfileVersion": 2,
+  "packages": Object {},
+  "requires": true,
+}
+`
+
+exports[`test/shrinkwrap.js TAP saving dependency-free shrinkwrap object load the unindented file, and generate expected contents > indented json string output 1`] = `
+{
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {},
+  "dependencies": {}
+}
+
+`
+
 exports[`test/shrinkwrap.js TAP saving dependency-free shrinkwrap object load the unindented file, and save it back default > indented json output 1`] = `
 {
   "lockfileVersion": 2,
diff --git a/workspaces/arborist/test/shrinkwrap.js b/workspaces/arborist/test/shrinkwrap.js
index 2bf43fcf97e1c..f752c724a35e7 100644
--- a/workspaces/arborist/test/shrinkwrap.js
+++ b/workspaces/arborist/test/shrinkwrap.js
@@ -222,6 +222,10 @@ t.test('throws when attempting to access data before loading', t => {
     new Shrinkwrap().delete(), Error('run load() before getting or setting data'))
   t.throws(() =>
     new Shrinkwrap().add(), Error('run load() before getting or setting data'))
+  t.throws(() =>
+    new Shrinkwrap().toJSON(), Error('run load() before getting or setting data'))
+  t.throws(() =>
+    new Shrinkwrap().toString(), Error('run load() before getting or setting data'))
   t.throws(() =>
     new Shrinkwrap().save(), Error('run load() before saving data'))
   t.end()
@@ -481,6 +485,21 @@ t.test('saving dependency-free shrinkwrap object', t => {
     t.matchSnapshot(fs.readFileSync(sw.filename, 'utf8'), 'no indent json output')
   })
 
+  t.test('load the unindented file, and generate expected contents', async t => {
+    const sw = await Shrinkwrap.load({ path: dir })
+    t.equal(
+      sw.filename,
+      resolve(`${dir}/package-lock.json`),
+      'correct filepath on shrinkwrap instance'
+    )
+    t.equal(sw.indent, '')
+    const json = await sw.toJSON()
+    t.matchSnapshot(json, 'indented json object output')
+
+    const jsonString = await sw.toString()
+    t.matchSnapshot(jsonString, 'indented json string output')
+  })
+
   t.test('load the unindented file, and save it back default', async t => {
     const sw = await Shrinkwrap.load({ path: dir })
     t.equal(