fix: manifest with no changes is not resaved

Differences in order of keys is not considered a change

packages/read-importer-manifest/package.json

@@ -37,11 +37,13 @@
     "@pnpm/types": "workspace:^3.0.0",
     "@pnpm/write-importer-manifest": "workspace:2.0.3",
     "detect-indent": "6.0.0",
+    "fast-deep-equal": "2.0.1",
     "graceful-fs": "4.2.1",
     "is-windows": "1.0.2",
     "json5": "2.1.0",
     "parse-json": "5.0.0",
     "read-yaml-file": "1.1.0",
+    "sort-keys": "4.0.0",
     "strip-bom": "4.0.0"
   },
   "devDependencies": {

packages/read-importer-manifest/src/index.ts

@@ -2,11 +2,13 @@ import PnpmError from '@pnpm/error'
 import { ImporterManifest } from '@pnpm/types'
 import writeImporterManifest from '@pnpm/write-importer-manifest'
 import detectIndent = require('detect-indent')
+import equal = require('fast-deep-equal')
 import fs = require('fs')
 import { Stats } from 'fs'
 import isWindows = require('is-windows')
 import path = require('path')
 import readYamlFile from 'read-yaml-file'
+import sortKeys = require('sort-keys')
 import { promisify } from 'util'
 import {
   readJson5File,
@@ -165,10 +167,32 @@ function createManifestWriter (
     manifestPath: string,
   },
 ): (WriteImporterManifest) {
-  const stringifiedInitialManifest = JSON.stringify(opts.initialManifest)
+  const initialManifest = normalize(JSON.parse(JSON.stringify(opts.initialManifest)))
   return async (updatedManifest: ImporterManifest, force?: boolean) => {
-    if (force === true || stringifiedInitialManifest !== JSON.stringify(updatedManifest)) {
+    updatedManifest = normalize(updatedManifest)
+    if (force === true || !equal(initialManifest, updatedManifest)) {
       return writeImporterManifest(opts.manifestPath, updatedManifest, { indent: opts.indent })
     }
   }
 }
+
+const dependencyKeys = new Set([
+  'dependencies',
+  'devDependencies',
+  'optionalDependencies',
+  'peerDependencies',
+])
+
+function normalize (manifest: ImporterManifest) {
+  const result = {}
+
+  for (const key of Object.keys(manifest)) {
+    if (!dependencyKeys.has(key)) {
+      result[key] = manifest[key]
+    } else if (Object.keys(manifest[key]).length !== 0) {
+      result[key] = sortKeys(manifest[key])
+    }
+  }
+
+  return result
+}

packages/read-importer-manifest/test/index.ts

@@ -95,13 +95,23 @@ test('preserve space indentation in json5 file', async (t) => {
 test('do not save manifest if it had no changes', async (t) => {
   process.chdir(tempy.directory())
 
-  await writeFile('package.json5', JSON.stringify({ dependencies: { foo: '*', bar: '*' } }), 'utf8')
+  await writeFile(
+    'package.json5',
+    JSON.stringify({
+      dependencies: { foo: '*', bar: '*' },
+      devDependencies: {},
+    }),
+    'utf8',
+  )
 
-  const { manifest, writeImporterManifest } = await readImporterManifest(process.cwd())
+  const { writeImporterManifest } = await readImporterManifest(process.cwd())
 
   const stat1 = await stat('package.json5')
 
-  await writeImporterManifest(manifest)
+  await writeImporterManifest({
+    dependencies: { bar: '*', foo: '*' },
+    peerDependencies: {},
+  })
 
   const stat2 = await stat('package.json5')
 

packages/write-importer-manifest/package.json

@@ -34,7 +34,6 @@
   "homepage": "https://github.com/pnpm/pnpm/blob/master/packages/write-importer-manifest#readme",
   "dependencies": {
     "@pnpm/types": "workspace:^3.0.0",
-    "sort-keys": "4.0.0",
     "write-json-file": "4.0.0",
     "write-json5-file": "2.1.2",
     "write-yaml-file": "3.0.1"

packages/write-importer-manifest/src/index.ts

@@ -1,5 +1,4 @@
 import { ImporterManifest } from '@pnpm/types'
-import sortKeys = require('sort-keys')
 import writeJsonFile = require('write-json-file')
 import writeJson5File = require('write-json5-file')
 import writeYamlFile = require('write-yaml-file')
@@ -14,7 +13,6 @@ export default function writeImporterManifest (
   manifest: ImporterManifest,
   opts?: { indent?: string | number | undefined },
 ): Promise<void> {
-  manifest = normalize(manifest)
   switch (filePath.substr(filePath.lastIndexOf('.') + 1).toLowerCase()) {
     case 'json5':
       return writeJson5File(filePath, manifest, opts)
@@ -25,24 +23,3 @@ export default function writeImporterManifest (
       return writeJsonFile(filePath, manifest, opts)
   }
 }
-
-const dependencyKeys = new Set([
-  'dependencies',
-  'devDependencies',
-  'optionalDependencies',
-  'peerDependencies',
-])
-
-function normalize (manifest: ImporterManifest) {
-  const result = {}
-
-  for (const key of Object.keys(manifest)) {
-    if (!dependencyKeys.has(key)) {
-      result[key] = manifest[key]
-    } else if (Object.keys(manifest[key]).length !== 0) {
-      result[key] = sortKeys(manifest[key])
-    }
-  }
-
-  return result
-}