[RFC] Keep expanded objects expanded

Another attempt at solving the issue where objects are not expanded the way people expect. If there's any new line in the original source, it's going to expand it. This gives more control to the user in how the objects should be formatted.

Fixes #74

src/printer.js

@@ -580,6 +580,14 @@ function genericPrintNoParens(path, options, print) {
         );
       });
 
+      const shouldBreak = util.hasNewlineInRange(
+        options.originalText,
+        util.locStart(n),
+        util.locEnd(n)
+      );
+
+      const lineType = shouldBreak ? hardline : options.bracketSpacing ? line : softline;
+
       if (props.length === 0) {
         return "{}";
       } else {
@@ -589,7 +597,7 @@ function genericPrintNoParens(path, options, print) {
             indent(
               options.tabWidth,
               concat([
-                options.bracketSpacing ? line : softline,
+                lineType,
                 join(concat([ separator, line ]), props)
               ])
             ),

src/util.js

@@ -160,6 +160,15 @@ function hasNewline(text, index, opts) {
   return idx !== idx2;
 }
 
+function hasNewlineInRange(text, start, end) {
+  for (var i = start; i <= end; ++i) {
+    if (text.charAt(i) === "\n") {
+      return true;
+    }
+  }
+  return false;
+}
+
 function hasSpaces(text, index, opts) {
   opts = opts || {};
   const idx = skipSpaces(text, opts.backwards ? index - 1 : index, opts);
@@ -250,6 +259,7 @@ module.exports = {
   skipToLineEnd,
   skipNewline,
   hasNewline,
+  hasNewlineInRange,
   hasSpaces,
   locStart,
   locEnd,

tests/bracketSpacing/__snapshots__/jsfmt.spec.js.snap

@@ -20,7 +20,11 @@ exports[`test object.js 1`] = `
 "const obj1 = {a:1, b:2, c:3}
 const obj2 = { a:1, b:2, c:3 };
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-const obj1 = { a: 1, b: 2, c: 3 };
+const obj1 = {
+  a: 1,
+  b: 2,
+  c: 3
+};
 const obj2 = { a: 1, b: 2, c: 3 };
 "
 `;
@@ -29,7 +33,11 @@ exports[`test object.js 2`] = `
 "const obj1 = {a:1, b:2, c:3}
 const obj2 = { a:1, b:2, c:3 };
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-const obj1 = {a: 1, b: 2, c: 3};
+const obj1 = {
+  a: 1,
+  b: 2,
+  c: 3
+};
 const obj2 = {a: 1, b: 2, c: 3};
 "
 `;

tests/comments/__snapshots__/jsfmt.spec.js.snap

@@ -152,13 +152,29 @@ export type BuckWebSocketMessage =
     // Not actually from Buck - this is to let the receiver know that the socket is connected.
     type: \"SocketConnected\"
   }
-  | { type: \"BuildProgressUpdated\", progressValue: number }
-  | { type: \"BuildFinished\", exitCode: number }
-  | { type: \"BuildStarted\" }
-  | { type: \"ParseStarted\" }
-  | { type: \"ParseFinished\" }
-  | { type: \"RunStarted\" }
-  | { type: \"RunComplete\" };
+  | {
+    type: \"BuildProgressUpdated\",
+    progressValue: number
+  }
+  | {
+    type: \"BuildFinished\",
+    exitCode: number
+  }
+  | {
+    type: \"BuildStarted\"
+  }
+  | {
+    type: \"ParseStarted\"
+  }
+  | {
+    type: \"ParseFinished\"
+  }
+  | {
+    type: \"RunStarted\"
+  }
+  | {
+    type: \"RunComplete\"
+  };
 
 // Missing one level of indentation because of the comment
 const rootEpic = (actions, store) =>
@@ -351,13 +367,29 @@ export type BuckWebSocketMessage =
     // Not actually from Buck - this is to let the receiver know that the socket is connected.
     type: \"SocketConnected\"
   }
-  | { type: \"BuildProgressUpdated\", progressValue: number }
-  | { type: \"BuildFinished\", exitCode: number }
-  | { type: \"BuildStarted\" }
-  | { type: \"ParseStarted\" }
-  | { type: \"ParseFinished\" }
-  | { type: \"RunStarted\" }
-  | { type: \"RunComplete\" };
+  | {
+    type: \"BuildProgressUpdated\",
+    progressValue: number
+  }
+  | {
+    type: \"BuildFinished\",
+    exitCode: number
+  }
+  | {
+    type: \"BuildStarted\"
+  }
+  | {
+    type: \"ParseStarted\"
+  }
+  | {
+    type: \"ParseFinished\"
+  }
+  | {
+    type: \"RunStarted\"
+  }
+  | {
+    type: \"RunComplete\"
+  };
 
 // Missing one level of indentation because of the comment
 const rootEpic = (actions, store) =>

tests/flow/arrays/__snapshots__/jsfmt.spec.js.snap

@@ -73,7 +73,11 @@ var abig2: Array<{ x: number, y: number }> = [
   { x: 0, y: 0, a: true },
   { x: 0, y: 0, b: \"hey\" },
   { x: 0, y: 0, c: 1 },
-  { x: 0, y: 0, c: \"hey\" }
+  {
+    x: 0,
+    y: 0,
+    c: \"hey\"
+  }
 ];
 
 module.exports = \"arrays\";

tests/flow/async_iteration/__snapshots__/jsfmt.spec.js.snap

@@ -82,7 +82,11 @@ async function f() {
   }
 }
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-interface File { readLine(): Promise<string>, close(): void, EOF: boolean }
+interface File {
+  readLine(): Promise<string>,
+  close(): void,
+  EOF: boolean
+}
 
 declare function fileOpen(path: string): Promise<File>;
 

tests/flow/binding/__snapshots__/jsfmt.spec.js.snap

@@ -44,7 +44,9 @@ x ^= 0;
 x &= 0;
 
 // regression tests -- OK to assign consts like this:
-const { foo } = { foo: \"foo\" };
+const { foo } = {
+  foo: \"foo\"
+};
 const [bar] = [\"bar\"];
 (foo: number); // error: string ~> number
 (bar: number); // error: string ~> number

tests/flow/callable/__snapshots__/jsfmt.spec.js.snap

@@ -10,7 +10,10 @@ function f(x) {
 
 (f: F);
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-type F = { (x: string): number, p?: string };
+type F = {
+  (x: string): number,
+  p?: string
+};
 
 function f(x) {
   return x.length;
@@ -49,11 +52,15 @@ foo(Boolean);
 
 var dict: { [k: string]: any } = {};
 dict(); // error, callable signature not found
-interface ICall { (x: string): void }
+interface ICall {
+  (x: string): void
+}
 declare var icall: ICall;
 icall(0); // error, number ~> string
 icall.call(null, 0); // error, number ~> string
-type Callable = { (x: string): void };
+type Callable = {
+  (x: string): void
+};
 
 declare var callable: Callable;
 callable(0); // error, number ~> string

tests/flow/class_statics/__snapshots__/jsfmt.spec.js.snap

@@ -117,6 +117,12 @@ class E {
 }
 
 // note: above classdefs are sufficiently annotated to export
-module.exports = { A: A, B: B, C: C, D: D, E: E };
+module.exports = {
+  A: A,
+  B: B,
+  C: C,
+  D: D,
+  E: E
+};
 "
 `;

tests/flow/computed_props/__snapshots__/jsfmt.spec.js.snap

@@ -23,9 +23,17 @@ ColorIdToNumber.XXX; // oops
 
 module.exports = { ColorId, ColorNumber };
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-var ColorId = { RED: \"R\", GREEN: \"G\", BLUE: \"B\" };
+var ColorId = {
+  RED: \"R\",
+  GREEN: \"G\",
+  BLUE: \"B\"
+};
 
-var ColorNumber = { RED: \"ff0000\", GREEN: \"00ff00\", BLUE: \"0000ff\" };
+var ColorNumber = {
+  RED: \"ff0000\",
+  GREEN: \"00ff00\",
+  BLUE: \"0000ff\"
+};
 
 var ColorIdToNumber = {
   [ColorId.RED]: ColorNumber.RED,
@@ -94,7 +102,11 @@ module.exports = {
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 var hello = require(\"./test4\");
 var dummy = require(\"./test\");
-module.exports = { ...dummy, [hello]: \"world\", ...dummy };
+module.exports = {
+  ...dummy,
+  [hello]: \"world\",
+  ...dummy
+};
 "
 `;
 

tests/flow/config_module_name_rewrite_haste/__snapshots__/jsfmt.spec.js.snap

@@ -44,6 +44,8 @@ module.exports = {
  * @flow
  */
 
-module.exports = { numVal: 42 };
+module.exports = {
+  numVal: 42
+};
 "
 `;

tests/flow/config_module_name_rewrite_node/__snapshots__/jsfmt.spec.js.snap

@@ -60,6 +60,8 @@ module.exports = {
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 /* @flow */
 
-module.exports = { numVal: 42 };
+module.exports = {
+  numVal: 42
+};
 "
 `;

tests/flow/constructor_annots/__snapshots__/jsfmt.spec.js.snap

@@ -37,7 +37,9 @@ Foo.prototype = {
 exports.Foo = Foo;
 
 // so you want to type Foo, by declaring it as a class
-interface IFooPrototype { m(): number }
+interface IFooPrototype {
+  m(): number
+}
 interface IFoo extends IFooPrototype {
   static (): void,
   x: boolean /* error, should have declared x: number instead*/,

tests/flow/declare_class/__snapshots__/jsfmt.spec.js.snap

@@ -10,7 +10,10 @@ C.foo(\"\");
 (C.name: string);
 (C.name: number); // error, it\'s a string
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-declare class C { static x: number, static foo(x: number): void }
+declare class C {
+  static x: number,
+  static foo(x: number): void
+}
 
 C.x = \"\";
 C.foo(\"\");

tests/flow/declare_class/lib/__snapshots__/jsfmt.spec.js.snap

@@ -9,8 +9,14 @@ declare class D extends _module.C {
   foo(): string;
 }
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-declare class _C { foo(): number }
-declare var _module: { C: Class<_C> };
-declare class D extends _module.C { foo(): string }
+declare class _C {
+  foo(): number
+}
+declare var _module: {
+  C: Class<_C>
+};
+declare class D extends _module.C {
+  foo(): string
+}
 "
 `;

tests/flow/declare_export/__snapshots__/jsfmt.spec.js.snap

@@ -549,7 +549,9 @@ module.exports = {
  * @flow
  */
 
-module.exports = { numberValue: 42 };
+module.exports = {
+  numberValue: 42
+};
 "
 `;
 

tests/flow/declare_type/lib/__snapshots__/jsfmt.spec.js.snap

@@ -43,15 +43,19 @@ declare module \'foo\' {
 /* @flow */
 
 declare module \"foo\" {
-  declare class A { toz: number }
+  declare class A {
+    toz: number
+  }
 
   declare var n: string;
 
   declare type Foo = typeof n;
   declare type Bar = A;
   declare type Id<T> = T;
 
-  declare var exports: { (a: number, b: number): number };
+  declare var exports: {
+    (a: number, b: number): number
+  };
 }
 "
 `;