blob: 50ba4ffdae99a0c0454e4f8a21b8d319e6263ad5 [file] [log] [blame]
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +00001//===- unittest/Format/FormatTestJS.cpp - Formatting unit tests for JS ----===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000010#include "FormatTestUtils.h"
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000011#include "clang/Format/Format.h"
12#include "llvm/Support/Debug.h"
13#include "gtest/gtest.h"
14
Chandler Carruth10346662014-04-22 03:17:02 +000015#define DEBUG_TYPE "format-test"
16
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000017namespace clang {
18namespace format {
19
20class FormatTestJS : public ::testing::Test {
21protected:
22 static std::string format(llvm::StringRef Code, unsigned Offset,
23 unsigned Length, const FormatStyle &Style) {
24 DEBUG(llvm::errs() << "---\n");
25 DEBUG(llvm::errs() << Code << "\n\n");
26 std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length));
Daniel Jasper56691b82015-06-11 13:29:20 +000027 bool IncompleteFormat = false;
28 tooling::Replacements Replaces =
29 reformat(Style, Code, Ranges, "<stdin>", &IncompleteFormat);
30 EXPECT_FALSE(IncompleteFormat);
Eric Liu4f8d9942016-07-11 13:53:12 +000031 auto Result = applyAllReplacements(Code, Replaces);
32 EXPECT_TRUE(static_cast<bool>(Result));
33 DEBUG(llvm::errs() << "\n" << *Result << "\n\n");
34 return *Result;
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000035 }
36
Daniel Jasper069e5f42014-05-20 11:14:57 +000037 static std::string format(
38 llvm::StringRef Code,
39 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) {
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000040 return format(Code, 0, Code.size(), Style);
41 }
42
Alexander Kornienkoc1637f12013-12-10 11:28:13 +000043 static FormatStyle getGoogleJSStyleWithColumns(unsigned ColumnLimit) {
Nico Weber514ecc82014-02-02 20:50:45 +000044 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000045 Style.ColumnLimit = ColumnLimit;
46 return Style;
47 }
48
Nico Weber514ecc82014-02-02 20:50:45 +000049 static void verifyFormat(
50 llvm::StringRef Code,
51 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) {
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +000052 std::string Result = format(test::messUp(Code), Style);
53 EXPECT_EQ(Code.str(), Result) << "Formatted:\n" << Result;
54 }
55
56 static void verifyFormat(
57 llvm::StringRef Expected,
58 llvm::StringRef Code,
59 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) {
60 std::string Result = format(Code, Style);
61 EXPECT_EQ(Expected.str(), Result) << "Formatted:\n" << Result;
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000062 }
63};
64
Daniel Jaspere77f19c2016-05-29 22:07:22 +000065TEST_F(FormatTestJS, BlockComments) {
66 verifyFormat("/* aaaaaaaaaaaaa */ aaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
67 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
68}
69
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000070TEST_F(FormatTestJS, UnderstandsJavaScriptOperators) {
71 verifyFormat("a == = b;");
72 verifyFormat("a != = b;");
73
74 verifyFormat("a === b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +000075 verifyFormat("aaaaaaa ===\n b;", getGoogleJSStyleWithColumns(10));
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000076 verifyFormat("a !== b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +000077 verifyFormat("aaaaaaa !==\n b;", getGoogleJSStyleWithColumns(10));
78 verifyFormat("if (a + b + c +\n"
79 " d !==\n"
80 " e + f + g)\n"
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000081 " q();",
Alexander Kornienkoc1637f12013-12-10 11:28:13 +000082 getGoogleJSStyleWithColumns(20));
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000083
84 verifyFormat("a >> >= b;");
85
86 verifyFormat("a >>> b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +000087 verifyFormat("aaaaaaa >>>\n b;", getGoogleJSStyleWithColumns(10));
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000088 verifyFormat("a >>>= b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +000089 verifyFormat("aaaaaaa >>>=\n b;", getGoogleJSStyleWithColumns(10));
90 verifyFormat("if (a + b + c +\n"
91 " d >>>\n"
92 " e + f + g)\n"
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000093 " q();",
Alexander Kornienkoc1637f12013-12-10 11:28:13 +000094 getGoogleJSStyleWithColumns(20));
Daniel Jaspere551bb72014-11-05 17:22:31 +000095 verifyFormat("var x = aaaaaaaaaa ?\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +000096 " bbbbbb :\n"
97 " ccc;",
Alexander Kornienkoc1637f12013-12-10 11:28:13 +000098 getGoogleJSStyleWithColumns(20));
Daniel Jasper78214392014-05-19 07:27:02 +000099
100 verifyFormat("var b = a.map((x) => x + 1);");
Daniel Jasper3549ea12014-09-19 10:48:15 +0000101 verifyFormat("return ('aaa') in bbbb;");
Daniel Jasper1ce41112016-02-01 11:20:47 +0000102 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n"
103 " aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
104 FormatStyle Style = getGoogleJSStyleWithColumns(80);
105 Style.AlignOperands = true;
106 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n"
107 " aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
108 Style);
109 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
110 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa()\n"
111 " in aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
112 Style);
Daniel Jasper08051992015-05-26 07:18:56 +0000113
114 // ES6 spread operator.
115 verifyFormat("someFunction(...a);");
116 verifyFormat("var x = [1, ...a, 2];");
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000117}
118
Daniel Jasper3a038de2014-09-05 08:53:45 +0000119TEST_F(FormatTestJS, UnderstandsAmpAmp) {
120 verifyFormat("e && e.SomeFunction();");
121}
122
Daniel Jasper4db69bd2014-09-04 18:23:42 +0000123TEST_F(FormatTestJS, LiteralOperatorsCanBeKeywords) {
124 verifyFormat("not.and.or.not_eq = 1;");
125}
126
Daniel Jasperba52fcb2015-09-28 14:29:45 +0000127TEST_F(FormatTestJS, ReservedWords) {
128 // JavaScript reserved words (aka keywords) are only illegal when used as
129 // Identifiers, but are legal as IdentifierNames.
130 verifyFormat("x.class.struct = 1;");
131 verifyFormat("x.case = 1;");
132 verifyFormat("x.interface = 1;");
Daniel Jasper997cf2f2016-05-20 06:16:01 +0000133 verifyFormat("x.for = 1;");
Daniel Jaspera4607e12016-03-17 12:17:59 +0000134 verifyFormat("x.of() = 1;");
135 verifyFormat("x.in() = 1;");
136 verifyFormat("x.let() = 1;");
137 verifyFormat("x.var() = 1;");
Daniel Jasper4d67dd72016-11-01 06:22:54 +0000138 verifyFormat("x.for() = 1;");
Daniel Jasperb559b432016-11-01 06:23:10 +0000139 verifyFormat("x.as() = 1;");
Daniel Jasperba52fcb2015-09-28 14:29:45 +0000140 verifyFormat("x = {\n"
141 " a: 12,\n"
142 " interface: 1,\n"
143 " switch: 1,\n"
144 "};");
Daniel Jasper09840ef2015-11-20 15:58:50 +0000145 verifyFormat("var struct = 2;");
146 verifyFormat("var union = 2;");
Martin Probst1e8261e2016-04-19 18:18:59 +0000147 verifyFormat("var interface = 2;");
148 verifyFormat("interface = 2;");
149 verifyFormat("x = interface instanceof y;");
Daniel Jasperba52fcb2015-09-28 14:29:45 +0000150}
151
Martin Probst4210d2f2016-09-22 07:18:00 +0000152TEST_F(FormatTestJS, ReservedWordsMethods) {
153 verifyFormat(
154 "class X {\n"
155 " delete() {\n"
156 " x();\n"
157 " }\n"
158 " interface() {\n"
159 " x();\n"
160 " }\n"
161 " let() {\n"
162 " x();\n"
163 " }\n"
164 "}\n");
165}
166
Daniel Jasper72a1b6a2015-12-22 15:47:56 +0000167TEST_F(FormatTestJS, CppKeywords) {
168 // Make sure we don't mess stuff up because of C++ keywords.
169 verifyFormat("return operator && (aa);");
170}
171
Daniel Jasper0dd52912014-05-19 07:37:07 +0000172TEST_F(FormatTestJS, ES6DestructuringAssignment) {
173 verifyFormat("var [a, b, c] = [1, 2, 3];");
Daniel Jasper5dbcd3b2016-05-19 07:18:07 +0000174 verifyFormat("const [a, b, c] = [1, 2, 3];");
Daniel Jasper9f642f72015-09-28 14:28:08 +0000175 verifyFormat("let [a, b, c] = [1, 2, 3];");
Daniel Jasper60948b12015-03-15 13:55:54 +0000176 verifyFormat("var {a, b} = {a: 1, b: 2};");
Daniel Jasper9f642f72015-09-28 14:28:08 +0000177 verifyFormat("let {a, b} = {a: 1, b: 2};");
Daniel Jasper0dd52912014-05-19 07:37:07 +0000178}
179
Daniel Jasper17062ff2014-06-10 14:44:02 +0000180TEST_F(FormatTestJS, ContainerLiterals) {
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000181 verifyFormat("var x = {\n"
182 " y: function(a) {\n"
183 " return a;\n"
184 " }\n"
185 "};");
Daniel Jasper17062ff2014-06-10 14:44:02 +0000186 verifyFormat("return {\n"
187 " link: function() {\n"
188 " f(); //\n"
189 " }\n"
190 "};");
191 verifyFormat("return {\n"
192 " a: a,\n"
193 " link: function() {\n"
194 " f(); //\n"
195 " }\n"
196 "};");
197 verifyFormat("return {\n"
198 " a: a,\n"
Daniel Jasper90ebc982014-09-05 09:27:38 +0000199 " link: function() {\n"
200 " f(); //\n"
201 " },\n"
202 " link: function() {\n"
203 " f(); //\n"
204 " }\n"
Daniel Jasper17062ff2014-06-10 14:44:02 +0000205 "};");
Daniel Jasper94e11d02014-09-04 14:58:30 +0000206 verifyFormat("var stuff = {\n"
207 " // comment for update\n"
208 " update: false,\n"
209 " // comment for modules\n"
210 " modules: false,\n"
211 " // comment for tasks\n"
212 " tasks: false\n"
213 "};");
Daniel Jasper97bfb7b2014-09-05 08:29:31 +0000214 verifyFormat("return {\n"
215 " 'finish':\n"
216 " //\n"
217 " a\n"
218 "};");
Daniel Jasper40874322014-11-27 15:24:48 +0000219 verifyFormat("var obj = {\n"
220 " fooooooooo: function(x) {\n"
221 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n"
222 " }\n"
223 "};");
Daniel Jasper60948b12015-03-15 13:55:54 +0000224 // Simple object literal, as opposed to enum style below.
225 verifyFormat("var obj = {a: 123};");
226 // Enum style top level assignment.
227 verifyFormat("X = {\n a: 123\n};");
228 verifyFormat("X.Y = {\n a: 123\n};");
Daniel Jasper11ca2632015-06-10 09:21:09 +0000229 // But only on the top level, otherwise its a plain object literal assignment.
230 verifyFormat("function x() {\n"
231 " y = {z: 1};\n"
232 "}");
Daniel Jasper60948b12015-03-15 13:55:54 +0000233 verifyFormat("x = foo && {a: 123};");
Manuel Klimek79e06082015-05-21 12:23:34 +0000234
235 // Arrow functions in object literals.
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000236 verifyFormat("var x = {\n"
237 " y: (a) => {\n"
238 " return a;\n"
239 " }\n"
240 "};");
Manuel Klimek79e06082015-05-21 12:23:34 +0000241 verifyFormat("var x = {y: (a) => a};");
Daniel Jasper8c42d442015-05-29 06:19:49 +0000242
243 // Computed keys.
Daniel Jaspercd8d4ff2015-05-31 08:40:37 +0000244 verifyFormat("var x = {[a]: 1, b: 2, [c]: 3};");
Daniel Jasper8c42d442015-05-29 06:19:49 +0000245 verifyFormat("var x = {\n"
246 " [a]: 1,\n"
Daniel Jaspercd8d4ff2015-05-31 08:40:37 +0000247 " b: 2,\n"
248 " [c]: 3,\n"
Daniel Jasper8c42d442015-05-29 06:19:49 +0000249 "};");
Daniel Jasper9f4c9d42016-02-07 22:17:13 +0000250
251 // Object literals can leave out labels.
252 verifyFormat("f({a}, () => {\n"
253 " g(); //\n"
254 "});");
Daniel Jasperb18425b2016-03-01 04:19:47 +0000255
256 // Keys can be quoted.
257 verifyFormat("var x = {\n"
258 " a: a,\n"
259 " b: b,\n"
260 " 'c': c,\n"
261 "};");
Daniel Jaspere98e5812016-11-29 09:40:36 +0000262
263 // Dict literals can skip the label names.
264 verifyFormat("var x = {\n"
265 " aaa,\n"
266 " aaa,\n"
267 " aaa,\n"
268 "};");
Daniel Jasper17062ff2014-06-10 14:44:02 +0000269}
270
Daniel Jasperf46dec82015-03-31 14:34:15 +0000271TEST_F(FormatTestJS, MethodsInObjectLiterals) {
272 verifyFormat("var o = {\n"
273 " value: 'test',\n"
274 " get value() { // getter\n"
275 " return this.value;\n"
276 " }\n"
277 "};");
278 verifyFormat("var o = {\n"
279 " value: 'test',\n"
280 " set value(val) { // setter\n"
281 " this.value = val;\n"
282 " }\n"
283 "};");
284 verifyFormat("var o = {\n"
285 " value: 'test',\n"
286 " someMethod(val) { // method\n"
287 " doSomething(this.value + val);\n"
288 " }\n"
289 "};");
Daniel Jasper739ec532015-04-04 07:56:55 +0000290 verifyFormat("var o = {\n"
291 " someMethod(val) { // method\n"
292 " doSomething(this.value + val);\n"
293 " },\n"
294 " someOtherMethod(val) { // method\n"
295 " doSomething(this.value + val);\n"
296 " }\n"
297 "};");
Daniel Jasperf46dec82015-03-31 14:34:15 +0000298}
299
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000300TEST_F(FormatTestJS, SpacesInContainerLiterals) {
301 verifyFormat("var arr = [1, 2, 3];");
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000302 verifyFormat("f({a: 1, b: 2, c: 3});");
Nico Weber514ecc82014-02-02 20:50:45 +0000303
Daniel Jasper2a958322014-05-21 13:26:58 +0000304 verifyFormat("var object_literal_with_long_name = {\n"
305 " a: 'aaaaaaaaaaaaaaaaaa',\n"
306 " b: 'bbbbbbbbbbbbbbbbbb'\n"
307 "};");
308
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000309 verifyFormat("f({a: 1, b: 2, c: 3});",
Nico Weber514ecc82014-02-02 20:50:45 +0000310 getChromiumStyle(FormatStyle::LK_JavaScript));
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000311 verifyFormat("f({'a': [{}]});");
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000312}
313
Daniel Jasperabd1f572016-03-02 22:44:03 +0000314TEST_F(FormatTestJS, SingleQuotedStrings) {
Daniel Jasper86fee2f2014-01-31 12:49:42 +0000315 verifyFormat("this.function('', true);");
316}
317
Daniel Jasper4a39c842014-05-06 13:54:10 +0000318TEST_F(FormatTestJS, GoogScopes) {
319 verifyFormat("goog.scope(function() {\n"
320 "var x = a.b;\n"
321 "var y = c.d;\n"
322 "}); // goog.scope");
Daniel Jasper02c7bca2015-03-30 09:56:50 +0000323 verifyFormat("goog.scope(function() {\n"
324 "// test\n"
325 "var x = 0;\n"
326 "// test\n"
327 "});");
Daniel Jasper4a39c842014-05-06 13:54:10 +0000328}
329
Daniel Jasper616de8642014-11-23 16:46:28 +0000330TEST_F(FormatTestJS, GoogModules) {
331 verifyFormat("goog.module('this.is.really.absurdly.long');",
332 getGoogleJSStyleWithColumns(40));
333 verifyFormat("goog.require('this.is.really.absurdly.long');",
334 getGoogleJSStyleWithColumns(40));
335 verifyFormat("goog.provide('this.is.really.absurdly.long');",
336 getGoogleJSStyleWithColumns(40));
337 verifyFormat("var long = goog.require('this.is.really.absurdly.long');",
338 getGoogleJSStyleWithColumns(40));
Daniel Jasperb488a742015-10-29 19:05:20 +0000339 verifyFormat("goog.setTestOnly('this.is.really.absurdly.long');",
340 getGoogleJSStyleWithColumns(40));
Daniel Jasper02cbeb22016-02-22 15:06:53 +0000341 verifyFormat("goog.forwardDeclare('this.is.really.absurdly.long');",
342 getGoogleJSStyleWithColumns(40));
Daniel Jasper53c38f42014-11-27 14:46:03 +0000343
344 // These should be wrapped normally.
345 verifyFormat(
346 "var MyLongClassName =\n"
347 " goog.module.get('my.long.module.name.followedBy.MyLongClassName');");
Daniel Jasper616de8642014-11-23 16:46:28 +0000348}
349
Martin Probstece8c0c2016-06-13 16:41:28 +0000350TEST_F(FormatTestJS, FormatsNamespaces) {
351 verifyFormat("namespace Foo {\n"
352 " export let x = 1;\n"
353 "}\n");
354 verifyFormat("declare namespace Foo {\n"
355 " export let x: number;\n"
356 "}\n");
357}
358
Martin Probst72fd75a2016-11-10 16:20:58 +0000359TEST_F(FormatTestJS, NamespacesMayNotWrap) {
360 verifyFormat("declare namespace foobarbaz {\n"
361 "}\n", getGoogleJSStyleWithColumns(18));
362 verifyFormat("declare module foobarbaz {\n"
363 "}\n", getGoogleJSStyleWithColumns(15));
364 verifyFormat("namespace foobarbaz {\n"
365 "}\n", getGoogleJSStyleWithColumns(10));
366 verifyFormat("module foobarbaz {\n"
367 "}\n", getGoogleJSStyleWithColumns(7));
368}
369
370TEST_F(FormatTestJS, AmbientDeclarations) {
371 FormatStyle NineCols = getGoogleJSStyleWithColumns(9);
372 verifyFormat(
373 "declare class\n"
374 " X {}",
375 NineCols);
376 verifyFormat(
377 "declare function\n"
378 "x();", // TODO(martinprobst): should ideally be indented.
379 NineCols);
Martin Probstaf16c502017-01-04 13:36:43 +0000380 verifyFormat("declare function foo();\n"
381 "let x = 1;\n");
382 verifyFormat("declare function foo(): string;\n"
383 "let x = 1;\n");
384 verifyFormat("declare function foo(): {x: number};\n"
385 "let x = 1;\n");
386 verifyFormat("declare class X {}\n"
387 "let x = 1;\n");
388 verifyFormat("declare interface Y {}\n"
389 "let x = 1;\n");
Martin Probst72fd75a2016-11-10 16:20:58 +0000390 verifyFormat(
391 "declare enum X {\n"
392 "}",
393 NineCols);
394 verifyFormat(
395 "declare let\n"
396 " x: number;",
397 NineCols);
398}
399
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000400TEST_F(FormatTestJS, FormatsFreestandingFunctions) {
401 verifyFormat("function outer1(a, b) {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000402 " function inner1(a, b) {\n"
403 " return a;\n"
404 " }\n"
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000405 " inner1(a, b);\n"
406 "}\n"
407 "function outer2(a, b) {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000408 " function inner2(a, b) {\n"
409 " return a;\n"
410 " }\n"
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000411 " inner2(a, b);\n"
412 "}");
Daniel Jasper20580fd2015-06-11 13:31:45 +0000413 verifyFormat("function f() {}");
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000414}
415
Martin Probst5f8445b2016-04-24 22:05:09 +0000416TEST_F(FormatTestJS, GeneratorFunctions) {
417 verifyFormat("function* f() {\n"
418 " let x = 1;\n"
419 " yield x;\n"
420 " yield* something();\n"
Daniel Jaspereb886632016-10-31 13:18:25 +0000421 " yield [1, 2];\n"
422 " yield {a: 1};\n"
Martin Probst5f8445b2016-04-24 22:05:09 +0000423 "}");
424 verifyFormat("function*\n"
425 " f() {\n"
426 "}",
427 getGoogleJSStyleWithColumns(8));
428 verifyFormat("export function* f() {\n"
429 " yield 1;\n"
430 "}\n");
431 verifyFormat("class X {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000432 " * generatorMethod() {\n"
433 " yield x;\n"
434 " }\n"
Martin Probst5f8445b2016-04-24 22:05:09 +0000435 "}");
Daniel Jasper71e50af2016-11-01 06:22:59 +0000436 verifyFormat("var x = {\n"
437 " a: function*() {\n"
438 " //\n"
439 " }\n"
440 "}\n");
Martin Probst5f8445b2016-04-24 22:05:09 +0000441}
442
443TEST_F(FormatTestJS, AsyncFunctions) {
444 verifyFormat("async function f() {\n"
445 " let x = 1;\n"
446 " return fetch(x);\n"
447 "}");
448 verifyFormat("async function* f() {\n"
449 " yield fetch(x);\n"
450 "}");
451 verifyFormat("export async function f() {\n"
452 " return fetch(x);\n"
453 "}");
454 verifyFormat("class X {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000455 " async asyncMethod() {\n"
456 " return fetch(1);\n"
457 " }\n"
Martin Probst5f8445b2016-04-24 22:05:09 +0000458 "}");
Martin Probst409697e2016-05-29 14:41:07 +0000459 verifyFormat("function initialize() {\n"
460 " // Comment.\n"
461 " return async.then();\n"
462 "}\n");
Martin Probst5f8445b2016-04-24 22:05:09 +0000463}
464
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000465TEST_F(FormatTestJS, ArrayLiterals) {
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +0000466 verifyFormat("var aaaaa: List<SomeThing> =\n"
467 " [new SomeThingAAAAAAAAAAAA(), new SomeThingBBBBBBBBB()];");
Daniel Jasperd492b5e2015-06-02 21:57:51 +0000468 verifyFormat("return [\n"
Daniel Jasper50780ce2016-01-13 16:41:34 +0000469 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
Daniel Jasperd492b5e2015-06-02 21:57:51 +0000470 " ccccccccccccccccccccccccccc\n"
471 "];");
Daniel Jasper7bec87c2016-01-07 18:11:54 +0000472 verifyFormat("return [\n"
473 " aaaa().bbbbbbbb('A'),\n"
474 " aaaa().bbbbbbbb('B'),\n"
475 " aaaa().bbbbbbbb('C'),\n"
476 "];");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000477 verifyFormat("var someVariable = SomeFunction([\n"
Daniel Jasper50780ce2016-01-13 16:41:34 +0000478 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
Daniel Jasper5ce80de2015-06-02 13:56:43 +0000479 " ccccccccccccccccccccccccccc\n"
480 "]);");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000481 verifyFormat("var someVariable = SomeFunction([\n"
Daniel Jasper40432ce2015-06-02 15:04:29 +0000482 " [aaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbb],\n"
Daniel Jasper199d0c92015-06-02 15:14:21 +0000483 "]);",
484 getGoogleJSStyleWithColumns(51));
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000485 verifyFormat("var someVariable = SomeFunction(aaaa, [\n"
Daniel Jasper50780ce2016-01-13 16:41:34 +0000486 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
Daniel Jasper4284e362015-06-02 14:20:08 +0000487 " ccccccccccccccccccccccccccc\n"
488 "]);");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000489 verifyFormat("var someVariable = SomeFunction(\n"
490 " aaaa,\n"
491 " [\n"
Daniel Jasper50780ce2016-01-13 16:41:34 +0000492 " aaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
493 " cccccccccccccccccccccccccc\n"
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000494 " ],\n"
495 " aaaa);");
Daniel Jasperebcb71f2016-01-04 13:11:41 +0000496 verifyFormat("var aaaa = aaaaa || // wrap\n"
497 " [];");
Daniel Jasper1feab0f2015-06-02 15:31:37 +0000498
499 verifyFormat("someFunction([], {a: a});");
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000500}
501
Daniel Jaspere2deb592015-12-22 15:48:15 +0000502TEST_F(FormatTestJS, ColumnLayoutForArrayLiterals) {
503 verifyFormat("var array = [\n"
504 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
505 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
506 "];");
507 verifyFormat("var array = someFunction([\n"
508 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
509 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
510 "]);");
511}
512
Daniel Jasper5217a8b2014-06-13 07:02:04 +0000513TEST_F(FormatTestJS, FunctionLiterals) {
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000514 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
515 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Daniel Jasper3f69ba12014-09-05 08:42:27 +0000516 verifyFormat("doFoo(function() {});");
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000517 verifyFormat("doFoo(function() { return 1; });", Style);
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000518 verifyFormat("var func = function() {\n"
519 " return 1;\n"
520 "};");
Daniel Jaspered3f3952015-06-18 12:32:59 +0000521 verifyFormat("var func = //\n"
522 " function() {\n"
523 " return 1;\n"
524 "};");
Daniel Jasperc03e16a2014-05-08 09:25:39 +0000525 verifyFormat("return {\n"
526 " body: {\n"
527 " setAttribute: function(key, val) { this[key] = val; },\n"
528 " getAttribute: function(key) { return this[key]; },\n"
529 " style: {direction: ''}\n"
530 " }\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000531 "};",
532 Style);
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000533 verifyFormat("abc = xyz ? function() {\n"
534 " return 1;\n"
535 "} : function() {\n"
536 " return -1;\n"
537 "};");
Daniel Jasperb16b9692014-05-21 12:51:23 +0000538
539 verifyFormat("var closure = goog.bind(\n"
540 " function() { // comment\n"
541 " foo();\n"
542 " bar();\n"
543 " },\n"
Joerg Sonnenbergere9987a12017-01-05 17:59:44 +0000544 " this, arg1IsReallyLongAndNeedsLineBreaks,\n"
545 " arg3IsReallyLongAndNeedsLineBreaks);");
Daniel Jasperb16b9692014-05-21 12:51:23 +0000546 verifyFormat("var closure = goog.bind(function() { // comment\n"
547 " foo();\n"
548 " bar();\n"
549 "}, this);");
Daniel Jasper58cb2ed2014-06-06 13:49:04 +0000550 verifyFormat("return {\n"
551 " a: 'E',\n"
552 " b: function() {\n"
553 " return function() {\n"
554 " f(); //\n"
555 " };\n"
556 " }\n"
557 "};");
Daniel Jasper41368e92014-11-27 15:37:42 +0000558 verifyFormat("{\n"
559 " var someVariable = function(x) {\n"
560 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n"
561 " };\n"
562 "}");
Daniel Jasper7325aee2015-05-08 08:38:52 +0000563 verifyFormat("someLooooooooongFunction(\n"
564 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
565 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
566 " function(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
567 " // code\n"
568 " });");
Daniel Jasper5f3ea472014-05-22 08:36:53 +0000569
Daniel Jasper5217a8b2014-06-13 07:02:04 +0000570 verifyFormat("return {\n"
571 " a: function SomeFunction() {\n"
572 " // ...\n"
573 " return 1;\n"
574 " }\n"
575 "};");
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000576 verifyFormat("this.someObject.doSomething(aaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
577 " .then(goog.bind(function(aaaaaaaaaaa) {\n"
578 " someFunction();\n"
579 " someFunction();\n"
580 " }, this), aaaaaaaaaaaaaaaaa);");
581
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000582 verifyFormat("someFunction(goog.bind(function() {\n"
583 " doSomething();\n"
584 " doSomething();\n"
585 "}, this), goog.bind(function() {\n"
586 " doSomething();\n"
587 " doSomething();\n"
588 "}, this));");
Daniel Jasper1699eca2015-06-01 09:56:32 +0000589
590 // FIXME: This is bad, we should be wrapping before "function() {".
591 verifyFormat("someFunction(function() {\n"
592 " doSomething(); // break\n"
593 "})\n"
594 " .doSomethingElse(\n"
595 " // break\n"
596 " );");
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000597
598 Style.ColumnLimit = 33;
599 verifyFormat("f({a: function() { return 1; }});", Style);
600 Style.ColumnLimit = 32;
601 verifyFormat("f({\n"
602 " a: function() { return 1; }\n"
603 "});",
604 Style);
605
Daniel Jasper79dffb42014-05-07 09:48:30 +0000606}
607
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000608TEST_F(FormatTestJS, InliningFunctionLiterals) {
609 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
610 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
611 verifyFormat("var func = function() {\n"
612 " return 1;\n"
613 "};",
614 Style);
615 verifyFormat("var func = doSomething(function() { return 1; });", Style);
616 verifyFormat("var outer = function() {\n"
617 " var inner = function() { return 1; }\n"
618 "};",
619 Style);
620 verifyFormat("function outer1(a, b) {\n"
621 " function inner1(a, b) { return a; }\n"
622 "}",
623 Style);
624
625 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
626 verifyFormat("var func = function() { return 1; };", Style);
627 verifyFormat("var func = doSomething(function() { return 1; });", Style);
628 verifyFormat(
629 "var outer = function() { var inner = function() { return 1; } };",
630 Style);
631 verifyFormat("function outer1(a, b) {\n"
632 " function inner1(a, b) { return a; }\n"
633 "}",
634 Style);
635
636 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
637 verifyFormat("var func = function() {\n"
638 " return 1;\n"
639 "};",
640 Style);
641 verifyFormat("var func = doSomething(function() {\n"
642 " return 1;\n"
643 "});",
644 Style);
645 verifyFormat("var outer = function() {\n"
646 " var inner = function() {\n"
647 " return 1;\n"
648 " }\n"
649 "};",
650 Style);
651 verifyFormat("function outer1(a, b) {\n"
652 " function inner1(a, b) {\n"
653 " return a;\n"
654 " }\n"
655 "}",
656 Style);
Daniel Jasper71e57452015-11-20 16:44:28 +0000657
658 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
659 verifyFormat("var func = function() {\n"
660 " return 1;\n"
661 "};",
662 Style);
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000663}
664
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000665TEST_F(FormatTestJS, MultipleFunctionLiterals) {
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000666 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
667 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000668 verifyFormat("promise.then(\n"
669 " function success() {\n"
670 " doFoo();\n"
671 " doBar();\n"
672 " },\n"
673 " function error() {\n"
674 " doFoo();\n"
675 " doBaz();\n"
676 " },\n"
677 " []);\n");
678 verifyFormat("promise.then(\n"
679 " function success() {\n"
680 " doFoo();\n"
681 " doBar();\n"
682 " },\n"
683 " [],\n"
684 " function error() {\n"
685 " doFoo();\n"
686 " doBaz();\n"
687 " });\n");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000688 verifyFormat("promise.then(\n"
689 " [],\n"
690 " function success() {\n"
691 " doFoo();\n"
692 " doBar();\n"
693 " },\n"
694 " function error() {\n"
695 " doFoo();\n"
696 " doBaz();\n"
697 " });\n");
Daniel Jasper1779d432014-09-29 07:54:54 +0000698
699 verifyFormat("getSomeLongPromise()\n"
700 " .then(function(value) { body(); })\n"
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000701 " .thenCatch(function(error) {\n"
702 " body();\n"
703 " body();\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000704 " });",
705 Style);
Daniel Jasper1779d432014-09-29 07:54:54 +0000706 verifyFormat("getSomeLongPromise()\n"
707 " .then(function(value) {\n"
708 " body();\n"
709 " body();\n"
710 " })\n"
711 " .thenCatch(function(error) {\n"
712 " body();\n"
713 " body();\n"
714 " });");
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000715
Daniel Jasperacf67e32015-04-07 08:20:35 +0000716 verifyFormat("getSomeLongPromise()\n"
717 " .then(function(value) { body(); })\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000718 " .thenCatch(function(error) { body(); });",
719 Style);
Daniel Jasper28024562016-01-11 11:00:58 +0000720
721 verifyFormat("return [aaaaaaaaaaaaaaaaaaaaaa]\n"
722 " .aaaaaaa(function() {\n"
723 " //\n"
724 " })\n"
725 " .bbbbbb();");
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000726}
727
Manuel Klimek79e06082015-05-21 12:23:34 +0000728TEST_F(FormatTestJS, ArrowFunctions) {
729 verifyFormat("var x = (a) => {\n"
730 " return a;\n"
731 "};");
732 verifyFormat("var x = (a) => {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000733 " function y() {\n"
734 " return 42;\n"
735 " }\n"
Manuel Klimek79e06082015-05-21 12:23:34 +0000736 " return a;\n"
737 "};");
738 verifyFormat("var x = (a: type): {some: type} => {\n"
739 " return a;\n"
740 "};");
741 verifyFormat("var x = (a) => a;");
Daniel Jaspere497bed2015-06-02 22:06:07 +0000742 verifyFormat("return () => [];");
Daniel Jasper3c306e82015-06-03 17:08:40 +0000743 verifyFormat("var aaaaaaaaaaaaaaaaaaaa = {\n"
744 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa:\n"
745 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
746 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) =>\n"
Daniel Jasper3b0f3042015-06-05 08:25:37 +0000747 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
Daniel Jasper3c306e82015-06-03 17:08:40 +0000748 "};");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000749 verifyFormat("var a = a.aaaaaaa(\n"
750 " (a: a) => aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) &&\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +0000751 " aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbb));");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000752 verifyFormat("var a = a.aaaaaaa(\n"
753 " (a: a) => aaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) ?\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +0000754 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb) :\n"
755 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb));");
Daniel Jasper1699eca2015-06-01 09:56:32 +0000756
757 // FIXME: This is bad, we should be wrapping before "() => {".
758 verifyFormat("someFunction(() => {\n"
759 " doSomething(); // break\n"
760 "})\n"
761 " .doSomethingElse(\n"
762 " // break\n"
763 " );");
Manuel Klimek79e06082015-05-21 12:23:34 +0000764}
765
Daniel Jasper166c19b2014-05-06 14:12:21 +0000766TEST_F(FormatTestJS, ReturnStatements) {
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000767 verifyFormat("function() {\n"
768 " return [hello, world];\n"
769 "}");
Daniel Jasper166c19b2014-05-06 14:12:21 +0000770}
771
Daniel Jasperf95b1f42015-11-20 16:18:42 +0000772TEST_F(FormatTestJS, ForLoops) {
773 verifyFormat("for (var i in [2, 3]) {\n"
774 "}");
Daniel Jasperb7fda112016-02-11 13:24:15 +0000775 verifyFormat("for (var i of [2, 3]) {\n"
776 "}");
Daniel Jasperacffeb82016-03-05 18:34:26 +0000777 verifyFormat("for (let {a, b} of x) {\n"
778 "}");
779 verifyFormat("for (let {a, b} in x) {\n"
780 "}");
Daniel Jasperf95b1f42015-11-20 16:18:42 +0000781}
782
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +0000783TEST_F(FormatTestJS, WrapRespectsAutomaticSemicolonInsertion) {
Daniel Jasper4c0bf702015-06-12 04:58:27 +0000784 // The following statements must not wrap, as otherwise the program meaning
785 // would change due to automatic semicolon insertion.
786 // See http://www.ecma-international.org/ecma-262/5.1/#sec-7.9.1.
787 verifyFormat("return aaaaa;", getGoogleJSStyleWithColumns(10));
Martin Probst56ff7aa2016-09-06 18:39:30 +0000788 verifyFormat("return /* hello! */ aaaaa;", getGoogleJSStyleWithColumns(10));
Daniel Jasper4c0bf702015-06-12 04:58:27 +0000789 verifyFormat("continue aaaaa;", getGoogleJSStyleWithColumns(10));
Martin Probst56ff7aa2016-09-06 18:39:30 +0000790 verifyFormat("continue /* hello! */ aaaaa;", getGoogleJSStyleWithColumns(10));
Daniel Jasper4c0bf702015-06-12 04:58:27 +0000791 verifyFormat("break aaaaa;", getGoogleJSStyleWithColumns(10));
792 verifyFormat("throw aaaaa;", getGoogleJSStyleWithColumns(10));
793 verifyFormat("aaaaaaaaa++;", getGoogleJSStyleWithColumns(10));
794 verifyFormat("aaaaaaaaa--;", getGoogleJSStyleWithColumns(10));
Daniel Jasper11a87652016-01-14 05:37:52 +0000795 verifyFormat("return [\n"
796 " aaa\n"
797 "];",
798 getGoogleJSStyleWithColumns(12));
Daniel Jasper4c0bf702015-06-12 04:58:27 +0000799}
800
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +0000801TEST_F(FormatTestJS, AutomaticSemicolonInsertionHeuristic) {
802 verifyFormat("a\n"
803 "b;",
804 " a \n"
805 " b ;");
806 verifyFormat("a()\n"
807 "b;",
808 " a ()\n"
809 " b ;");
810 verifyFormat("a[b]\n"
811 "c;",
812 "a [b]\n"
813 "c ;");
814 verifyFormat("1\n"
815 "a;",
816 "1 \n"
817 "a ;");
818 verifyFormat("a\n"
819 "1;",
820 "a \n"
821 "1 ;");
822 verifyFormat("a\n"
823 "'x';",
824 "a \n"
825 " 'x';");
826 verifyFormat("a++\n"
827 "b;",
828 "a ++\n"
829 "b ;");
830 verifyFormat("a\n"
831 "!b && c;",
832 "a \n"
833 " ! b && c;");
834 verifyFormat("a\n"
835 "if (1) f();",
836 " a\n"
837 " if (1) f();");
838 verifyFormat("a\n"
839 "class X {}",
840 " a\n"
841 " class X {}");
842 verifyFormat("var a", "var\n"
843 "a");
844 verifyFormat("x instanceof String", "x\n"
845 "instanceof\n"
846 "String");
Martin Probstbbffeac2016-04-11 07:35:57 +0000847 verifyFormat("function f(@Foo bar) {}", "function f(@Foo\n"
848 " bar) {}");
Martin Probstb9316ff2016-09-18 17:21:52 +0000849 verifyFormat("a = true\n"
850 "return 1",
851 "a = true\n"
852 " return 1");
853 verifyFormat("a = 's'\n"
854 "return 1",
855 "a = 's'\n"
856 " return 1");
857 verifyFormat("a = null\n"
858 "return 1",
859 "a = null\n"
860 " return 1");
Martin Probste6b5b342017-01-16 09:52:40 +0000861 // Below "class Y {}" should ideally be on its own line.
Martin Probstd40bca42017-01-09 08:56:36 +0000862 verifyFormat(
Martin Probstfd18ec52017-01-09 09:00:58 +0000863 "x = {\n"
864 " a: 1\n"
Martin Probste6b5b342017-01-16 09:52:40 +0000865 "} class Y {}",
Martin Probstd40bca42017-01-09 08:56:36 +0000866 " x = {a : 1}\n"
867 " class Y { }");
Martin Probste6b5b342017-01-16 09:52:40 +0000868 verifyFormat(
869 "if (x) {\n"
870 "}\n"
871 "return 1",
872 "if (x) {}\n"
873 " return 1");
874 verifyFormat(
875 "if (x) {\n"
876 "}\n"
877 "class X {}",
878 "if (x) {}\n"
879 " class X {}");
Martin Probstd40bca42017-01-09 08:56:36 +0000880}
881
882TEST_F(FormatTestJS, ImportExportASI) {
883 verifyFormat(
884 "import {x} from 'y'\n"
885 "export function z() {}",
886 "import {x} from 'y'\n"
887 " export function z() {}");
Martin Probste6b5b342017-01-16 09:52:40 +0000888 // Below "class Y {}" should ideally be on its own line.
Martin Probstd40bca42017-01-09 08:56:36 +0000889 verifyFormat(
Martin Probste6b5b342017-01-16 09:52:40 +0000890 "export {x} class Y {}",
Martin Probstd40bca42017-01-09 08:56:36 +0000891 " export {x}\n"
892 " class Y {\n}");
Martin Probste6b5b342017-01-16 09:52:40 +0000893 verifyFormat(
894 "if (x) {\n"
895 "}\n"
896 "export class Y {}",
897 "if ( x ) { }\n"
898 " export class Y {}");
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +0000899}
900
Manuel Klimek79e06082015-05-21 12:23:34 +0000901TEST_F(FormatTestJS, ClosureStyleCasts) {
Daniel Jasper484033b2014-05-06 14:41:29 +0000902 verifyFormat("var x = /** @type {foo} */ (bar);");
903}
904
Daniel Jasper04a71a42014-05-08 11:58:24 +0000905TEST_F(FormatTestJS, TryCatch) {
906 verifyFormat("try {\n"
907 " f();\n"
908 "} catch (e) {\n"
909 " g();\n"
910 "} finally {\n"
911 " h();\n"
912 "}");
Daniel Jasper8f2e94c2014-09-04 15:03:34 +0000913
914 // But, of course, "catch" is a perfectly fine function name in JavaScript.
915 verifyFormat("someObject.catch();");
Daniel Jasper79121232014-11-27 14:55:17 +0000916 verifyFormat("someObject.new();");
917 verifyFormat("someObject.delete();");
Daniel Jasper04a71a42014-05-08 11:58:24 +0000918}
919
Daniel Jasper49802ef2014-05-22 09:10:04 +0000920TEST_F(FormatTestJS, StringLiteralConcatenation) {
921 verifyFormat("var literal = 'hello ' +\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +0000922 " 'world';");
Daniel Jasper49802ef2014-05-22 09:10:04 +0000923}
924
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000925TEST_F(FormatTestJS, RegexLiteralClassification) {
926 // Regex literals.
927 verifyFormat("var regex = /abc/;");
928 verifyFormat("f(/abc/);");
929 verifyFormat("f(abc, /abc/);");
930 verifyFormat("some_map[/abc/];");
931 verifyFormat("var x = a ? /abc/ : /abc/;");
932 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}");
933 verifyFormat("var x = !/abc/.test(y);");
934 verifyFormat("var x = a && /abc/.test(y);");
935 verifyFormat("var x = a || /abc/.test(y);");
936 verifyFormat("var x = a + /abc/.search(y);");
Daniel Jasperc553ae12015-07-02 13:20:45 +0000937 verifyFormat("/abc/.search(y);");
Daniel Jasperf7405c12014-05-08 07:45:18 +0000938 verifyFormat("var regexs = {/abc/, /abc/};");
939 verifyFormat("return /abc/;");
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000940
941 // Not regex literals.
942 verifyFormat("var a = a / 2 + b / 3;");
Daniel Jasper265309e2015-10-18 07:02:28 +0000943 verifyFormat("var a = a++ / 2;");
944 // Prefix unary can operate on regex literals, not that it makes sense.
945 verifyFormat("var a = ++/a/;");
946
947 // This is a known issue, regular expressions are incorrectly detected if
948 // directly following a closing parenthesis.
949 verifyFormat("if (foo) / bar /.exec(baz);");
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000950}
951
952TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) {
Daniel Jasper69694b02015-05-08 07:55:13 +0000953 verifyFormat("var regex = /=/;");
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000954 verifyFormat("var regex = /a*/;");
955 verifyFormat("var regex = /a+/;");
956 verifyFormat("var regex = /a?/;");
957 verifyFormat("var regex = /.a./;");
958 verifyFormat("var regex = /a\\*/;");
959 verifyFormat("var regex = /^a$/;");
960 verifyFormat("var regex = /\\/a/;");
961 verifyFormat("var regex = /(?:x)/;");
962 verifyFormat("var regex = /x(?=y)/;");
963 verifyFormat("var regex = /x(?!y)/;");
964 verifyFormat("var regex = /x|y/;");
965 verifyFormat("var regex = /a{2}/;");
966 verifyFormat("var regex = /a{1,3}/;");
Daniel Jasper8d0e2232015-10-12 03:13:48 +0000967
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000968 verifyFormat("var regex = /[abc]/;");
969 verifyFormat("var regex = /[^abc]/;");
970 verifyFormat("var regex = /[\\b]/;");
Daniel Jasper8d0e2232015-10-12 03:13:48 +0000971 verifyFormat("var regex = /[/]/;");
972 verifyFormat("var regex = /[\\/]/;");
973 verifyFormat("var regex = /\\[/;");
974 verifyFormat("var regex = /\\\\[/]/;");
Daniel Jasper265309e2015-10-18 07:02:28 +0000975 verifyFormat("var regex = /}[\"]/;");
976 verifyFormat("var regex = /}[/\"]/;");
977 verifyFormat("var regex = /}[\"/]/;");
Daniel Jasper8d0e2232015-10-12 03:13:48 +0000978
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000979 verifyFormat("var regex = /\\b/;");
980 verifyFormat("var regex = /\\B/;");
981 verifyFormat("var regex = /\\d/;");
982 verifyFormat("var regex = /\\D/;");
983 verifyFormat("var regex = /\\f/;");
984 verifyFormat("var regex = /\\n/;");
985 verifyFormat("var regex = /\\r/;");
986 verifyFormat("var regex = /\\s/;");
987 verifyFormat("var regex = /\\S/;");
988 verifyFormat("var regex = /\\t/;");
989 verifyFormat("var regex = /\\v/;");
990 verifyFormat("var regex = /\\w/;");
991 verifyFormat("var regex = /\\W/;");
992 verifyFormat("var regex = /a(a)\\1/;");
993 verifyFormat("var regex = /\\0/;");
Daniel Jasperfb4333b2014-05-12 11:29:50 +0000994 verifyFormat("var regex = /\\\\/g;");
995 verifyFormat("var regex = /\\a\\\\/g;");
996 verifyFormat("var regex = /\a\\//g;");
Daniel Jasper23376252014-09-09 14:37:39 +0000997 verifyFormat("var regex = /a\\//;\n"
998 "var x = 0;");
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +0000999 verifyFormat("var regex = /'/g;", "var regex = /'/g ;");
1000 verifyFormat("var regex = /'/g; //'", "var regex = /'/g ; //'");
1001 verifyFormat("var regex = /\\/*/;\n"
1002 "var x = 0;",
1003 "var regex = /\\/*/;\n"
1004 "var x=0;");
1005 verifyFormat("var x = /a\\//;", "var x = /a\\// \n;");
Daniel Jasper6b8d26c2015-06-24 16:01:02 +00001006 verifyFormat("var regex = /\"/;", getGoogleJSStyleWithColumns(16));
1007 verifyFormat("var regex =\n"
1008 " /\"/;",
1009 getGoogleJSStyleWithColumns(15));
Daniel Jasperf7372152015-07-02 14:14:04 +00001010 verifyFormat("var regex = //\n"
1011 " /a/;");
Daniel Jasperf1446202015-07-02 15:00:44 +00001012 verifyFormat("var regexs = [\n"
1013 " /d/, //\n"
1014 " /aa/, //\n"
1015 "];");
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001016}
1017
1018TEST_F(FormatTestJS, RegexLiteralModifiers) {
1019 verifyFormat("var regex = /abc/g;");
1020 verifyFormat("var regex = /abc/i;");
1021 verifyFormat("var regex = /abc/m;");
1022 verifyFormat("var regex = /abc/y;");
1023}
1024
1025TEST_F(FormatTestJS, RegexLiteralLength) {
1026 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
1027 getGoogleJSStyleWithColumns(60));
1028 verifyFormat("var regex =\n"
1029 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
1030 getGoogleJSStyleWithColumns(60));
Daniel Jasper0580ff02014-12-17 09:11:08 +00001031 verifyFormat("var regex = /\\xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
1032 getGoogleJSStyleWithColumns(50));
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001033}
1034
1035TEST_F(FormatTestJS, RegexLiteralExamples) {
1036 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);");
1037}
1038
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001039TEST_F(FormatTestJS, TypeAnnotations) {
1040 verifyFormat("var x: string;");
Daniel Jasperb9a49902016-01-09 15:56:28 +00001041 verifyFormat("var x: {a: string; b: number;} = {};");
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001042 verifyFormat("function x(): string {\n return 'x';\n}");
Manuel Klimek79e06082015-05-21 12:23:34 +00001043 verifyFormat("function x(): {x: string} {\n return {x: 'x'};\n}");
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001044 verifyFormat("function x(y: string): string {\n return 'x';\n}");
1045 verifyFormat("for (var y: string in x) {\n x();\n}");
Daniel Jasperb7fda112016-02-11 13:24:15 +00001046 verifyFormat("for (var y: string of x) {\n x();\n}");
Daniel Jasperb9a49902016-01-09 15:56:28 +00001047 verifyFormat("function x(y: {a?: number;} = {}): number {\n"
1048 " return 12;\n"
1049 "}");
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001050 verifyFormat("((a: string, b: number): string => a + b);");
1051 verifyFormat("var x: (y: number) => string;");
1052 verifyFormat("var x: P<string, (a: number) => string>;");
Daniel Jasper28d8a5a2016-09-07 23:01:13 +00001053 verifyFormat("var x = {\n"
1054 " y: function(): z {\n"
1055 " return 1;\n"
1056 " }\n"
1057 "};");
1058 verifyFormat("var x = {\n"
1059 " y: function(): {a: number} {\n"
1060 " return 1;\n"
1061 " }\n"
1062 "};");
Daniel Jasperf412e262016-01-08 10:51:24 +00001063 verifyFormat("function someFunc(args: string[]):\n"
1064 " {longReturnValue: string[]} {}",
1065 getGoogleJSStyleWithColumns(60));
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001066}
1067
Daniel Jasper91b1d1a2016-03-21 17:57:31 +00001068TEST_F(FormatTestJS, UnionIntersectionTypes) {
1069 verifyFormat("let x: A|B = A | B;");
1070 verifyFormat("let x: A&B|C = A & B;");
1071 verifyFormat("let x: Foo<A|B> = new Foo<A|B>();");
1072 verifyFormat("function(x: A|B): C&D {}");
1073 verifyFormat("function(x: A|B = A | B): C&D {}");
Martin Probst2ec23242016-06-09 22:49:04 +00001074 verifyFormat("function x(path: number|string) {}");
1075 verifyFormat("function x(): string|number {}");
Martin Probst1b7f9802016-06-23 19:52:32 +00001076 verifyFormat("type Foo = Bar|Baz;");
1077 verifyFormat("type Foo = Bar<X>|Baz;");
1078 verifyFormat("type Foo = (Bar<X>|Baz);");
1079 verifyFormat("let x: Bar|Baz;");
1080 verifyFormat("let x: Bar<X>|Baz;");
1081 verifyFormat("let x: (Foo|Bar)[];");
Daniel Jasper91b1d1a2016-03-21 17:57:31 +00001082}
1083
Daniel Jasper83709082015-02-18 17:14:05 +00001084TEST_F(FormatTestJS, ClassDeclarations) {
1085 verifyFormat("class C {\n x: string = 12;\n}");
1086 verifyFormat("class C {\n x(): string => 12;\n}");
1087 verifyFormat("class C {\n ['x' + 2]: string = 12;\n}");
1088 verifyFormat("class C {\n private x: string = 12;\n}");
1089 verifyFormat("class C {\n private static x: string = 12;\n}");
Daniel Jasper28d8a5a2016-09-07 23:01:13 +00001090 verifyFormat("class C {\n static x(): string {\n return 'asd';\n }\n}");
Daniel Jasper83709082015-02-18 17:14:05 +00001091 verifyFormat("class C extends P implements I {}");
Daniel Jasper6a5d38d2015-04-13 14:56:54 +00001092 verifyFormat("class C extends p.P implements i.I {}");
Daniel Jasperb9a52812015-07-10 13:39:26 +00001093 verifyFormat("class Test {\n"
1094 " aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaaa):\n"
1095 " aaaaaaaaaaaaaaaaaaaaaa {}\n"
1096 "}");
Daniel Jasperd5ec65b2016-01-08 07:06:07 +00001097 verifyFormat("foo = class Name {\n"
1098 " constructor() {}\n"
1099 "};");
1100 verifyFormat("foo = class {\n"
1101 " constructor() {}\n"
1102 "};");
Daniel Jasperb9a49902016-01-09 15:56:28 +00001103 verifyFormat("class C {\n"
1104 " x: {y: Z;} = {};\n"
1105 " private y: {y: Z;} = {};\n"
1106 "}");
Daniel Jasper81dbb562015-06-03 08:43:18 +00001107
1108 // ':' is not a type declaration here.
1109 verifyFormat("class X {\n"
1110 " subs = {\n"
1111 " 'b': {\n"
1112 " 'c': 1,\n"
1113 " },\n"
1114 " };\n"
1115 "}");
Daniel Jasper64650082016-06-14 11:28:02 +00001116 verifyFormat("@Component({\n"
1117 " moduleId: module.id,\n"
1118 "})\n"
1119 "class SessionListComponent implements OnDestroy, OnInit {\n"
1120 "}");
Daniel Jasper83709082015-02-18 17:14:05 +00001121}
1122
Daniel Jasper29647492015-05-05 08:12:50 +00001123TEST_F(FormatTestJS, InterfaceDeclarations) {
1124 verifyFormat("interface I {\n"
1125 " x: string;\n"
Daniel Jasper6f5a1932015-12-29 08:54:23 +00001126 " enum: string[];\n"
Daniel Jasper87379302016-02-03 05:33:44 +00001127 " enum?: string[];\n"
Daniel Jasper259188b2015-06-12 04:56:34 +00001128 "}\n"
1129 "var y;");
Daniel Jasper5c235c02015-07-06 14:26:04 +00001130 // Ensure that state is reset after parsing the interface.
1131 verifyFormat("interface a {}\n"
1132 "export function b() {}\n"
1133 "var x;");
Daniel Jasperb542f9f2015-12-22 15:48:35 +00001134
1135 // Arrays of object type literals.
1136 verifyFormat("interface I {\n"
1137 " o: {}[];\n"
1138 "}");
Daniel Jasper29647492015-05-05 08:12:50 +00001139}
1140
Daniel Jasper90cf3802015-06-17 09:44:02 +00001141TEST_F(FormatTestJS, EnumDeclarations) {
1142 verifyFormat("enum Foo {\n"
Daniel Jasper9f4ec152015-06-17 09:44:07 +00001143 " A = 1,\n"
1144 " B\n"
1145 "}");
1146 verifyFormat("export /* somecomment*/ enum Foo {\n"
1147 " A = 1,\n"
1148 " B\n"
1149 "}");
1150 verifyFormat("enum Foo {\n"
Daniel Jasper90cf3802015-06-17 09:44:02 +00001151 " A = 1, // comment\n"
1152 " B\n"
1153 "}\n"
1154 "var x = 1;");
1155}
1156
Daniel Jasper3c42dba2015-02-18 17:17:15 +00001157TEST_F(FormatTestJS, MetadataAnnotations) {
1158 verifyFormat("@A\nclass C {\n}");
1159 verifyFormat("@A({arg: 'value'})\nclass C {\n}");
1160 verifyFormat("@A\n@B\nclass C {\n}");
1161 verifyFormat("class C {\n @A x: string;\n}");
1162 verifyFormat("class C {\n"
1163 " @A\n"
1164 " private x(): string {\n"
1165 " return 'y';\n"
1166 " }\n"
1167 "}");
Martin Probst716a5332016-04-11 09:17:57 +00001168 verifyFormat("class C {\n"
1169 " private x(@A x: string) {}\n"
1170 "}");
Daniel Jasper6fa9ec72015-02-19 16:03:16 +00001171 verifyFormat("class X {}\n"
1172 "class Y {}");
Daniel Jasper3c42dba2015-02-18 17:17:15 +00001173}
1174
Martin Probst805c6162016-04-19 14:59:16 +00001175TEST_F(FormatTestJS, TypeAliases) {
1176 verifyFormat("type X = number;\n"
1177 "class C {}");
1178 verifyFormat("type X<Y> = Z<Y>;");
1179 verifyFormat("type X = {\n"
1180 " y: number\n"
1181 "};\n"
1182 "class C {}");
1183}
1184
Daniel Jasper354aa512015-02-19 16:07:32 +00001185TEST_F(FormatTestJS, Modules) {
1186 verifyFormat("import SomeThing from 'some/module.js';");
1187 verifyFormat("import {X, Y} from 'some/module.js';");
Daniel Jasperefc1a832016-01-07 08:53:35 +00001188 verifyFormat("import a, {X, Y} from 'some/module.js';");
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +00001189 verifyFormat("import {X, Y,} from 'some/module.js';");
Daniel Jasper354aa512015-02-19 16:07:32 +00001190 verifyFormat("import {X as myLocalX, Y as myLocalY} from 'some/module.js';");
Martin Probst48622092016-06-01 15:22:47 +00001191 // Ensure Automatic Semicolon Insertion does not break on "as\n".
1192 verifyFormat("import {X as myX} from 'm';", "import {X as\n"
1193 " myX} from 'm';");
Daniel Jasper354aa512015-02-19 16:07:32 +00001194 verifyFormat("import * as lib from 'some/module.js';");
Daniel Jasper60948b12015-03-15 13:55:54 +00001195 verifyFormat("var x = {import: 1};\nx.import = 2;");
Daniel Jasperfca735c2015-02-19 16:14:18 +00001196
1197 verifyFormat("export function fn() {\n"
1198 " return 'fn';\n"
1199 "}");
Daniel Jasper20580fd2015-06-11 13:31:45 +00001200 verifyFormat("export function A() {}\n"
1201 "export default function B() {}\n"
1202 "export function C() {}");
Martin Probst053f1aa2016-04-19 14:55:37 +00001203 verifyFormat("export default () => {\n"
1204 " let x = 1;\n"
1205 " return x;\n"
1206 "}");
Daniel Jasper354aa512015-02-19 16:07:32 +00001207 verifyFormat("export const x = 12;");
1208 verifyFormat("export default class X {}");
Daniel Jasperfca735c2015-02-19 16:14:18 +00001209 verifyFormat("export {X, Y} from 'some/module.js';");
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +00001210 verifyFormat("export {X, Y,} from 'some/module.js';");
1211 verifyFormat("export {SomeVeryLongExport as X, "
1212 "SomeOtherVeryLongExport as Y} from 'some/module.js';");
1213 // export without 'from' is wrapped.
1214 verifyFormat("export let someRatherLongVariableName =\n"
1215 " someSurprisinglyLongVariable + someOtherRatherLongVar;");
1216 // ... but not if from is just an identifier.
Daniel Jasperfca735c2015-02-19 16:14:18 +00001217 verifyFormat("export {\n"
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +00001218 " from as from,\n"
Martin Probstdce8e412016-06-22 14:35:14 +00001219 " someSurprisinglyLongVariable as\n"
1220 " from\n"
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +00001221 "};",
1222 getGoogleJSStyleWithColumns(20));
Daniel Jasperfca735c2015-02-19 16:14:18 +00001223 verifyFormat("export class C {\n"
1224 " x: number;\n"
1225 " y: string;\n"
1226 "}");
1227 verifyFormat("export class X { y: number; }");
Daniel Jasper8620d4c2016-01-12 06:24:38 +00001228 verifyFormat("export abstract class X { y: number; }");
Daniel Jasperfca735c2015-02-19 16:14:18 +00001229 verifyFormat("export default class X { y: number }");
1230 verifyFormat("export default function() {\n return 1;\n}");
1231 verifyFormat("export var x = 12;");
Daniel Jasper910807d2015-06-12 04:52:02 +00001232 verifyFormat("class C {}\n"
1233 "export function f() {}\n"
1234 "var v;");
Daniel Jasperfca735c2015-02-19 16:14:18 +00001235 verifyFormat("export var x: number = 12;");
1236 verifyFormat("export const y = {\n"
1237 " a: 1,\n"
1238 " b: 2\n"
1239 "};");
Daniel Jasper216c9cd2015-06-12 05:08:18 +00001240 verifyFormat("export enum Foo {\n"
1241 " BAR,\n"
1242 " // adsdasd\n"
1243 " BAZ\n"
1244 "}");
Daniel Jasperb14f6672016-01-04 15:51:56 +00001245 verifyFormat("export default [\n"
1246 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
1247 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n"
1248 "];");
1249 verifyFormat("export default [];");
Daniel Jasper5e271462016-01-04 16:10:36 +00001250 verifyFormat("export default () => {};");
Daniel Jasperf55e4182016-01-11 22:57:40 +00001251 verifyFormat("export interface Foo { foo: number; }\n"
1252 "export class Bar {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +00001253 " blah(): string {\n"
1254 " return this.blah;\n"
1255 " };\n"
Daniel Jasperf55e4182016-01-11 22:57:40 +00001256 "}");
Daniel Jasper354aa512015-02-19 16:07:32 +00001257}
1258
Martin Probst0cd74ee2016-06-13 16:39:50 +00001259TEST_F(FormatTestJS, ImportWrapping) {
1260 verifyFormat("import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying,"
1261 " VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying"
1262 "} from 'some/module.js';");
1263 FormatStyle Style = getGoogleJSStyleWithColumns(80);
1264 Style.JavaScriptWrapImports = true;
1265 verifyFormat("import {\n"
1266 " VeryLongImportsAreAnnoying,\n"
1267 " VeryLongImportsAreAnnoying,\n"
1268 " VeryLongImportsAreAnnoying,\n"
1269 "} from 'some/module.js';",
1270 Style);
1271 verifyFormat("import {\n"
1272 " A,\n"
1273 " A,\n"
1274 "} from 'some/module.js';",
1275 Style);
1276 verifyFormat("export {\n"
1277 " A,\n"
1278 " A,\n"
1279 "} from 'some/module.js';",
1280 Style);
1281}
1282
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001283TEST_F(FormatTestJS, TemplateStrings) {
1284 // Keeps any whitespace/indentation within the template string.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001285 verifyFormat("var x = `hello\n"
Martin Probst6181da42016-08-25 10:13:21 +00001286 " ${name}\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001287 " !`;",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001288 "var x = `hello\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001289 " ${ name }\n"
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001290 " !`;");
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001291
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001292 verifyFormat("var x =\n"
1293 " `hello ${world}` >= some();",
1294 getGoogleJSStyleWithColumns(34)); // Barely doesn't fit.
1295 verifyFormat("var x = `hello ${world}` >= some();",
Daniel Jasper553a5b02015-07-02 13:08:28 +00001296 getGoogleJSStyleWithColumns(35)); // Barely fits.
Martin Probste71b4cb2016-05-17 06:29:29 +00001297 verifyFormat("var x = `hellö ${wörld}` >= söme();",
1298 getGoogleJSStyleWithColumns(35)); // Fits due to UTF-8.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001299 verifyFormat("var x = `hello\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001300 " ${world}` >=\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +00001301 " some();",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001302 "var x =\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001303 " `hello\n"
1304 " ${world}` >= some();",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001305 getGoogleJSStyleWithColumns(21)); // Barely doesn't fit.
1306 verifyFormat("var x = `hello\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001307 " ${world}` >= some();",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001308 "var x =\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001309 " `hello\n"
1310 " ${world}` >= some();",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001311 getGoogleJSStyleWithColumns(22)); // Barely fits.
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001312
Daniel Jasper553a5b02015-07-02 13:08:28 +00001313 verifyFormat("var x =\n"
1314 " `h`;",
1315 getGoogleJSStyleWithColumns(11));
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001316 verifyFormat("var x =\n `multi\n line`;", "var x = `multi\n line`;",
1317 getGoogleJSStyleWithColumns(13));
Daniel Jasper553a5b02015-07-02 13:08:28 +00001318 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
1319 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`);");
Martin Probste71b4cb2016-05-17 06:29:29 +00001320 // Repro for an obscure width-miscounting issue with template strings.
1321 verifyFormat(
1322 "someLongVariable =\n"
1323 " "
1324 "`${logPrefix[11]}/${logPrefix[12]}/${logPrefix[13]}${logPrefix[14]}`;",
1325 "someLongVariable = "
1326 "`${logPrefix[11]}/${logPrefix[12]}/${logPrefix[13]}${logPrefix[14]}`;");
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001327
Daniel Jasperf69b9222015-05-02 08:05:38 +00001328 // Make sure template strings get a proper ColumnWidth assigned, even if they
1329 // are first token in line.
1330 verifyFormat(
1331 "var a = aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +00001332 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`;");
Daniel Jasperf69b9222015-05-02 08:05:38 +00001333
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001334 // Two template strings.
1335 verifyFormat("var x = `hello` == `hello`;");
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001336
1337 // Comments in template strings.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001338 verifyFormat("var x = `//a`;\n"
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001339 "var y;",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001340 "var x =\n `//a`;\n"
1341 "var y ;");
1342 verifyFormat("var x = `/*a`;\n"
1343 "var y;",
1344 "var x =\n `/*a`;\n"
1345 "var y;");
Daniel Jasper2ebb0c52015-06-14 07:16:57 +00001346 // Unterminated string literals in a template string.
1347 verifyFormat("var x = `'`; // comment with matching quote '\n"
1348 "var y;");
1349 verifyFormat("var x = `\"`; // comment with matching quote \"\n"
1350 "var y;");
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001351 verifyFormat("it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa);",
1352 "it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa) ;",
1353 getGoogleJSStyleWithColumns(40));
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001354 // Backticks in a comment - not a template string.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001355 verifyFormat("var x = 1 // `/*a`;\n"
1356 " ;",
1357 "var x =\n 1 // `/*a`;\n"
1358 " ;");
1359 verifyFormat("/* ` */ var x = 1; /* ` */", "/* ` */ var x\n= 1; /* ` */");
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001360 // Comment spans multiple template strings.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001361 verifyFormat("var x = `/*a`;\n"
1362 "var y = ` */ `;",
1363 "var x =\n `/*a`;\n"
1364 "var y =\n ` */ `;");
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001365 // Escaped backtick.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001366 verifyFormat("var x = ` \\` a`;\n"
1367 "var y;",
1368 "var x = ` \\` a`;\n"
1369 "var y;");
Martin Probst6181da42016-08-25 10:13:21 +00001370 // Escaped dollar.
1371 verifyFormat("var x = ` \\${foo}`;\n");
1372}
1373
Martin Probst717f6dc2016-10-21 05:11:38 +00001374TEST_F(FormatTestJS, TemplateStringASI) {
1375 verifyFormat("var x = `hello${world}`;", "var x = `hello${\n"
1376 " world\n"
1377 "}`;");
1378}
1379
Martin Probst6181da42016-08-25 10:13:21 +00001380TEST_F(FormatTestJS, NestedTemplateStrings) {
1381 verifyFormat(
1382 "var x = `<ul>${xs.map(x => `<li>${x}</li>`).join('\\n')}</ul>`;");
1383 verifyFormat("var x = `he${({text: 'll'}.text)}o`;");
Daniel Jasper58209dd2016-09-17 07:20:36 +00001384
1385 // Crashed at some point.
1386 verifyFormat("}");
Martin Probst6181da42016-08-25 10:13:21 +00001387}
1388
1389TEST_F(FormatTestJS, TaggedTemplateStrings) {
1390 verifyFormat("var x = html`<ul>`;");
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001391}
1392
Martin Probst805c6162016-04-19 14:59:16 +00001393TEST_F(FormatTestJS, CastSyntax) {
1394 verifyFormat("var x = <type>foo;");
1395 verifyFormat("var x = foo as type;");
Martin Probstdce8e412016-06-22 14:35:14 +00001396 verifyFormat("let x = (a + b) as\n"
1397 " LongTypeIsLong;",
1398 getGoogleJSStyleWithColumns(20));
Daniel Jasper887a3992016-06-14 13:54:38 +00001399 verifyFormat("foo = <Bar[]>[\n"
1400 " 1, //\n"
1401 " 2\n"
1402 "];");
Martin Probste1e12a72016-08-19 14:35:01 +00001403 verifyFormat("var x = [{x: 1} as type];");
Martin Probsted87d782016-08-22 14:23:30 +00001404 verifyFormat("x = x as [a, b];");
1405 verifyFormat("x = x as {a: string};");
1406 verifyFormat("x = x as (string);");
Martin Probst34ecf422016-09-06 18:55:34 +00001407 verifyFormat("x = x! as (string);");
Martin Probst805c6162016-04-19 14:59:16 +00001408}
Daniel Jasperbc46b932015-03-15 13:59:51 +00001409
1410TEST_F(FormatTestJS, TypeArguments) {
1411 verifyFormat("class X<Y> {}");
1412 verifyFormat("new X<Y>();");
1413 verifyFormat("foo<Y>(a);");
1414 verifyFormat("var x: X<Y>[];");
1415 verifyFormat("class C extends D<E> implements F<G>, H<I> {}");
Daniel Jasper20580fd2015-06-11 13:31:45 +00001416 verifyFormat("function f(a: List<any> = null) {}");
1417 verifyFormat("function f(): List<any> {}");
Daniel Jasper5a3de1d2015-07-03 10:37:23 +00001418 verifyFormat("function aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa():\n"
1419 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb {}");
Daniel Jasper6501f7e2015-10-27 12:38:37 +00001420 verifyFormat("function aaaaaaaaaa(\n"
1421 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa,\n"
1422 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa):\n"
Daniel Jasperb2328b12015-07-06 14:07:51 +00001423 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa {}");
Daniel Jasperbc46b932015-03-15 13:59:51 +00001424}
1425
Daniel Jasper779c66f2015-12-30 08:00:58 +00001426TEST_F(FormatTestJS, UserDefinedTypeGuards) {
1427 verifyFormat(
1428 "function foo(check: Object):\n"
1429 " check is {foo: string, bar: string, baz: string, foobar: string} {\n"
1430 " return 'bar' in check;\n"
1431 "}\n");
1432}
1433
Daniel Jaspera74f5072015-04-13 15:01:40 +00001434TEST_F(FormatTestJS, OptionalTypes) {
Daniel Jasper20580fd2015-06-11 13:31:45 +00001435 verifyFormat("function x(a?: b, c?, d?) {}");
Daniel Jaspera74f5072015-04-13 15:01:40 +00001436 verifyFormat("class X {\n"
1437 " y?: z;\n"
1438 " z?;\n"
1439 "}");
Daniel Jasper9326f912015-05-05 08:40:32 +00001440 verifyFormat("interface X {\n"
1441 " y?(): z;\n"
1442 "}");
Daniel Jasper3e0dcc22015-05-27 05:37:40 +00001443 verifyFormat("constructor({aa}: {\n"
1444 " aa?: string,\n"
1445 " aaaaaaaa?: string,\n"
1446 " aaaaaaaaaaaaaaa?: boolean,\n"
1447 " aaaaaa?: List<string>\n"
Daniel Jasper20580fd2015-06-11 13:31:45 +00001448 "}) {}");
Daniel Jaspera74f5072015-04-13 15:01:40 +00001449}
1450
Daniel Jasperd9309772015-04-13 15:03:30 +00001451TEST_F(FormatTestJS, IndexSignature) {
1452 verifyFormat("var x: {[k: string]: v};");
1453}
1454
Daniel Jasper6501f7e2015-10-27 12:38:37 +00001455TEST_F(FormatTestJS, WrapAfterParen) {
1456 verifyFormat("xxxxxxxxxxx(\n"
1457 " aaa, aaa);",
1458 getGoogleJSStyleWithColumns(20));
1459 verifyFormat("xxxxxxxxxxx(\n"
1460 " aaa, aaa, aaa,\n"
1461 " aaa, aaa, aaa);",
1462 getGoogleJSStyleWithColumns(20));
1463 verifyFormat("xxxxxxxxxxx(\n"
1464 " aaaaaaaaaaaaaaaaaaaaaaaa,\n"
1465 " function(x) {\n"
1466 " y(); //\n"
1467 " });",
1468 getGoogleJSStyleWithColumns(40));
1469 verifyFormat("while (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n"
1470 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}");
1471}
1472
Daniel Jasperd196abb2016-01-08 08:14:58 +00001473TEST_F(FormatTestJS, JSDocAnnotations) {
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001474 verifyFormat("/**\n"
1475 " * @export {this.is.a.long.path.to.a.Type}\n"
1476 " */",
1477 "/**\n"
1478 " * @export {this.is.a.long.path.to.a.Type}\n"
1479 " */",
1480 getGoogleJSStyleWithColumns(20));
Daniel Jasperd196abb2016-01-08 08:14:58 +00001481}
1482
Daniel Jasperabd1f572016-03-02 22:44:03 +00001483TEST_F(FormatTestJS, RequoteStringsSingle) {
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001484 verifyFormat("var x = 'foo';", "var x = \"foo\";");
1485 verifyFormat("var x = 'fo\\'o\\'';", "var x = \"fo'o'\";");
1486 verifyFormat("var x = 'fo\\'o\\'';", "var x = \"fo\\'o'\";");
1487 verifyFormat(
1488 "var x =\n"
1489 " 'foo\\'';",
1490 // Code below is 15 chars wide, doesn't fit into the line with the
1491 // \ escape added.
1492 "var x = \"foo'\";", getGoogleJSStyleWithColumns(15));
Daniel Jasperabd1f572016-03-02 22:44:03 +00001493 // Removes no-longer needed \ escape from ".
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001494 verifyFormat("var x = 'fo\"o';", "var x = \"fo\\\"o\";");
Daniel Jasperabd1f572016-03-02 22:44:03 +00001495 // Code below fits into 15 chars *after* removing the \ escape.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001496 verifyFormat("var x = 'fo\"o';", "var x = \"fo\\\"o\";",
1497 getGoogleJSStyleWithColumns(15));
Martin Probsta1669792016-05-12 11:20:32 +00001498 verifyFormat("// clang-format off\n"
1499 "let x = \"double\";\n"
1500 "// clang-format on\n"
1501 "let x = 'single';\n",
1502 "// clang-format off\n"
1503 "let x = \"double\";\n"
1504 "// clang-format on\n"
1505 "let x = \"single\";\n");
Daniel Jasperabd1f572016-03-02 22:44:03 +00001506}
1507
Martin Probsta9855af2016-09-02 14:29:48 +00001508TEST_F(FormatTestJS, RequoteAndIndent) {
1509 verifyFormat("let x = someVeryLongFunctionThatGoesOnAndOn(\n"
1510 " 'double quoted string that needs wrapping');",
1511 "let x = someVeryLongFunctionThatGoesOnAndOn("
1512 "\"double quoted string that needs wrapping\");");
Daniel Jasper496c1992016-09-07 22:48:53 +00001513
1514 verifyFormat("let x =\n"
1515 " 'foo\\'oo';\n"
1516 "let x =\n"
1517 " 'foo\\'oo';",
1518 "let x=\"foo'oo\";\n"
1519 "let x=\"foo'oo\";",
1520 getGoogleJSStyleWithColumns(15));
Martin Probsta9855af2016-09-02 14:29:48 +00001521}
1522
Daniel Jasperabd1f572016-03-02 22:44:03 +00001523TEST_F(FormatTestJS, RequoteStringsDouble) {
1524 FormatStyle DoubleQuotes = getGoogleStyle(FormatStyle::LK_JavaScript);
1525 DoubleQuotes.JavaScriptQuotes = FormatStyle::JSQS_Double;
1526 verifyFormat("var x = \"foo\";", DoubleQuotes);
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001527 verifyFormat("var x = \"foo\";", "var x = 'foo';", DoubleQuotes);
1528 verifyFormat("var x = \"fo'o\";", "var x = 'fo\\'o';", DoubleQuotes);
Daniel Jasperabd1f572016-03-02 22:44:03 +00001529}
1530
1531TEST_F(FormatTestJS, RequoteStringsLeave) {
1532 FormatStyle LeaveQuotes = getGoogleStyle(FormatStyle::LK_JavaScript);
1533 LeaveQuotes.JavaScriptQuotes = FormatStyle::JSQS_Leave;
1534 verifyFormat("var x = \"foo\";", LeaveQuotes);
1535 verifyFormat("var x = 'foo';", LeaveQuotes);
1536}
1537
Martin Probst7ea9b6d2016-05-29 14:41:36 +00001538TEST_F(FormatTestJS, SupportShebangLines) {
1539 verifyFormat("#!/usr/bin/env node\n"
1540 "var x = hello();",
1541 "#!/usr/bin/env node\n"
1542 "var x = hello();");
1543}
1544
Martin Probst0eb40cf2016-06-13 00:49:54 +00001545TEST_F(FormatTestJS, NonNullAssertionOperator) {
1546 verifyFormat("let x = foo!.bar();\n");
1547 verifyFormat("let x = foo ? bar! : baz;\n");
1548 verifyFormat("let x = !foo;\n");
1549 verifyFormat("let x = foo[0]!;\n");
1550 verifyFormat("let x = (foo)!;\n");
Daniel Jasper8315ea12016-11-09 14:12:55 +00001551 verifyFormat("let x = foo! - 1;\n");
Martin Probst0eb40cf2016-06-13 00:49:54 +00001552 verifyFormat("let x = {foo: 1}!;\n");
1553}
1554
Martin Probst31d6da72016-06-23 21:51:49 +00001555TEST_F(FormatTestJS, Conditional) {
1556 verifyFormat("y = x ? 1 : 2;");
Daniel Jasperd9d8da22016-07-12 15:45:53 +00001557 verifyFormat("x ? 1 : 2;");
Martin Probst31d6da72016-06-23 21:51:49 +00001558 verifyFormat("class Foo {\n"
1559 " field = true ? 1 : 2;\n"
1560 " method(a = true ? 1 : 2) {}\n"
1561 "}");
1562}
1563
Martin Probstfbbe75b2016-09-18 17:33:51 +00001564TEST_F(FormatTestJS, ImportComments) {
1565 verifyFormat("import {x} from 'x'; // from some location",
1566 getGoogleJSStyleWithColumns(25));
1567 verifyFormat("// taze: x from 'location'", getGoogleJSStyleWithColumns(10));
1568}
1569
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001570} // end namespace tooling
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +00001571} // end namespace clang