respect indent of manifest if detectable when modifying - fixes #1091 (…

…#1098)

package.json

@@ -13,6 +13,7 @@
     "death": "^1.0.0",
     "debug": "^2.2.0",
     "defaults": "^1.0.3",
+    "detect-indent": "^4.0.0",
     "diff": "^2.2.1",
     "eslint-plugin-react": "5.2.2",
     "github": "2.5.1",

src/cli/commands/add.js

@@ -92,7 +92,7 @@ export class Add extends Install {
     const {dev, exact, tilde, optional, peer} = this.flags;
 
     // get all the different registry manifests in this folder
-    const jsons = await this.getRootManifests();
+    const manifests = await this.config.getRootManifests();
 
     // add new patterns to their appropriate registry manifest
     for (const pattern of this.resolver.dedupePatterns(this.args)) {
@@ -134,7 +134,7 @@ export class Add extends Install {
       }
 
       // add it to manifest
-      const object = jsons[ref.registry].object;
+      const object = manifests[ref.registry].object;
       for (const key of targetKeys) {
         const target = object[key] = object[key] || {};
         target[pkg.name] = version;
@@ -149,7 +149,7 @@ export class Add extends Install {
       this.resolver.removePattern(pattern);
     }
 
-    await this.saveRootManifests(jsons);
+    await this.config.saveRootManifests(manifests);
   }
 }
 

src/cli/commands/init.js

@@ -4,8 +4,6 @@ import type {Reporter} from '../../reporters/index.js';
 import type Config from '../../config.js';
 import {stringifyPerson} from '../../util/normalize-manifest/util.js';
 import {registryNames} from '../../registries/index.js';
-import Lockfile from '../../lockfile/wrapper.js';
-import {Install} from './install.js';
 import * as child from '../../util/child.js';
 import * as fs from '../../util/fs.js';
 
@@ -22,9 +20,7 @@ export async function run(
   flags: Object,
   args: Array<string>,
 ): Promise<void> {
-  const lockfile = new Lockfile();
-  const install = new Install(flags, config, reporter, lockfile);
-  const manifests = await install.getRootManifests();
+  const manifests = await config.getRootManifests();
 
   let gitUrl;
   const author = {
@@ -137,5 +133,5 @@ export async function run(
     reporter.success(`Saved ${path.basename(targetManifest.loc)}`);
   }
 
-  await install.saveRootManifests(manifests);
+  await config.saveRootManifests(manifests);
 }

src/cli/commands/install.js

@@ -6,7 +6,6 @@ import type {Manifest, DependencyRequestPatterns} from '../../types.js';
 import type Config from '../../config.js';
 import type {RegistryNames} from '../../registries/index.js';
 import normalizeManifest from '../../util/normalize-manifest/index.js';
-import {stringify} from '../../util/misc.js';
 import {registryNames} from '../../registries/index.js';
 import {MessageError} from '../../errors.js';
 import Lockfile from '../../lockfile/wrapper.js';
@@ -42,14 +41,6 @@ export type InstallCwdRequest = [
   Object
 ];
 
-type RootManifests = {
-  [registryName: RegistryNames]: {
-    loc: string,
-    object: Object,
-    exists: boolean,
-  }
-};
-
 type IntegrityMatch = {
   actual: string,
   expected: string,
@@ -129,14 +120,6 @@ function normalizeFlags(config: Config, rawFlags: Object): Flags {
   return flags;
 }
 
-const sortObject = (object) => {
-  const sortedObject = {};
-  Object.keys(object).sort().forEach((item) => {
-    sortedObject[item] = object[item];
-  });
-  return sortedObject;
-};
-
 export class Install {
   constructor(
     flags: Object,
@@ -445,7 +428,7 @@ export class Install {
 
     // save resolutions to their appropriate root manifest
     if (Object.keys(this.resolutions).length) {
-      const jsons = await this.getRootManifests();
+      const manifests = await this.config.getRootManifests();
 
       for (const name in this.resolutions) {
         const version = this.resolutions[name];
@@ -467,59 +450,17 @@ export class Install {
         const ref = manifest._reference;
         invariant(ref, 'expected reference');
 
-        const object = jsons[ref.registry].object;
+        const object = manifests[ref.registry].object;
         object.resolutions = object.resolutions || {};
         object.resolutions[name] = version;
       }
 
-      await this.saveRootManifests(jsons);
+      await this.config.saveRootManifests(manifests);
     }
 
     return flattenedPatterns;
   }
 
-  /**
-   * Get root manifests.
-   */
-
-  async getRootManifests(): Promise<RootManifests> {
-    const manifests: RootManifests = {};
-    for (const registryName of registryNames) {
-      const registry = registries[registryName];
-      const jsonLoc = path.join(this.config.cwd, registry.filename);
-
-      let object = {};
-      let exists = false;
-      if (await fs.exists(jsonLoc)) {
-        exists = true;
-        object = await fs.readJson(jsonLoc);
-      }
-      manifests[registryName] = {loc: jsonLoc, object, exists};
-    }
-    return manifests;
-  }
-
-  /**
-   * Save root manifests.
-   */
-
-  async saveRootManifests(manifests: RootManifests): Promise<void> {
-    for (const registryName of registryNames) {
-      const {loc, object, exists} = manifests[registryName];
-      if (!exists && !Object.keys(object).length) {
-        continue;
-      }
-
-      for (const field of constants.DEPENDENCY_TYPES) {
-        if (object[field]) {
-          object[field] = sortObject(object[field]);
-        }
-      }
-
-      await fs.writeFile(loc, stringify(object) + '\n');
-    }
-  }
-
   /**
    * Save updated integrity and lockfiles.
    */

src/cli/commands/remove.js

@@ -30,8 +30,7 @@ export async function run(
 
   // load manifests
   const lockfile = await Lockfile.fromDirectory(config.cwd);
-  const install = new Install(flags, config, new NoopReporter(), lockfile);
-  const rootManifests = await install.getRootManifests();
+  const rootManifests = await config.getRootManifests();
   const manifests = [];
 
   for (const name of args) {
@@ -66,7 +65,7 @@ export async function run(
   }
 
   // save manifests
-  await install.saveRootManifests(rootManifests);
+  await config.saveRootManifests(rootManifests);
 
   // run hooks - npm runs these one after another
   for (const action of ['preuninstall', 'uninstall', 'postuninstall']) {

src/cli/commands/version.js

@@ -2,9 +2,9 @@
 
 import type {Reporter} from '../../reporters/index.js';
 import type Config from '../../config.js';
+import {registryNames} from '../../registries/index.js';
 import executeLifecycleScript from './_execute-lifecycle-script.js';
 import {MessageError} from '../../errors.js';
-import {stringify} from '../../util/misc.js';
 import {spawn} from '../../util/child.js';
 import * as fs from '../../util/fs.js';
 
@@ -81,9 +81,17 @@ export async function setVersion(
 
   // update version
   reporter.info(`${reporter.lang('newVersion')}: ${newVersion}`);
-  const json = await fs.readJson(pkgLoc);
-  pkg.version = json.version = newVersion;
-  await fs.writeFile(pkgLoc, `${stringify(json)}\n`);
+  pkg.version = newVersion;
+
+  // update versions in manifests
+  const manifests = await config.getRootManifests();
+  for (const registryName of registryNames) {
+    const manifest = manifests[registryName];
+    if (manifest.exists) {
+      manifest.object.version = newVersion;
+    }
+  }
+  await config.saveRootManifests(manifests);
 
   return async function(): Promise<void> {
     invariant(newVersion, 'expected version');

src/config.js

@@ -9,9 +9,10 @@ import * as fs from './util/fs.js';
 import * as constants from './constants.js';
 import ConstraintResolver from './package-constraint-resolver.js';
 import RequestManager from './util/request-manager.js';
-import {registries} from './registries/index.js';
+import {registries, registryNames} from './registries/index.js';
 import map from './util/map.js';
 
+const detectIndent = require('detect-indent');
 const invariant = require('invariant');
 const path = require('path');
 const url = require('url');
@@ -40,6 +41,24 @@ type PackageMetadata = {
   package: Manifest
 };
 
+
+type RootManifests = {
+  [registryName: RegistryNames]: {
+    loc: string,
+    indent: ?string,
+    object: Object,
+    exists: boolean,
+  }
+};
+
+function sortObject(object: Object): Object {
+  const sortedObject = {};
+  Object.keys(object).sort().forEach((item) => {
+    sortedObject[item] = object[item];
+  });
+  return sortedObject;
+}
+
 export type ConfigRegistries = {
   [name: RegistryNames]: Registry
 };
@@ -372,4 +391,50 @@ export default class Config {
     }
     return this.registries[registryName].folder;
   }
+
+  /**
+   * Get root manifests.
+   */
+
+  async getRootManifests(): Promise<RootManifests> {
+    const manifests: RootManifests = {};
+    for (const registryName of registryNames) {
+      const registry = registries[registryName];
+      const jsonLoc = path.join(this.cwd, registry.filename);
+
+      let object = {};
+      let exists = false;
+      let indent;
+      if (await fs.exists(jsonLoc)) {
+        exists = true;
+
+        const info = await fs.readJsonAndFile(jsonLoc);
+        object = info.object;
+        indent = detectIndent(info.content).indent || undefined;
+      }
+      manifests[registryName] = {loc: jsonLoc, object, exists, indent};
+    }
+    return manifests;
+  }
+
+  /**
+   * Save root manifests.
+   */
+
+  async saveRootManifests(manifests: RootManifests): Promise<void> {
+    for (const registryName of registryNames) {
+      const {loc, object, exists, indent} = manifests[registryName];
+      if (!exists && !Object.keys(object).length) {
+        continue;
+      }
+
+      for (const field of constants.DEPENDENCY_TYPES) {
+        if (object[field]) {
+          object[field] = sortObject(object[field]);
+        }
+      }
+
+      await fs.writeFile(loc, JSON.stringify(object, null, indent || constants.DEFAULT_INDENT) + '\n');
+    }
+  }
 }

src/constants.js

@@ -45,6 +45,7 @@ export const METADATA_FILENAME = '.yarn-metadata.json';
 export const TARBALL_FILENAME = '.yarn-tarball.tgz';
 export const CLEAN_FILENAME = '.yarnclean';
 
+export const DEFAULT_INDENT = '  ';
 export const SINGLE_INSTANCE_PORT = 31997;
 export const SINGLE_INSTANCE_FILENAME = '.yarn-single-instance';
 

src/fetchers/base-fetcher.js

@@ -5,7 +5,6 @@ import type {PackageRemote, FetchedMetadata, FetchedOverride} from '../types.js'
 import type {RegistryNames} from '../registries/index.js';
 import type Config from '../config.js';
 import * as constants from '../constants.js';
-import * as util from '../util/misc.js';
 import * as fs from '../util/fs.js';
 
 const path = require('path');
@@ -49,11 +48,11 @@ export default class BaseFetcher {
       // load the new normalized manifest
       const pkg = await this.config.readManifest(dest, this.registry);
 
-      await fs.writeFile(path.join(dest, constants.METADATA_FILENAME), util.stringify({
+      await fs.writeFile(path.join(dest, constants.METADATA_FILENAME), JSON.stringify({
         remote: this.remote,
         registry: this.registry,
         hash,
-      }));
+      }, null, '  '));
 
       return {
         resolved,

src/util/fs.js

@@ -315,9 +315,19 @@ export async function readFileAny(files: Array<string>): Promise<?string> {
 }
 
 export async function readJson(loc: string): Promise<Object> {
+  return (await readJsonAndFile(loc)).object;
+}
+
+export async function readJsonAndFile(loc: string): Promise<{
+  object: Object,
+  content: string,
+}> {
   const file = await readFile(loc);
   try {
-    return map(JSON.parse(stripBOM(file)));
+    return {
+      object: map(JSON.parse(stripBOM(file))),
+      content: file,
+    };
   } catch (err) {
     err.message = `${loc}: ${err.message}`;
     throw err;

src/util/misc.js

@@ -30,7 +30,3 @@ export function removeSuffix(pattern: string, suffix: string): string {
 
   return pattern;
 }
-
-export function stringify(obj: Object): string {
-  return JSON.stringify(obj, null, '  ');
-}

yarn.lock

@@ -1653,6 +1653,12 @@ detect-file@^0.1.0:
   dependencies:
     fs-exists-sync "^0.1.0"
 
+detect-indent:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/detect-indent/-/detect-indent-4.0.0.tgz#f76d064352cdf43a1cb6ce619c4ee3a9475de208"
+  dependencies:
+    repeating "^2.0.0"
+
 detect-indent@^3.0.0, detect-indent@^3.0.1:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/detect-indent/-/detect-indent-3.0.1.tgz#9dc5e5ddbceef8325764b9451b02bc6d54084f75"