blob: e6827296e1264ffe3ecd35065ebc226069fb0cd5 [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));
Krasimir Georgievbcda54b2017-04-21 14:35:20 +000027 FormattingAttemptStatus Status;
Daniel Jasper56691b82015-06-11 13:29:20 +000028 tooling::Replacements Replaces =
Krasimir Georgievbcda54b2017-04-21 14:35:20 +000029 reformat(Style, Code, Ranges, "<stdin>", &Status);
30 EXPECT_TRUE(Status.FormatComplete);
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
Krasimir Georgiev22d7e6b2017-07-20 22:29:39 +000070TEST_F(FormatTestJS, JSDocComments) {
71 // Break the first line of a multiline jsdoc comment.
72 EXPECT_EQ("/**\n"
73 " * jsdoc line 1\n"
74 " * jsdoc line 2\n"
75 " */",
76 format("/** jsdoc line 1\n"
77 " * jsdoc line 2\n"
78 " */",
79 getGoogleJSStyleWithColumns(20)));
80 // Both break after '/**' and break the line itself.
81 EXPECT_EQ("/**\n"
82 " * jsdoc line long\n"
83 " * long jsdoc line 2\n"
84 " */",
85 format("/** jsdoc line long long\n"
86 " * jsdoc line 2\n"
87 " */",
88 getGoogleJSStyleWithColumns(20)));
89 // Break a short first line if the ending '*/' is on a newline.
90 EXPECT_EQ("/**\n"
91 " * jsdoc line 1\n"
92 " */",
93 format("/** jsdoc line 1\n"
94 " */", getGoogleJSStyleWithColumns(20)));
95 // Don't break the first line of a short single line jsdoc comment.
96 EXPECT_EQ("/** jsdoc line 1 */",
97 format("/** jsdoc line 1 */", getGoogleJSStyleWithColumns(20)));
98 // Don't break the first line of a single line jsdoc comment if it just fits
99 // the column limit.
100 EXPECT_EQ("/** jsdoc line 12 */",
101 format("/** jsdoc line 12 */", getGoogleJSStyleWithColumns(20)));
102 // Don't break after '/**' and before '*/' if there is no space between
103 // '/**' and the content.
104 EXPECT_EQ(
105 "/*** nonjsdoc long\n"
106 " * line */",
107 format("/*** nonjsdoc long line */", getGoogleJSStyleWithColumns(20)));
108 EXPECT_EQ(
109 "/**strange long long\n"
110 " * line */",
111 format("/**strange long long line */", getGoogleJSStyleWithColumns(20)));
112 // Break the first line of a single line jsdoc comment if it just exceeds the
113 // column limit.
114 EXPECT_EQ("/**\n"
115 " * jsdoc line 123\n"
116 " */",
117 format("/** jsdoc line 123 */", getGoogleJSStyleWithColumns(20)));
118 // Break also if the leading indent of the first line is more than 1 column.
119 EXPECT_EQ("/**\n"
120 " * jsdoc line 123\n"
121 " */",
122 format("/** jsdoc line 123 */", getGoogleJSStyleWithColumns(20)));
123 // Break also if the leading indent of the first line is more than 1 column.
124 EXPECT_EQ("/**\n"
125 " * jsdoc line 123\n"
126 " */",
127 format("/** jsdoc line 123 */", getGoogleJSStyleWithColumns(20)));
128 // Break after the content of the last line.
129 EXPECT_EQ("/**\n"
130 " * line 1\n"
131 " * line 2\n"
132 " */",
133 format("/**\n"
134 " * line 1\n"
135 " * line 2 */",
136 getGoogleJSStyleWithColumns(20)));
137 // Break both the content and after the content of the last line.
138 EXPECT_EQ("/**\n"
139 " * line 1\n"
140 " * line long long\n"
141 " * long\n"
142 " */",
143 format("/**\n"
144 " * line 1\n"
145 " * line long long long */",
146 getGoogleJSStyleWithColumns(20)));
147
148 // The comment block gets indented.
149 EXPECT_EQ("function f() {\n"
150 " /**\n"
151 " * comment about\n"
152 " * x\n"
153 " */\n"
154 " var x = 1;\n"
155 "}",
156 format("function f() {\n"
157 "/** comment about x */\n"
158 "var x = 1;\n"
159 "}",
160 getGoogleJSStyleWithColumns(20)));
Krasimir Georgiev3b865342017-08-09 09:42:32 +0000161
162 // Don't break the first line of a single line short jsdoc comment pragma.
163 EXPECT_EQ("/** @returns j */",
164 format("/** @returns j */",
165 getGoogleJSStyleWithColumns(20)));
166
167 // Break a single line long jsdoc comment pragma.
168 EXPECT_EQ("/**\n"
169 " * @returns {string} jsdoc line 12\n"
170 " */",
171 format("/** @returns {string} jsdoc line 12 */",
172 getGoogleJSStyleWithColumns(20)));
173
174 EXPECT_EQ("/**\n"
175 " * @returns {string} jsdoc line 12\n"
176 " */",
177 format("/** @returns {string} jsdoc line 12 */",
178 getGoogleJSStyleWithColumns(20)));
179
180 EXPECT_EQ("/**\n"
181 " * @returns {string} jsdoc line 12\n"
182 " */",
183 format("/** @returns {string} jsdoc line 12*/",
184 getGoogleJSStyleWithColumns(20)));
185
186 // Fix a multiline jsdoc comment ending in a comment pragma.
187 EXPECT_EQ("/**\n"
188 " * line 1\n"
189 " * line 2\n"
190 " * @returns {string} jsdoc line 12\n"
191 " */",
192 format("/** line 1\n"
193 " * line 2\n"
194 " * @returns {string} jsdoc line 12 */",
195 getGoogleJSStyleWithColumns(20)));
196
197 EXPECT_EQ("/**\n"
198 " * line 1\n"
199 " * line 2\n"
200 " *\n"
201 " * @returns j\n"
202 " */",
203 format("/** line 1\n"
204 " * line 2\n"
205 " *\n"
206 " * @returns j */",
207 getGoogleJSStyleWithColumns(20)));
Krasimir Georgiev22d7e6b2017-07-20 22:29:39 +0000208}
209
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000210TEST_F(FormatTestJS, UnderstandsJavaScriptOperators) {
211 verifyFormat("a == = b;");
212 verifyFormat("a != = b;");
213
214 verifyFormat("a === b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +0000215 verifyFormat("aaaaaaa ===\n b;", getGoogleJSStyleWithColumns(10));
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000216 verifyFormat("a !== b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +0000217 verifyFormat("aaaaaaa !==\n b;", getGoogleJSStyleWithColumns(10));
218 verifyFormat("if (a + b + c +\n"
219 " d !==\n"
220 " e + f + g)\n"
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000221 " q();",
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000222 getGoogleJSStyleWithColumns(20));
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000223
224 verifyFormat("a >> >= b;");
225
226 verifyFormat("a >>> b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +0000227 verifyFormat("aaaaaaa >>>\n b;", getGoogleJSStyleWithColumns(10));
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000228 verifyFormat("a >>>= b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +0000229 verifyFormat("aaaaaaa >>>=\n b;", getGoogleJSStyleWithColumns(10));
230 verifyFormat("if (a + b + c +\n"
231 " d >>>\n"
232 " e + f + g)\n"
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000233 " q();",
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000234 getGoogleJSStyleWithColumns(20));
Daniel Jaspere551bb72014-11-05 17:22:31 +0000235 verifyFormat("var x = aaaaaaaaaa ?\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +0000236 " bbbbbb :\n"
237 " ccc;",
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000238 getGoogleJSStyleWithColumns(20));
Daniel Jasper78214392014-05-19 07:27:02 +0000239
240 verifyFormat("var b = a.map((x) => x + 1);");
Daniel Jasper3549ea12014-09-19 10:48:15 +0000241 verifyFormat("return ('aaa') in bbbb;");
Daniel Jasper1ce41112016-02-01 11:20:47 +0000242 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n"
243 " aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
244 FormatStyle Style = getGoogleJSStyleWithColumns(80);
245 Style.AlignOperands = true;
246 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n"
247 " aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
248 Style);
249 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
250 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa()\n"
251 " in aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
252 Style);
Daniel Jasper08051992015-05-26 07:18:56 +0000253
254 // ES6 spread operator.
255 verifyFormat("someFunction(...a);");
256 verifyFormat("var x = [1, ...a, 2];");
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000257}
258
Daniel Jasper3a038de2014-09-05 08:53:45 +0000259TEST_F(FormatTestJS, UnderstandsAmpAmp) {
260 verifyFormat("e && e.SomeFunction();");
261}
262
Daniel Jasper4db69bd2014-09-04 18:23:42 +0000263TEST_F(FormatTestJS, LiteralOperatorsCanBeKeywords) {
264 verifyFormat("not.and.or.not_eq = 1;");
265}
266
Daniel Jasperba52fcb2015-09-28 14:29:45 +0000267TEST_F(FormatTestJS, ReservedWords) {
268 // JavaScript reserved words (aka keywords) are only illegal when used as
269 // Identifiers, but are legal as IdentifierNames.
270 verifyFormat("x.class.struct = 1;");
271 verifyFormat("x.case = 1;");
272 verifyFormat("x.interface = 1;");
Daniel Jasper997cf2f2016-05-20 06:16:01 +0000273 verifyFormat("x.for = 1;");
Daniel Jaspera4607e12016-03-17 12:17:59 +0000274 verifyFormat("x.of() = 1;");
Martin Probstc4a3d082017-04-05 10:56:07 +0000275 verifyFormat("of(null);");
276 verifyFormat("import {of} from 'x';");
Daniel Jaspera4607e12016-03-17 12:17:59 +0000277 verifyFormat("x.in() = 1;");
278 verifyFormat("x.let() = 1;");
279 verifyFormat("x.var() = 1;");
Daniel Jasper4d67dd72016-11-01 06:22:54 +0000280 verifyFormat("x.for() = 1;");
Daniel Jasperb559b432016-11-01 06:23:10 +0000281 verifyFormat("x.as() = 1;");
Daniel Jasperba52fcb2015-09-28 14:29:45 +0000282 verifyFormat("x = {\n"
283 " a: 12,\n"
284 " interface: 1,\n"
285 " switch: 1,\n"
286 "};");
Daniel Jasper09840ef2015-11-20 15:58:50 +0000287 verifyFormat("var struct = 2;");
288 verifyFormat("var union = 2;");
Martin Probst1e8261e2016-04-19 18:18:59 +0000289 verifyFormat("var interface = 2;");
290 verifyFormat("interface = 2;");
291 verifyFormat("x = interface instanceof y;");
Martin Probstf785fd92017-08-04 17:07:15 +0000292 verifyFormat("interface Test {\n"
293 " x: string;\n"
294 " switch: string;\n"
295 " case: string;\n"
296 " default: string;\n"
297 "}\n");
Daniel Jasperba52fcb2015-09-28 14:29:45 +0000298}
299
Martin Probst4210d2f2016-09-22 07:18:00 +0000300TEST_F(FormatTestJS, ReservedWordsMethods) {
301 verifyFormat(
302 "class X {\n"
303 " delete() {\n"
304 " x();\n"
305 " }\n"
306 " interface() {\n"
307 " x();\n"
308 " }\n"
309 " let() {\n"
310 " x();\n"
311 " }\n"
312 "}\n");
313}
314
Martin Probst22e00f02017-08-01 17:22:15 +0000315TEST_F(FormatTestJS, ReservedWordsParenthesized) {
316 // All of these are statements using the keyword, not function calls.
317 verifyFormat("throw (x + y);\n"
318 "await (await x).y;\n"
Martin Probst9926abb2017-08-01 17:42:16 +0000319 "typeof (x) === 'string';\n"
Martin Probst22e00f02017-08-01 17:22:15 +0000320 "void (0);\n"
321 "delete (x.y);\n"
322 "return (x);\n");
323}
324
Daniel Jasper72a1b6a2015-12-22 15:47:56 +0000325TEST_F(FormatTestJS, CppKeywords) {
326 // Make sure we don't mess stuff up because of C++ keywords.
327 verifyFormat("return operator && (aa);");
Daniel Jasper72b33572017-03-31 12:04:37 +0000328 // .. or QT ones.
329 verifyFormat("slots: Slot[];");
Daniel Jasper72a1b6a2015-12-22 15:47:56 +0000330}
331
Daniel Jasper0dd52912014-05-19 07:37:07 +0000332TEST_F(FormatTestJS, ES6DestructuringAssignment) {
333 verifyFormat("var [a, b, c] = [1, 2, 3];");
Daniel Jasper5dbcd3b2016-05-19 07:18:07 +0000334 verifyFormat("const [a, b, c] = [1, 2, 3];");
Daniel Jasper9f642f72015-09-28 14:28:08 +0000335 verifyFormat("let [a, b, c] = [1, 2, 3];");
Daniel Jasper60948b12015-03-15 13:55:54 +0000336 verifyFormat("var {a, b} = {a: 1, b: 2};");
Daniel Jasper9f642f72015-09-28 14:28:08 +0000337 verifyFormat("let {a, b} = {a: 1, b: 2};");
Daniel Jasper0dd52912014-05-19 07:37:07 +0000338}
339
Daniel Jasper17062ff2014-06-10 14:44:02 +0000340TEST_F(FormatTestJS, ContainerLiterals) {
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000341 verifyFormat("var x = {\n"
342 " y: function(a) {\n"
343 " return a;\n"
344 " }\n"
345 "};");
Daniel Jasper17062ff2014-06-10 14:44:02 +0000346 verifyFormat("return {\n"
347 " link: function() {\n"
348 " f(); //\n"
349 " }\n"
350 "};");
351 verifyFormat("return {\n"
352 " a: a,\n"
353 " link: function() {\n"
354 " f(); //\n"
355 " }\n"
356 "};");
357 verifyFormat("return {\n"
358 " a: a,\n"
Daniel Jasper90ebc982014-09-05 09:27:38 +0000359 " link: function() {\n"
360 " f(); //\n"
361 " },\n"
362 " link: function() {\n"
363 " f(); //\n"
364 " }\n"
Daniel Jasper17062ff2014-06-10 14:44:02 +0000365 "};");
Daniel Jasper94e11d02014-09-04 14:58:30 +0000366 verifyFormat("var stuff = {\n"
367 " // comment for update\n"
368 " update: false,\n"
369 " // comment for modules\n"
370 " modules: false,\n"
371 " // comment for tasks\n"
372 " tasks: false\n"
373 "};");
Daniel Jasper97bfb7b2014-09-05 08:29:31 +0000374 verifyFormat("return {\n"
375 " 'finish':\n"
376 " //\n"
377 " a\n"
378 "};");
Daniel Jasper40874322014-11-27 15:24:48 +0000379 verifyFormat("var obj = {\n"
380 " fooooooooo: function(x) {\n"
381 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n"
382 " }\n"
383 "};");
Daniel Jasper60948b12015-03-15 13:55:54 +0000384 // Simple object literal, as opposed to enum style below.
385 verifyFormat("var obj = {a: 123};");
386 // Enum style top level assignment.
387 verifyFormat("X = {\n a: 123\n};");
388 verifyFormat("X.Y = {\n a: 123\n};");
Daniel Jasper11ca2632015-06-10 09:21:09 +0000389 // But only on the top level, otherwise its a plain object literal assignment.
390 verifyFormat("function x() {\n"
391 " y = {z: 1};\n"
392 "}");
Daniel Jasper60948b12015-03-15 13:55:54 +0000393 verifyFormat("x = foo && {a: 123};");
Manuel Klimek79e06082015-05-21 12:23:34 +0000394
395 // Arrow functions in object literals.
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000396 verifyFormat("var x = {\n"
397 " y: (a) => {\n"
398 " return a;\n"
399 " }\n"
400 "};");
Manuel Klimek79e06082015-05-21 12:23:34 +0000401 verifyFormat("var x = {y: (a) => a};");
Daniel Jasper8c42d442015-05-29 06:19:49 +0000402
Martin Probst8e3eba02017-02-07 16:33:13 +0000403 // Methods in object literals.
404 verifyFormat("var x = {\n"
405 " y(a: string): number {\n"
406 " return a;\n"
407 " }\n"
408 "};");
409 verifyFormat("var x = {\n"
410 " y(a: string) {\n"
411 " return a;\n"
412 " }\n"
413 "};");
414
Daniel Jasper8c42d442015-05-29 06:19:49 +0000415 // Computed keys.
Daniel Jaspercd8d4ff2015-05-31 08:40:37 +0000416 verifyFormat("var x = {[a]: 1, b: 2, [c]: 3};");
Daniel Jasper8c42d442015-05-29 06:19:49 +0000417 verifyFormat("var x = {\n"
418 " [a]: 1,\n"
Daniel Jaspercd8d4ff2015-05-31 08:40:37 +0000419 " b: 2,\n"
420 " [c]: 3,\n"
Daniel Jasper8c42d442015-05-29 06:19:49 +0000421 "};");
Daniel Jasper9f4c9d42016-02-07 22:17:13 +0000422
423 // Object literals can leave out labels.
424 verifyFormat("f({a}, () => {\n"
425 " g(); //\n"
426 "});");
Daniel Jasperb18425b2016-03-01 04:19:47 +0000427
428 // Keys can be quoted.
429 verifyFormat("var x = {\n"
430 " a: a,\n"
431 " b: b,\n"
432 " 'c': c,\n"
433 "};");
Daniel Jaspere98e5812016-11-29 09:40:36 +0000434
435 // Dict literals can skip the label names.
436 verifyFormat("var x = {\n"
437 " aaa,\n"
438 " aaa,\n"
439 " aaa,\n"
440 "};");
Daniel Jasper893b8ad2017-03-01 19:47:28 +0000441 verifyFormat("return {\n"
442 " a,\n"
443 " b: 'b',\n"
444 " c,\n"
445 "};");
Daniel Jasper17062ff2014-06-10 14:44:02 +0000446}
447
Daniel Jasperf46dec82015-03-31 14:34:15 +0000448TEST_F(FormatTestJS, MethodsInObjectLiterals) {
449 verifyFormat("var o = {\n"
450 " value: 'test',\n"
451 " get value() { // getter\n"
452 " return this.value;\n"
453 " }\n"
454 "};");
455 verifyFormat("var o = {\n"
456 " value: 'test',\n"
457 " set value(val) { // setter\n"
458 " this.value = val;\n"
459 " }\n"
460 "};");
461 verifyFormat("var o = {\n"
462 " value: 'test',\n"
463 " someMethod(val) { // method\n"
464 " doSomething(this.value + val);\n"
465 " }\n"
466 "};");
Daniel Jasper739ec532015-04-04 07:56:55 +0000467 verifyFormat("var o = {\n"
468 " someMethod(val) { // method\n"
469 " doSomething(this.value + val);\n"
470 " },\n"
471 " someOtherMethod(val) { // method\n"
472 " doSomething(this.value + val);\n"
473 " }\n"
474 "};");
Daniel Jasperf46dec82015-03-31 14:34:15 +0000475}
476
Martin Probst19c7de02017-04-26 12:34:15 +0000477TEST_F(FormatTestJS, GettersSettersVisibilityKeywords) {
478 // Don't break after "protected"
479 verifyFormat("class X {\n"
480 " protected get getter():\n"
481 " number {\n"
482 " return 1;\n"
483 " }\n"
484 "}",
485 getGoogleJSStyleWithColumns(12));
486 // Don't break after "get"
487 verifyFormat("class X {\n"
488 " protected get someReallyLongGetterName():\n"
489 " number {\n"
490 " return 1;\n"
491 " }\n"
492 "}",
493 getGoogleJSStyleWithColumns(40));
494}
495
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000496TEST_F(FormatTestJS, SpacesInContainerLiterals) {
497 verifyFormat("var arr = [1, 2, 3];");
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000498 verifyFormat("f({a: 1, b: 2, c: 3});");
Nico Weber514ecc82014-02-02 20:50:45 +0000499
Daniel Jasper2a958322014-05-21 13:26:58 +0000500 verifyFormat("var object_literal_with_long_name = {\n"
501 " a: 'aaaaaaaaaaaaaaaaaa',\n"
502 " b: 'bbbbbbbbbbbbbbbbbb'\n"
503 "};");
504
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000505 verifyFormat("f({a: 1, b: 2, c: 3});",
Nico Weber514ecc82014-02-02 20:50:45 +0000506 getChromiumStyle(FormatStyle::LK_JavaScript));
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000507 verifyFormat("f({'a': [{}]});");
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000508}
509
Daniel Jasperabd1f572016-03-02 22:44:03 +0000510TEST_F(FormatTestJS, SingleQuotedStrings) {
Daniel Jasper86fee2f2014-01-31 12:49:42 +0000511 verifyFormat("this.function('', true);");
512}
513
Daniel Jasper4a39c842014-05-06 13:54:10 +0000514TEST_F(FormatTestJS, GoogScopes) {
515 verifyFormat("goog.scope(function() {\n"
516 "var x = a.b;\n"
517 "var y = c.d;\n"
518 "}); // goog.scope");
Daniel Jasper02c7bca2015-03-30 09:56:50 +0000519 verifyFormat("goog.scope(function() {\n"
520 "// test\n"
521 "var x = 0;\n"
522 "// test\n"
523 "});");
Daniel Jasper4a39c842014-05-06 13:54:10 +0000524}
525
Martin Probst101ec892017-05-09 20:04:09 +0000526TEST_F(FormatTestJS, IIFEs) {
527 // Internal calling parens; no semi.
528 verifyFormat("(function() {\n"
529 "var a = 1;\n"
530 "}())");
531 // External calling parens; no semi.
532 verifyFormat("(function() {\n"
533 "var b = 2;\n"
534 "})()");
535 // Internal calling parens; with semi.
536 verifyFormat("(function() {\n"
537 "var c = 3;\n"
538 "}());");
539 // External calling parens; with semi.
540 verifyFormat("(function() {\n"
541 "var d = 4;\n"
542 "})();");
543}
544
Daniel Jasper616de8642014-11-23 16:46:28 +0000545TEST_F(FormatTestJS, GoogModules) {
546 verifyFormat("goog.module('this.is.really.absurdly.long');",
547 getGoogleJSStyleWithColumns(40));
548 verifyFormat("goog.require('this.is.really.absurdly.long');",
549 getGoogleJSStyleWithColumns(40));
550 verifyFormat("goog.provide('this.is.really.absurdly.long');",
551 getGoogleJSStyleWithColumns(40));
552 verifyFormat("var long = goog.require('this.is.really.absurdly.long');",
553 getGoogleJSStyleWithColumns(40));
Daniel Jasperb488a742015-10-29 19:05:20 +0000554 verifyFormat("goog.setTestOnly('this.is.really.absurdly.long');",
555 getGoogleJSStyleWithColumns(40));
Daniel Jasper02cbeb22016-02-22 15:06:53 +0000556 verifyFormat("goog.forwardDeclare('this.is.really.absurdly.long');",
557 getGoogleJSStyleWithColumns(40));
Daniel Jasper53c38f42014-11-27 14:46:03 +0000558
559 // These should be wrapped normally.
560 verifyFormat(
561 "var MyLongClassName =\n"
562 " goog.module.get('my.long.module.name.followedBy.MyLongClassName');");
Daniel Jasper616de8642014-11-23 16:46:28 +0000563}
564
Martin Probstece8c0c2016-06-13 16:41:28 +0000565TEST_F(FormatTestJS, FormatsNamespaces) {
566 verifyFormat("namespace Foo {\n"
567 " export let x = 1;\n"
568 "}\n");
569 verifyFormat("declare namespace Foo {\n"
570 " export let x: number;\n"
571 "}\n");
572}
573
Martin Probst72fd75a2016-11-10 16:20:58 +0000574TEST_F(FormatTestJS, NamespacesMayNotWrap) {
575 verifyFormat("declare namespace foobarbaz {\n"
576 "}\n", getGoogleJSStyleWithColumns(18));
577 verifyFormat("declare module foobarbaz {\n"
578 "}\n", getGoogleJSStyleWithColumns(15));
579 verifyFormat("namespace foobarbaz {\n"
580 "}\n", getGoogleJSStyleWithColumns(10));
581 verifyFormat("module foobarbaz {\n"
582 "}\n", getGoogleJSStyleWithColumns(7));
583}
584
585TEST_F(FormatTestJS, AmbientDeclarations) {
586 FormatStyle NineCols = getGoogleJSStyleWithColumns(9);
587 verifyFormat(
588 "declare class\n"
589 " X {}",
590 NineCols);
591 verifyFormat(
592 "declare function\n"
593 "x();", // TODO(martinprobst): should ideally be indented.
594 NineCols);
Martin Probstaf16c502017-01-04 13:36:43 +0000595 verifyFormat("declare function foo();\n"
596 "let x = 1;\n");
597 verifyFormat("declare function foo(): string;\n"
598 "let x = 1;\n");
599 verifyFormat("declare function foo(): {x: number};\n"
600 "let x = 1;\n");
601 verifyFormat("declare class X {}\n"
602 "let x = 1;\n");
603 verifyFormat("declare interface Y {}\n"
604 "let x = 1;\n");
Martin Probst72fd75a2016-11-10 16:20:58 +0000605 verifyFormat(
606 "declare enum X {\n"
607 "}",
608 NineCols);
609 verifyFormat(
610 "declare let\n"
611 " x: number;",
612 NineCols);
613}
614
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000615TEST_F(FormatTestJS, FormatsFreestandingFunctions) {
616 verifyFormat("function outer1(a, b) {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000617 " function inner1(a, b) {\n"
618 " return a;\n"
619 " }\n"
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000620 " inner1(a, b);\n"
621 "}\n"
622 "function outer2(a, b) {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000623 " function inner2(a, b) {\n"
624 " return a;\n"
625 " }\n"
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000626 " inner2(a, b);\n"
627 "}");
Daniel Jasper20580fd2015-06-11 13:31:45 +0000628 verifyFormat("function f() {}");
Martin Probstb7fb2672017-05-10 13:53:29 +0000629 verifyFormat("function aFunction() {}\n"
630 "(function f() {\n"
631 " var x = 1;\n"
632 "}());\n");
Martin Probst95ed8e72017-05-31 09:29:40 +0000633 verifyFormat("function aFunction() {}\n"
634 "{\n"
Martin Probstb7fb2672017-05-10 13:53:29 +0000635 " let x = 1;\n"
636 " console.log(x);\n"
637 "}\n");
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000638}
639
Martin Probst5f8445b2016-04-24 22:05:09 +0000640TEST_F(FormatTestJS, GeneratorFunctions) {
641 verifyFormat("function* f() {\n"
642 " let x = 1;\n"
643 " yield x;\n"
644 " yield* something();\n"
Daniel Jaspereb886632016-10-31 13:18:25 +0000645 " yield [1, 2];\n"
646 " yield {a: 1};\n"
Martin Probst5f8445b2016-04-24 22:05:09 +0000647 "}");
648 verifyFormat("function*\n"
649 " f() {\n"
650 "}",
651 getGoogleJSStyleWithColumns(8));
652 verifyFormat("export function* f() {\n"
653 " yield 1;\n"
654 "}\n");
655 verifyFormat("class X {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000656 " * generatorMethod() {\n"
657 " yield x;\n"
658 " }\n"
Martin Probst5f8445b2016-04-24 22:05:09 +0000659 "}");
Daniel Jasper71e50af2016-11-01 06:22:59 +0000660 verifyFormat("var x = {\n"
661 " a: function*() {\n"
662 " //\n"
663 " }\n"
664 "}\n");
Martin Probst5f8445b2016-04-24 22:05:09 +0000665}
666
667TEST_F(FormatTestJS, AsyncFunctions) {
668 verifyFormat("async function f() {\n"
669 " let x = 1;\n"
670 " return fetch(x);\n"
671 "}");
Martin Probst973ff792017-04-27 13:07:24 +0000672 verifyFormat("async function f() {\n"
673 " return 1;\n"
674 "}\n"
675 "\n"
676 "function a() {\n"
677 " return 1;\n"
678 "}\n",
679 " async function f() {\n"
680 " return 1;\n"
681 "}\n"
682 "\n"
683 " function a() {\n"
684 " return 1;\n"
685 "} \n");
Martin Probst5f8445b2016-04-24 22:05:09 +0000686 verifyFormat("async function* f() {\n"
687 " yield fetch(x);\n"
688 "}");
689 verifyFormat("export async function f() {\n"
690 " return fetch(x);\n"
691 "}");
Martin Probst20371c32017-02-27 11:15:53 +0000692 verifyFormat("let x = async () => f();");
Martin Probst973ff792017-04-27 13:07:24 +0000693 verifyFormat("let x = async function() {\n"
694 " f();\n"
695 "};");
Martin Probst20371c32017-02-27 11:15:53 +0000696 verifyFormat("let x = async();");
Martin Probst5f8445b2016-04-24 22:05:09 +0000697 verifyFormat("class X {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000698 " async asyncMethod() {\n"
699 " return fetch(1);\n"
700 " }\n"
Martin Probst5f8445b2016-04-24 22:05:09 +0000701 "}");
Martin Probst409697e2016-05-29 14:41:07 +0000702 verifyFormat("function initialize() {\n"
703 " // Comment.\n"
704 " return async.then();\n"
705 "}\n");
Martin Probsta050f412017-05-18 21:19:29 +0000706 verifyFormat("for await (const x of y) {\n"
Martin Probstbd49e322017-05-15 19:33:20 +0000707 " console.log(x);\n"
708 "}\n");
709 verifyFormat("function asyncLoop() {\n"
Martin Probsta050f412017-05-18 21:19:29 +0000710 " for await (const x of y) {\n"
Martin Probstbd49e322017-05-15 19:33:20 +0000711 " console.log(x);\n"
712 " }\n"
713 "}\n");
Martin Probst5f8445b2016-04-24 22:05:09 +0000714}
715
Martin Probst2c1cdae2017-05-15 11:15:29 +0000716TEST_F(FormatTestJS, FunctionParametersTrailingComma) {
717 verifyFormat("function trailingComma(\n"
718 " p1,\n"
719 " p2,\n"
720 " p3,\n"
721 ") {\n"
722 " a; //\n"
723 "}\n",
724 "function trailingComma(p1, p2, p3,) {\n"
725 " a; //\n"
726 "}\n");
727 verifyFormat("trailingComma(\n"
728 " p1,\n"
729 " p2,\n"
730 " p3,\n"
731 ");\n",
732 "trailingComma(p1, p2, p3,);\n");
733 verifyFormat("trailingComma(\n"
734 " p1 // hello\n"
735 ");\n",
736 "trailingComma(p1 // hello\n"
737 ");\n");
738}
739
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000740TEST_F(FormatTestJS, ArrayLiterals) {
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +0000741 verifyFormat("var aaaaa: List<SomeThing> =\n"
742 " [new SomeThingAAAAAAAAAAAA(), new SomeThingBBBBBBBBB()];");
Daniel Jasperd492b5e2015-06-02 21:57:51 +0000743 verifyFormat("return [\n"
Daniel Jasper50780ce2016-01-13 16:41:34 +0000744 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
Daniel Jasperd492b5e2015-06-02 21:57:51 +0000745 " ccccccccccccccccccccccccccc\n"
746 "];");
Daniel Jasper7bec87c2016-01-07 18:11:54 +0000747 verifyFormat("return [\n"
748 " aaaa().bbbbbbbb('A'),\n"
749 " aaaa().bbbbbbbb('B'),\n"
750 " aaaa().bbbbbbbb('C'),\n"
751 "];");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000752 verifyFormat("var someVariable = SomeFunction([\n"
Daniel Jasper50780ce2016-01-13 16:41:34 +0000753 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
Daniel Jasper5ce80de2015-06-02 13:56:43 +0000754 " ccccccccccccccccccccccccccc\n"
755 "]);");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000756 verifyFormat("var someVariable = SomeFunction([\n"
Daniel Jasper40432ce2015-06-02 15:04:29 +0000757 " [aaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbb],\n"
Daniel Jasper199d0c92015-06-02 15:14:21 +0000758 "]);",
759 getGoogleJSStyleWithColumns(51));
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000760 verifyFormat("var someVariable = SomeFunction(aaaa, [\n"
Daniel Jasper50780ce2016-01-13 16:41:34 +0000761 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
Daniel Jasper4284e362015-06-02 14:20:08 +0000762 " ccccccccccccccccccccccccccc\n"
763 "]);");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000764 verifyFormat("var someVariable = SomeFunction(\n"
765 " aaaa,\n"
766 " [\n"
Daniel Jasper50780ce2016-01-13 16:41:34 +0000767 " aaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
768 " cccccccccccccccccccccccccc\n"
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000769 " ],\n"
770 " aaaa);");
Daniel Jasperebcb71f2016-01-04 13:11:41 +0000771 verifyFormat("var aaaa = aaaaa || // wrap\n"
772 " [];");
Daniel Jasper1feab0f2015-06-02 15:31:37 +0000773
774 verifyFormat("someFunction([], {a: a});");
Daniel Jasper51c868e2017-01-30 07:08:40 +0000775
776 verifyFormat("var string = [\n"
777 " 'aaaaaa',\n"
778 " 'bbbbbb',\n"
779 "].join('+');");
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000780}
781
Daniel Jaspere2deb592015-12-22 15:48:15 +0000782TEST_F(FormatTestJS, ColumnLayoutForArrayLiterals) {
783 verifyFormat("var array = [\n"
784 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
785 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
786 "];");
787 verifyFormat("var array = someFunction([\n"
788 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
789 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
790 "]);");
791}
792
Daniel Jasper5217a8b2014-06-13 07:02:04 +0000793TEST_F(FormatTestJS, FunctionLiterals) {
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000794 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
795 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Daniel Jasper3f69ba12014-09-05 08:42:27 +0000796 verifyFormat("doFoo(function() {});");
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000797 verifyFormat("doFoo(function() { return 1; });", Style);
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000798 verifyFormat("var func = function() {\n"
799 " return 1;\n"
800 "};");
Daniel Jaspered3f3952015-06-18 12:32:59 +0000801 verifyFormat("var func = //\n"
802 " function() {\n"
803 " return 1;\n"
804 "};");
Daniel Jasperc03e16a2014-05-08 09:25:39 +0000805 verifyFormat("return {\n"
806 " body: {\n"
807 " setAttribute: function(key, val) { this[key] = val; },\n"
808 " getAttribute: function(key) { return this[key]; },\n"
809 " style: {direction: ''}\n"
810 " }\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000811 "};",
812 Style);
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000813 verifyFormat("abc = xyz ? function() {\n"
814 " return 1;\n"
815 "} : function() {\n"
816 " return -1;\n"
817 "};");
Daniel Jasperb16b9692014-05-21 12:51:23 +0000818
819 verifyFormat("var closure = goog.bind(\n"
820 " function() { // comment\n"
821 " foo();\n"
822 " bar();\n"
823 " },\n"
Joerg Sonnenbergere9987a12017-01-05 17:59:44 +0000824 " this, arg1IsReallyLongAndNeedsLineBreaks,\n"
825 " arg3IsReallyLongAndNeedsLineBreaks);");
Daniel Jasperb16b9692014-05-21 12:51:23 +0000826 verifyFormat("var closure = goog.bind(function() { // comment\n"
827 " foo();\n"
828 " bar();\n"
829 "}, this);");
Daniel Jasper58cb2ed2014-06-06 13:49:04 +0000830 verifyFormat("return {\n"
831 " a: 'E',\n"
832 " b: function() {\n"
833 " return function() {\n"
834 " f(); //\n"
835 " };\n"
836 " }\n"
837 "};");
Daniel Jasper41368e92014-11-27 15:37:42 +0000838 verifyFormat("{\n"
839 " var someVariable = function(x) {\n"
840 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n"
841 " };\n"
842 "}");
Daniel Jasper7325aee2015-05-08 08:38:52 +0000843 verifyFormat("someLooooooooongFunction(\n"
844 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
845 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
846 " function(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
847 " // code\n"
848 " });");
Daniel Jasper5f3ea472014-05-22 08:36:53 +0000849
Daniel Jasper5217a8b2014-06-13 07:02:04 +0000850 verifyFormat("return {\n"
851 " a: function SomeFunction() {\n"
852 " // ...\n"
853 " return 1;\n"
854 " }\n"
855 "};");
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000856 verifyFormat("this.someObject.doSomething(aaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
857 " .then(goog.bind(function(aaaaaaaaaaa) {\n"
858 " someFunction();\n"
859 " someFunction();\n"
860 " }, this), aaaaaaaaaaaaaaaaa);");
861
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000862 verifyFormat("someFunction(goog.bind(function() {\n"
863 " doSomething();\n"
864 " doSomething();\n"
865 "}, this), goog.bind(function() {\n"
866 " doSomething();\n"
867 " doSomething();\n"
868 "}, this));");
Daniel Jasper1699eca2015-06-01 09:56:32 +0000869
Daniel Jasper51c868e2017-01-30 07:08:40 +0000870 verifyFormat("SomeFunction(function() {\n"
871 " foo();\n"
872 " bar();\n"
873 "}.bind(this));");
874
Martin Probstb2f06ea2017-05-29 07:50:52 +0000875 verifyFormat("SomeFunction((function() {\n"
876 " foo();\n"
877 " bar();\n"
878 " }).bind(this));");
879
Daniel Jasper1699eca2015-06-01 09:56:32 +0000880 // FIXME: This is bad, we should be wrapping before "function() {".
881 verifyFormat("someFunction(function() {\n"
882 " doSomething(); // break\n"
883 "})\n"
884 " .doSomethingElse(\n"
885 " // break\n"
Martin Probst2c1cdae2017-05-15 11:15:29 +0000886 " );");
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000887
888 Style.ColumnLimit = 33;
889 verifyFormat("f({a: function() { return 1; }});", Style);
890 Style.ColumnLimit = 32;
891 verifyFormat("f({\n"
892 " a: function() { return 1; }\n"
893 "});",
894 Style);
895
Daniel Jasper79dffb42014-05-07 09:48:30 +0000896}
897
Martin Probstcde98152017-08-01 17:35:57 +0000898TEST_F(FormatTestJS, DontWrapEmptyLiterals) {
899 verifyFormat("(aaaaaaaaaaaaaaaaaaaaa.getData as jasmine.Spy)\n"
900 " .and.returnValue(Observable.of([]));");
901 verifyFormat("(aaaaaaaaaaaaaaaaaaaaa.getData as jasmine.Spy)\n"
902 " .and.returnValue(Observable.of({}));");
903 verifyFormat("(aaaaaaaaaaaaaaaaaaaaa.getData as jasmine.Spy)\n"
904 " .and.returnValue(Observable.of(()));");
905}
906
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000907TEST_F(FormatTestJS, InliningFunctionLiterals) {
908 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
909 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
910 verifyFormat("var func = function() {\n"
911 " return 1;\n"
912 "};",
913 Style);
914 verifyFormat("var func = doSomething(function() { return 1; });", Style);
915 verifyFormat("var outer = function() {\n"
916 " var inner = function() { return 1; }\n"
917 "};",
918 Style);
919 verifyFormat("function outer1(a, b) {\n"
920 " function inner1(a, b) { return a; }\n"
921 "}",
922 Style);
923
924 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
925 verifyFormat("var func = function() { return 1; };", Style);
926 verifyFormat("var func = doSomething(function() { return 1; });", Style);
927 verifyFormat(
928 "var outer = function() { var inner = function() { return 1; } };",
929 Style);
930 verifyFormat("function outer1(a, b) {\n"
931 " function inner1(a, b) { return a; }\n"
932 "}",
933 Style);
934
935 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
936 verifyFormat("var func = function() {\n"
937 " return 1;\n"
938 "};",
939 Style);
940 verifyFormat("var func = doSomething(function() {\n"
941 " return 1;\n"
942 "});",
943 Style);
944 verifyFormat("var outer = function() {\n"
945 " var inner = function() {\n"
946 " return 1;\n"
947 " }\n"
948 "};",
949 Style);
950 verifyFormat("function outer1(a, b) {\n"
951 " function inner1(a, b) {\n"
952 " return a;\n"
953 " }\n"
954 "}",
955 Style);
Daniel Jasper71e57452015-11-20 16:44:28 +0000956
957 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
958 verifyFormat("var func = function() {\n"
959 " return 1;\n"
960 "};",
961 Style);
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000962}
963
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000964TEST_F(FormatTestJS, MultipleFunctionLiterals) {
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000965 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
966 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000967 verifyFormat("promise.then(\n"
968 " function success() {\n"
969 " doFoo();\n"
970 " doBar();\n"
971 " },\n"
972 " function error() {\n"
973 " doFoo();\n"
974 " doBaz();\n"
975 " },\n"
976 " []);\n");
977 verifyFormat("promise.then(\n"
978 " function success() {\n"
979 " doFoo();\n"
980 " doBar();\n"
981 " },\n"
982 " [],\n"
983 " function error() {\n"
984 " doFoo();\n"
985 " doBaz();\n"
986 " });\n");
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000987 verifyFormat("promise.then(\n"
988 " [],\n"
989 " function success() {\n"
990 " doFoo();\n"
991 " doBar();\n"
992 " },\n"
993 " function error() {\n"
994 " doFoo();\n"
995 " doBaz();\n"
996 " });\n");
Daniel Jasper1779d432014-09-29 07:54:54 +0000997
998 verifyFormat("getSomeLongPromise()\n"
999 " .then(function(value) { body(); })\n"
Daniel Jasper11a0ac62014-12-12 09:40:58 +00001000 " .thenCatch(function(error) {\n"
1001 " body();\n"
1002 " body();\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +00001003 " });",
1004 Style);
Daniel Jasper1779d432014-09-29 07:54:54 +00001005 verifyFormat("getSomeLongPromise()\n"
1006 " .then(function(value) {\n"
1007 " body();\n"
1008 " body();\n"
1009 " })\n"
1010 " .thenCatch(function(error) {\n"
1011 " body();\n"
1012 " body();\n"
1013 " });");
Daniel Jasper11a0ac62014-12-12 09:40:58 +00001014
Daniel Jasperacf67e32015-04-07 08:20:35 +00001015 verifyFormat("getSomeLongPromise()\n"
1016 " .then(function(value) { body(); })\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +00001017 " .thenCatch(function(error) { body(); });",
1018 Style);
Daniel Jasper28024562016-01-11 11:00:58 +00001019
1020 verifyFormat("return [aaaaaaaaaaaaaaaaaaaaaa]\n"
1021 " .aaaaaaa(function() {\n"
1022 " //\n"
1023 " })\n"
1024 " .bbbbbb();");
Daniel Jasper114a2bc2014-06-03 12:02:45 +00001025}
1026
Manuel Klimek79e06082015-05-21 12:23:34 +00001027TEST_F(FormatTestJS, ArrowFunctions) {
1028 verifyFormat("var x = (a) => {\n"
1029 " return a;\n"
1030 "};");
1031 verifyFormat("var x = (a) => {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +00001032 " function y() {\n"
1033 " return 42;\n"
1034 " }\n"
Manuel Klimek79e06082015-05-21 12:23:34 +00001035 " return a;\n"
1036 "};");
1037 verifyFormat("var x = (a: type): {some: type} => {\n"
1038 " return a;\n"
1039 "};");
1040 verifyFormat("var x = (a) => a;");
Daniel Jaspere497bed2015-06-02 22:06:07 +00001041 verifyFormat("return () => [];");
Daniel Jasper3c306e82015-06-03 17:08:40 +00001042 verifyFormat("var aaaaaaaaaaaaaaaaaaaa = {\n"
1043 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa:\n"
1044 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
1045 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) =>\n"
Daniel Jasper3b0f3042015-06-05 08:25:37 +00001046 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
Daniel Jasper3c306e82015-06-03 17:08:40 +00001047 "};");
Daniel Jasper6501f7e2015-10-27 12:38:37 +00001048 verifyFormat("var a = a.aaaaaaa(\n"
1049 " (a: a) => aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) &&\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +00001050 " aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbb));");
Daniel Jasper6501f7e2015-10-27 12:38:37 +00001051 verifyFormat("var a = a.aaaaaaa(\n"
1052 " (a: a) => aaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) ?\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +00001053 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb) :\n"
1054 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb));");
Daniel Jasper1699eca2015-06-01 09:56:32 +00001055
1056 // FIXME: This is bad, we should be wrapping before "() => {".
1057 verifyFormat("someFunction(() => {\n"
1058 " doSomething(); // break\n"
1059 "})\n"
1060 " .doSomethingElse(\n"
1061 " // break\n"
Martin Probst2c1cdae2017-05-15 11:15:29 +00001062 " );");
Martin Probstec363262017-08-01 17:19:32 +00001063 verifyFormat("const f = (x: string|null): string|null => {\n"
1064 " return x;\n"
1065 "}\n");
Manuel Klimek79e06082015-05-21 12:23:34 +00001066}
1067
Daniel Jasper166c19b2014-05-06 14:12:21 +00001068TEST_F(FormatTestJS, ReturnStatements) {
Daniel Jasper67f8ad22014-09-30 17:57:06 +00001069 verifyFormat("function() {\n"
1070 " return [hello, world];\n"
1071 "}");
Daniel Jasper166c19b2014-05-06 14:12:21 +00001072}
1073
Daniel Jasperf95b1f42015-11-20 16:18:42 +00001074TEST_F(FormatTestJS, ForLoops) {
1075 verifyFormat("for (var i in [2, 3]) {\n"
1076 "}");
Daniel Jasperb7fda112016-02-11 13:24:15 +00001077 verifyFormat("for (var i of [2, 3]) {\n"
1078 "}");
Daniel Jasperacffeb82016-03-05 18:34:26 +00001079 verifyFormat("for (let {a, b} of x) {\n"
1080 "}");
1081 verifyFormat("for (let {a, b} in x) {\n"
1082 "}");
Daniel Jasperf95b1f42015-11-20 16:18:42 +00001083}
1084
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001085TEST_F(FormatTestJS, WrapRespectsAutomaticSemicolonInsertion) {
Daniel Jasper4c0bf702015-06-12 04:58:27 +00001086 // The following statements must not wrap, as otherwise the program meaning
1087 // would change due to automatic semicolon insertion.
1088 // See http://www.ecma-international.org/ecma-262/5.1/#sec-7.9.1.
1089 verifyFormat("return aaaaa;", getGoogleJSStyleWithColumns(10));
Martin Probst56ff7aa2016-09-06 18:39:30 +00001090 verifyFormat("return /* hello! */ aaaaa;", getGoogleJSStyleWithColumns(10));
Daniel Jasper4c0bf702015-06-12 04:58:27 +00001091 verifyFormat("continue aaaaa;", getGoogleJSStyleWithColumns(10));
Martin Probst56ff7aa2016-09-06 18:39:30 +00001092 verifyFormat("continue /* hello! */ aaaaa;", getGoogleJSStyleWithColumns(10));
Daniel Jasper4c0bf702015-06-12 04:58:27 +00001093 verifyFormat("break aaaaa;", getGoogleJSStyleWithColumns(10));
1094 verifyFormat("throw aaaaa;", getGoogleJSStyleWithColumns(10));
1095 verifyFormat("aaaaaaaaa++;", getGoogleJSStyleWithColumns(10));
1096 verifyFormat("aaaaaaaaa--;", getGoogleJSStyleWithColumns(10));
Daniel Jasper11a87652016-01-14 05:37:52 +00001097 verifyFormat("return [\n"
1098 " aaa\n"
1099 "];",
1100 getGoogleJSStyleWithColumns(12));
Martin Probsta81dd0b2017-07-07 13:17:10 +00001101 verifyFormat("class X {\n"
1102 " readonly ratherLongField =\n"
1103 " 1;\n"
1104 "}",
1105 "class X {\n"
1106 " readonly ratherLongField = 1;\n"
1107 "}",
1108 getGoogleJSStyleWithColumns(20));
Daniel Jasper4c0bf702015-06-12 04:58:27 +00001109}
1110
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001111TEST_F(FormatTestJS, AutomaticSemicolonInsertionHeuristic) {
1112 verifyFormat("a\n"
1113 "b;",
1114 " a \n"
1115 " b ;");
1116 verifyFormat("a()\n"
1117 "b;",
1118 " a ()\n"
1119 " b ;");
1120 verifyFormat("a[b]\n"
1121 "c;",
1122 "a [b]\n"
1123 "c ;");
1124 verifyFormat("1\n"
1125 "a;",
1126 "1 \n"
1127 "a ;");
1128 verifyFormat("a\n"
1129 "1;",
1130 "a \n"
1131 "1 ;");
1132 verifyFormat("a\n"
1133 "'x';",
1134 "a \n"
1135 " 'x';");
1136 verifyFormat("a++\n"
1137 "b;",
1138 "a ++\n"
1139 "b ;");
1140 verifyFormat("a\n"
1141 "!b && c;",
1142 "a \n"
1143 " ! b && c;");
1144 verifyFormat("a\n"
1145 "if (1) f();",
1146 " a\n"
1147 " if (1) f();");
1148 verifyFormat("a\n"
1149 "class X {}",
1150 " a\n"
1151 " class X {}");
1152 verifyFormat("var a", "var\n"
1153 "a");
1154 verifyFormat("x instanceof String", "x\n"
1155 "instanceof\n"
1156 "String");
Martin Probstbbffeac2016-04-11 07:35:57 +00001157 verifyFormat("function f(@Foo bar) {}", "function f(@Foo\n"
1158 " bar) {}");
Martin Probstb9316ff2016-09-18 17:21:52 +00001159 verifyFormat("a = true\n"
1160 "return 1",
1161 "a = true\n"
1162 " return 1");
1163 verifyFormat("a = 's'\n"
1164 "return 1",
1165 "a = 's'\n"
1166 " return 1");
1167 verifyFormat("a = null\n"
1168 "return 1",
1169 "a = null\n"
1170 " return 1");
Martin Probste6b5b342017-01-16 09:52:40 +00001171 // Below "class Y {}" should ideally be on its own line.
Martin Probstd40bca42017-01-09 08:56:36 +00001172 verifyFormat(
Martin Probstfd18ec52017-01-09 09:00:58 +00001173 "x = {\n"
1174 " a: 1\n"
Martin Probste6b5b342017-01-16 09:52:40 +00001175 "} class Y {}",
Martin Probstd40bca42017-01-09 08:56:36 +00001176 " x = {a : 1}\n"
1177 " class Y { }");
Martin Probste6b5b342017-01-16 09:52:40 +00001178 verifyFormat(
1179 "if (x) {\n"
1180 "}\n"
1181 "return 1",
1182 "if (x) {}\n"
1183 " return 1");
1184 verifyFormat(
1185 "if (x) {\n"
1186 "}\n"
1187 "class X {}",
1188 "if (x) {}\n"
1189 " class X {}");
Martin Probstd40bca42017-01-09 08:56:36 +00001190}
1191
1192TEST_F(FormatTestJS, ImportExportASI) {
1193 verifyFormat(
1194 "import {x} from 'y'\n"
1195 "export function z() {}",
1196 "import {x} from 'y'\n"
1197 " export function z() {}");
Martin Probste6b5b342017-01-16 09:52:40 +00001198 // Below "class Y {}" should ideally be on its own line.
Martin Probstd40bca42017-01-09 08:56:36 +00001199 verifyFormat(
Martin Probste6b5b342017-01-16 09:52:40 +00001200 "export {x} class Y {}",
Martin Probstd40bca42017-01-09 08:56:36 +00001201 " export {x}\n"
1202 " class Y {\n}");
Martin Probste6b5b342017-01-16 09:52:40 +00001203 verifyFormat(
1204 "if (x) {\n"
1205 "}\n"
1206 "export class Y {}",
1207 "if ( x ) { }\n"
1208 " export class Y {}");
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001209}
1210
Manuel Klimek79e06082015-05-21 12:23:34 +00001211TEST_F(FormatTestJS, ClosureStyleCasts) {
Daniel Jasper484033b2014-05-06 14:41:29 +00001212 verifyFormat("var x = /** @type {foo} */ (bar);");
1213}
1214
Daniel Jasper04a71a42014-05-08 11:58:24 +00001215TEST_F(FormatTestJS, TryCatch) {
1216 verifyFormat("try {\n"
1217 " f();\n"
1218 "} catch (e) {\n"
1219 " g();\n"
1220 "} finally {\n"
1221 " h();\n"
1222 "}");
Daniel Jasper8f2e94c2014-09-04 15:03:34 +00001223
1224 // But, of course, "catch" is a perfectly fine function name in JavaScript.
1225 verifyFormat("someObject.catch();");
Daniel Jasper79121232014-11-27 14:55:17 +00001226 verifyFormat("someObject.new();");
1227 verifyFormat("someObject.delete();");
Daniel Jasper04a71a42014-05-08 11:58:24 +00001228}
1229
Daniel Jasper49802ef2014-05-22 09:10:04 +00001230TEST_F(FormatTestJS, StringLiteralConcatenation) {
1231 verifyFormat("var literal = 'hello ' +\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +00001232 " 'world';");
Daniel Jasper49802ef2014-05-22 09:10:04 +00001233}
1234
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001235TEST_F(FormatTestJS, RegexLiteralClassification) {
1236 // Regex literals.
1237 verifyFormat("var regex = /abc/;");
1238 verifyFormat("f(/abc/);");
1239 verifyFormat("f(abc, /abc/);");
1240 verifyFormat("some_map[/abc/];");
1241 verifyFormat("var x = a ? /abc/ : /abc/;");
1242 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}");
1243 verifyFormat("var x = !/abc/.test(y);");
Martin Probst16282992017-02-07 14:08:03 +00001244 verifyFormat("var x = foo()! / 10;");
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001245 verifyFormat("var x = a && /abc/.test(y);");
1246 verifyFormat("var x = a || /abc/.test(y);");
1247 verifyFormat("var x = a + /abc/.search(y);");
Daniel Jasperc553ae12015-07-02 13:20:45 +00001248 verifyFormat("/abc/.search(y);");
Daniel Jasperf7405c12014-05-08 07:45:18 +00001249 verifyFormat("var regexs = {/abc/, /abc/};");
1250 verifyFormat("return /abc/;");
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001251
1252 // Not regex literals.
1253 verifyFormat("var a = a / 2 + b / 3;");
Daniel Jasper265309e2015-10-18 07:02:28 +00001254 verifyFormat("var a = a++ / 2;");
1255 // Prefix unary can operate on regex literals, not that it makes sense.
1256 verifyFormat("var a = ++/a/;");
1257
1258 // This is a known issue, regular expressions are incorrectly detected if
1259 // directly following a closing parenthesis.
1260 verifyFormat("if (foo) / bar /.exec(baz);");
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001261}
1262
1263TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) {
Daniel Jasper69694b02015-05-08 07:55:13 +00001264 verifyFormat("var regex = /=/;");
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001265 verifyFormat("var regex = /a*/;");
1266 verifyFormat("var regex = /a+/;");
1267 verifyFormat("var regex = /a?/;");
1268 verifyFormat("var regex = /.a./;");
1269 verifyFormat("var regex = /a\\*/;");
1270 verifyFormat("var regex = /^a$/;");
1271 verifyFormat("var regex = /\\/a/;");
1272 verifyFormat("var regex = /(?:x)/;");
1273 verifyFormat("var regex = /x(?=y)/;");
1274 verifyFormat("var regex = /x(?!y)/;");
1275 verifyFormat("var regex = /x|y/;");
1276 verifyFormat("var regex = /a{2}/;");
1277 verifyFormat("var regex = /a{1,3}/;");
Daniel Jasper8d0e2232015-10-12 03:13:48 +00001278
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001279 verifyFormat("var regex = /[abc]/;");
1280 verifyFormat("var regex = /[^abc]/;");
1281 verifyFormat("var regex = /[\\b]/;");
Daniel Jasper8d0e2232015-10-12 03:13:48 +00001282 verifyFormat("var regex = /[/]/;");
1283 verifyFormat("var regex = /[\\/]/;");
1284 verifyFormat("var regex = /\\[/;");
1285 verifyFormat("var regex = /\\\\[/]/;");
Daniel Jasper265309e2015-10-18 07:02:28 +00001286 verifyFormat("var regex = /}[\"]/;");
1287 verifyFormat("var regex = /}[/\"]/;");
1288 verifyFormat("var regex = /}[\"/]/;");
Daniel Jasper8d0e2232015-10-12 03:13:48 +00001289
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001290 verifyFormat("var regex = /\\b/;");
1291 verifyFormat("var regex = /\\B/;");
1292 verifyFormat("var regex = /\\d/;");
1293 verifyFormat("var regex = /\\D/;");
1294 verifyFormat("var regex = /\\f/;");
1295 verifyFormat("var regex = /\\n/;");
1296 verifyFormat("var regex = /\\r/;");
1297 verifyFormat("var regex = /\\s/;");
1298 verifyFormat("var regex = /\\S/;");
1299 verifyFormat("var regex = /\\t/;");
1300 verifyFormat("var regex = /\\v/;");
1301 verifyFormat("var regex = /\\w/;");
1302 verifyFormat("var regex = /\\W/;");
1303 verifyFormat("var regex = /a(a)\\1/;");
1304 verifyFormat("var regex = /\\0/;");
Daniel Jasperfb4333b2014-05-12 11:29:50 +00001305 verifyFormat("var regex = /\\\\/g;");
1306 verifyFormat("var regex = /\\a\\\\/g;");
1307 verifyFormat("var regex = /\a\\//g;");
Daniel Jasper23376252014-09-09 14:37:39 +00001308 verifyFormat("var regex = /a\\//;\n"
1309 "var x = 0;");
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001310 verifyFormat("var regex = /'/g;", "var regex = /'/g ;");
1311 verifyFormat("var regex = /'/g; //'", "var regex = /'/g ; //'");
1312 verifyFormat("var regex = /\\/*/;\n"
1313 "var x = 0;",
1314 "var regex = /\\/*/;\n"
1315 "var x=0;");
1316 verifyFormat("var x = /a\\//;", "var x = /a\\// \n;");
Daniel Jasper6b8d26c2015-06-24 16:01:02 +00001317 verifyFormat("var regex = /\"/;", getGoogleJSStyleWithColumns(16));
1318 verifyFormat("var regex =\n"
1319 " /\"/;",
1320 getGoogleJSStyleWithColumns(15));
Daniel Jasperf7372152015-07-02 14:14:04 +00001321 verifyFormat("var regex = //\n"
1322 " /a/;");
Daniel Jasperf1446202015-07-02 15:00:44 +00001323 verifyFormat("var regexs = [\n"
1324 " /d/, //\n"
1325 " /aa/, //\n"
1326 "];");
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001327}
1328
1329TEST_F(FormatTestJS, RegexLiteralModifiers) {
1330 verifyFormat("var regex = /abc/g;");
1331 verifyFormat("var regex = /abc/i;");
1332 verifyFormat("var regex = /abc/m;");
1333 verifyFormat("var regex = /abc/y;");
1334}
1335
1336TEST_F(FormatTestJS, RegexLiteralLength) {
1337 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
1338 getGoogleJSStyleWithColumns(60));
1339 verifyFormat("var regex =\n"
1340 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
1341 getGoogleJSStyleWithColumns(60));
Daniel Jasper0580ff02014-12-17 09:11:08 +00001342 verifyFormat("var regex = /\\xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
1343 getGoogleJSStyleWithColumns(50));
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001344}
1345
1346TEST_F(FormatTestJS, RegexLiteralExamples) {
1347 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);");
1348}
1349
Martin Probstfa37b182017-01-27 09:09:11 +00001350TEST_F(FormatTestJS, IgnoresMpegTS) {
1351 std::string MpegTS(200, ' ');
1352 MpegTS.replace(0, strlen("nearlyLooks + like + ts + code; "),
1353 "nearlyLooks + like + ts + code; ");
1354 MpegTS[0] = 0x47;
1355 MpegTS[188] = 0x47;
1356 verifyFormat(MpegTS, MpegTS);
1357}
1358
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001359TEST_F(FormatTestJS, TypeAnnotations) {
1360 verifyFormat("var x: string;");
Daniel Jasperb9a49902016-01-09 15:56:28 +00001361 verifyFormat("var x: {a: string; b: number;} = {};");
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001362 verifyFormat("function x(): string {\n return 'x';\n}");
Manuel Klimek79e06082015-05-21 12:23:34 +00001363 verifyFormat("function x(): {x: string} {\n return {x: 'x'};\n}");
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001364 verifyFormat("function x(y: string): string {\n return 'x';\n}");
1365 verifyFormat("for (var y: string in x) {\n x();\n}");
Daniel Jasperb7fda112016-02-11 13:24:15 +00001366 verifyFormat("for (var y: string of x) {\n x();\n}");
Daniel Jasperb9a49902016-01-09 15:56:28 +00001367 verifyFormat("function x(y: {a?: number;} = {}): number {\n"
1368 " return 12;\n"
1369 "}");
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001370 verifyFormat("((a: string, b: number): string => a + b);");
1371 verifyFormat("var x: (y: number) => string;");
1372 verifyFormat("var x: P<string, (a: number) => string>;");
Daniel Jasper28d8a5a2016-09-07 23:01:13 +00001373 verifyFormat("var x = {\n"
1374 " y: function(): z {\n"
1375 " return 1;\n"
1376 " }\n"
1377 "};");
1378 verifyFormat("var x = {\n"
1379 " y: function(): {a: number} {\n"
1380 " return 1;\n"
1381 " }\n"
1382 "};");
Daniel Jasperf412e262016-01-08 10:51:24 +00001383 verifyFormat("function someFunc(args: string[]):\n"
1384 " {longReturnValue: string[]} {}",
1385 getGoogleJSStyleWithColumns(60));
Daniel Jasper3d934d32017-02-20 12:43:41 +00001386 verifyFormat(
1387 "var someValue = (v as aaaaaaaaaaaaaaaaaaaa<T>[])\n"
1388 " .someFunction(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
Daniel Jasperb10bdff2015-02-18 17:09:53 +00001389}
1390
Daniel Jasper91b1d1a2016-03-21 17:57:31 +00001391TEST_F(FormatTestJS, UnionIntersectionTypes) {
1392 verifyFormat("let x: A|B = A | B;");
1393 verifyFormat("let x: A&B|C = A & B;");
1394 verifyFormat("let x: Foo<A|B> = new Foo<A|B>();");
1395 verifyFormat("function(x: A|B): C&D {}");
1396 verifyFormat("function(x: A|B = A | B): C&D {}");
Martin Probst2ec23242016-06-09 22:49:04 +00001397 verifyFormat("function x(path: number|string) {}");
1398 verifyFormat("function x(): string|number {}");
Martin Probst1b7f9802016-06-23 19:52:32 +00001399 verifyFormat("type Foo = Bar|Baz;");
1400 verifyFormat("type Foo = Bar<X>|Baz;");
1401 verifyFormat("type Foo = (Bar<X>|Baz);");
1402 verifyFormat("let x: Bar|Baz;");
1403 verifyFormat("let x: Bar<X>|Baz;");
1404 verifyFormat("let x: (Foo|Bar)[];");
Martin Probstd96a0522017-06-07 12:53:22 +00001405 verifyFormat("type X = {\n"
1406 " a: Foo|Bar;\n"
1407 "};");
1408 verifyFormat("export type X = {\n"
1409 " a: Foo|Bar;\n"
1410 "};");
Daniel Jasper91b1d1a2016-03-21 17:57:31 +00001411}
1412
Martin Probst0fb46bb2017-08-08 15:00:58 +00001413TEST_F(FormatTestJS, UnionIntersectionTypesInObjectType) {
1414 verifyFormat("let x: {x: number|null} = {x: number | null};");
1415 verifyFormat("let nested: {x: {y: number|null}};");
1416 verifyFormat("let mixed: {x: [number|null, {w: number}]};");
1417 verifyFormat("class X {\n"
1418 " contructor(x: {\n"
1419 " a: a|null,\n"
1420 " b: b|null,\n"
1421 " }) {}\n"
1422 "}");
1423}
1424
Daniel Jasper83709082015-02-18 17:14:05 +00001425TEST_F(FormatTestJS, ClassDeclarations) {
1426 verifyFormat("class C {\n x: string = 12;\n}");
1427 verifyFormat("class C {\n x(): string => 12;\n}");
1428 verifyFormat("class C {\n ['x' + 2]: string = 12;\n}");
Martin Probst95ed8e72017-05-31 09:29:40 +00001429 verifyFormat("class C {\n"
1430 " foo() {}\n"
1431 " [bar]() {}\n"
1432 "}\n");
Daniel Jasper83709082015-02-18 17:14:05 +00001433 verifyFormat("class C {\n private x: string = 12;\n}");
1434 verifyFormat("class C {\n private static x: string = 12;\n}");
Daniel Jasper28d8a5a2016-09-07 23:01:13 +00001435 verifyFormat("class C {\n static x(): string {\n return 'asd';\n }\n}");
Daniel Jasper83709082015-02-18 17:14:05 +00001436 verifyFormat("class C extends P implements I {}");
Daniel Jasper6a5d38d2015-04-13 14:56:54 +00001437 verifyFormat("class C extends p.P implements i.I {}");
Martin Probst1027fb82017-02-07 14:05:30 +00001438 verifyFormat(
1439 "x(class {\n"
1440 " a(): A {}\n"
1441 "});");
Daniel Jasperb9a52812015-07-10 13:39:26 +00001442 verifyFormat("class Test {\n"
1443 " aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaaa):\n"
1444 " aaaaaaaaaaaaaaaaaaaaaa {}\n"
1445 "}");
Daniel Jasperd5ec65b2016-01-08 07:06:07 +00001446 verifyFormat("foo = class Name {\n"
1447 " constructor() {}\n"
1448 "};");
1449 verifyFormat("foo = class {\n"
1450 " constructor() {}\n"
1451 "};");
Daniel Jasperb9a49902016-01-09 15:56:28 +00001452 verifyFormat("class C {\n"
1453 " x: {y: Z;} = {};\n"
1454 " private y: {y: Z;} = {};\n"
1455 "}");
Daniel Jasper81dbb562015-06-03 08:43:18 +00001456
1457 // ':' is not a type declaration here.
1458 verifyFormat("class X {\n"
1459 " subs = {\n"
1460 " 'b': {\n"
1461 " 'c': 1,\n"
1462 " },\n"
1463 " };\n"
1464 "}");
Daniel Jasper64650082016-06-14 11:28:02 +00001465 verifyFormat("@Component({\n"
1466 " moduleId: module.id,\n"
1467 "})\n"
1468 "class SessionListComponent implements OnDestroy, OnInit {\n"
1469 "}");
Daniel Jasper83709082015-02-18 17:14:05 +00001470}
1471
Daniel Jasper29647492015-05-05 08:12:50 +00001472TEST_F(FormatTestJS, InterfaceDeclarations) {
1473 verifyFormat("interface I {\n"
1474 " x: string;\n"
Daniel Jasper6f5a1932015-12-29 08:54:23 +00001475 " enum: string[];\n"
Daniel Jasper87379302016-02-03 05:33:44 +00001476 " enum?: string[];\n"
Daniel Jasper259188b2015-06-12 04:56:34 +00001477 "}\n"
1478 "var y;");
Daniel Jasper5c235c02015-07-06 14:26:04 +00001479 // Ensure that state is reset after parsing the interface.
1480 verifyFormat("interface a {}\n"
1481 "export function b() {}\n"
1482 "var x;");
Daniel Jasperb542f9f2015-12-22 15:48:35 +00001483
1484 // Arrays of object type literals.
1485 verifyFormat("interface I {\n"
1486 " o: {}[];\n"
1487 "}");
Daniel Jasper29647492015-05-05 08:12:50 +00001488}
1489
Martin Probstcb870c52017-08-01 15:46:10 +00001490TEST_F(FormatTestJS, ObjectTypesInExtendsImplements) {
1491 verifyFormat("class C extends {} {}");
1492 verifyFormat("class C implements {bar: number} {}");
1493 // Somewhat odd, but probably closest to reasonable formatting?
1494 verifyFormat("class C implements {\n"
1495 " bar: number,\n"
1496 " baz: string,\n"
1497 "} {}");
1498 verifyFormat("class C<P extends {}> {}");
1499}
1500
Daniel Jasper90cf3802015-06-17 09:44:02 +00001501TEST_F(FormatTestJS, EnumDeclarations) {
1502 verifyFormat("enum Foo {\n"
Daniel Jasper9f4ec152015-06-17 09:44:07 +00001503 " A = 1,\n"
1504 " B\n"
1505 "}");
1506 verifyFormat("export /* somecomment*/ enum Foo {\n"
1507 " A = 1,\n"
1508 " B\n"
1509 "}");
1510 verifyFormat("enum Foo {\n"
Daniel Jasper90cf3802015-06-17 09:44:02 +00001511 " A = 1, // comment\n"
1512 " B\n"
1513 "}\n"
1514 "var x = 1;");
Martin Probstdb51cc52017-08-01 17:12:15 +00001515 verifyFormat("const enum Foo {\n"
1516 " A = 1,\n"
1517 " B\n"
1518 "}");
1519 verifyFormat("export const enum Foo {\n"
1520 " A = 1,\n"
1521 " B\n"
1522 "}");
Daniel Jasper90cf3802015-06-17 09:44:02 +00001523}
1524
Daniel Jasper3c42dba2015-02-18 17:17:15 +00001525TEST_F(FormatTestJS, MetadataAnnotations) {
1526 verifyFormat("@A\nclass C {\n}");
1527 verifyFormat("@A({arg: 'value'})\nclass C {\n}");
1528 verifyFormat("@A\n@B\nclass C {\n}");
1529 verifyFormat("class C {\n @A x: string;\n}");
1530 verifyFormat("class C {\n"
1531 " @A\n"
1532 " private x(): string {\n"
1533 " return 'y';\n"
1534 " }\n"
1535 "}");
Martin Probst716a5332016-04-11 09:17:57 +00001536 verifyFormat("class C {\n"
1537 " private x(@A x: string) {}\n"
1538 "}");
Daniel Jasper6fa9ec72015-02-19 16:03:16 +00001539 verifyFormat("class X {}\n"
1540 "class Y {}");
Martin Probstad063912017-04-26 12:36:49 +00001541 verifyFormat("class X {\n"
1542 " @property() private isReply = false;\n"
1543 "}\n");
Daniel Jasper3c42dba2015-02-18 17:17:15 +00001544}
1545
Martin Probst805c6162016-04-19 14:59:16 +00001546TEST_F(FormatTestJS, TypeAliases) {
1547 verifyFormat("type X = number;\n"
1548 "class C {}");
1549 verifyFormat("type X<Y> = Z<Y>;");
1550 verifyFormat("type X = {\n"
1551 " y: number\n"
1552 "};\n"
1553 "class C {}");
1554}
1555
Martin Probstb98ab892017-03-13 07:10:18 +00001556TEST_F(FormatTestJS, TypeInterfaceLineWrapping) {
1557 const FormatStyle &Style = getGoogleJSStyleWithColumns(20);
1558 verifyFormat("type LongTypeIsReallyUnreasonablyLong =\n"
1559 " string;\n",
1560 "type LongTypeIsReallyUnreasonablyLong = string;\n",
1561 Style);
1562 verifyFormat(
1563 "interface AbstractStrategyFactoryProvider {\n"
1564 " a: number\n"
1565 "}\n",
1566 "interface AbstractStrategyFactoryProvider { a: number }\n",
1567 Style);
1568}
1569
Daniel Jasper354aa512015-02-19 16:07:32 +00001570TEST_F(FormatTestJS, Modules) {
1571 verifyFormat("import SomeThing from 'some/module.js';");
1572 verifyFormat("import {X, Y} from 'some/module.js';");
Daniel Jasperefc1a832016-01-07 08:53:35 +00001573 verifyFormat("import a, {X, Y} from 'some/module.js';");
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +00001574 verifyFormat("import {X, Y,} from 'some/module.js';");
Daniel Jasper354aa512015-02-19 16:07:32 +00001575 verifyFormat("import {X as myLocalX, Y as myLocalY} from 'some/module.js';");
Martin Probst48622092016-06-01 15:22:47 +00001576 // Ensure Automatic Semicolon Insertion does not break on "as\n".
1577 verifyFormat("import {X as myX} from 'm';", "import {X as\n"
1578 " myX} from 'm';");
Daniel Jasper354aa512015-02-19 16:07:32 +00001579 verifyFormat("import * as lib from 'some/module.js';");
Daniel Jasper60948b12015-03-15 13:55:54 +00001580 verifyFormat("var x = {import: 1};\nx.import = 2;");
Daniel Jasperfca735c2015-02-19 16:14:18 +00001581
1582 verifyFormat("export function fn() {\n"
1583 " return 'fn';\n"
1584 "}");
Daniel Jasper20580fd2015-06-11 13:31:45 +00001585 verifyFormat("export function A() {}\n"
1586 "export default function B() {}\n"
1587 "export function C() {}");
Martin Probst053f1aa2016-04-19 14:55:37 +00001588 verifyFormat("export default () => {\n"
1589 " let x = 1;\n"
1590 " return x;\n"
1591 "}");
Daniel Jasper354aa512015-02-19 16:07:32 +00001592 verifyFormat("export const x = 12;");
1593 verifyFormat("export default class X {}");
Daniel Jasperfca735c2015-02-19 16:14:18 +00001594 verifyFormat("export {X, Y} from 'some/module.js';");
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +00001595 verifyFormat("export {X, Y,} from 'some/module.js';");
1596 verifyFormat("export {SomeVeryLongExport as X, "
1597 "SomeOtherVeryLongExport as Y} from 'some/module.js';");
1598 // export without 'from' is wrapped.
1599 verifyFormat("export let someRatherLongVariableName =\n"
1600 " someSurprisinglyLongVariable + someOtherRatherLongVar;");
1601 // ... but not if from is just an identifier.
Daniel Jasperfca735c2015-02-19 16:14:18 +00001602 verifyFormat("export {\n"
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +00001603 " from as from,\n"
Martin Probstdce8e412016-06-22 14:35:14 +00001604 " someSurprisinglyLongVariable as\n"
1605 " from\n"
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +00001606 "};",
1607 getGoogleJSStyleWithColumns(20));
Daniel Jasperfca735c2015-02-19 16:14:18 +00001608 verifyFormat("export class C {\n"
1609 " x: number;\n"
1610 " y: string;\n"
1611 "}");
1612 verifyFormat("export class X { y: number; }");
Daniel Jasper8620d4c2016-01-12 06:24:38 +00001613 verifyFormat("export abstract class X { y: number; }");
Daniel Jasperfca735c2015-02-19 16:14:18 +00001614 verifyFormat("export default class X { y: number }");
1615 verifyFormat("export default function() {\n return 1;\n}");
1616 verifyFormat("export var x = 12;");
Daniel Jasper910807d2015-06-12 04:52:02 +00001617 verifyFormat("class C {}\n"
1618 "export function f() {}\n"
1619 "var v;");
Daniel Jasperfca735c2015-02-19 16:14:18 +00001620 verifyFormat("export var x: number = 12;");
1621 verifyFormat("export const y = {\n"
1622 " a: 1,\n"
1623 " b: 2\n"
1624 "};");
Daniel Jasper216c9cd2015-06-12 05:08:18 +00001625 verifyFormat("export enum Foo {\n"
1626 " BAR,\n"
1627 " // adsdasd\n"
1628 " BAZ\n"
1629 "}");
Daniel Jasperb14f6672016-01-04 15:51:56 +00001630 verifyFormat("export default [\n"
1631 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
1632 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n"
1633 "];");
1634 verifyFormat("export default [];");
Daniel Jasper5e271462016-01-04 16:10:36 +00001635 verifyFormat("export default () => {};");
Daniel Jasperf55e4182016-01-11 22:57:40 +00001636 verifyFormat("export interface Foo { foo: number; }\n"
1637 "export class Bar {\n"
Daniel Jasper28d8a5a2016-09-07 23:01:13 +00001638 " blah(): string {\n"
1639 " return this.blah;\n"
1640 " };\n"
Daniel Jasperf55e4182016-01-11 22:57:40 +00001641 "}");
Daniel Jasper354aa512015-02-19 16:07:32 +00001642}
1643
Martin Probst0cd74ee2016-06-13 16:39:50 +00001644TEST_F(FormatTestJS, ImportWrapping) {
1645 verifyFormat("import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying,"
1646 " VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying"
1647 "} from 'some/module.js';");
1648 FormatStyle Style = getGoogleJSStyleWithColumns(80);
1649 Style.JavaScriptWrapImports = true;
1650 verifyFormat("import {\n"
1651 " VeryLongImportsAreAnnoying,\n"
1652 " VeryLongImportsAreAnnoying,\n"
1653 " VeryLongImportsAreAnnoying,\n"
1654 "} from 'some/module.js';",
1655 Style);
1656 verifyFormat("import {\n"
1657 " A,\n"
1658 " A,\n"
1659 "} from 'some/module.js';",
1660 Style);
1661 verifyFormat("export {\n"
1662 " A,\n"
1663 " A,\n"
1664 "} from 'some/module.js';",
1665 Style);
Martin Probst93008f02017-07-18 14:00:19 +00001666 Style.ColumnLimit = 40;
1667 // Using this version of verifyFormat because test::messUp hides the issue.
1668 verifyFormat("import {\n"
1669 " A,\n"
1670 "} from\n"
1671 " 'some/path/longer/than/column/limit/module.js';",
1672 " import { \n"
1673 " A, \n"
1674 " } from\n"
1675 " 'some/path/longer/than/column/limit/module.js' ; ",
1676 Style);
Martin Probst0cd74ee2016-06-13 16:39:50 +00001677}
1678
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001679TEST_F(FormatTestJS, TemplateStrings) {
1680 // Keeps any whitespace/indentation within the template string.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001681 verifyFormat("var x = `hello\n"
Martin Probst6181da42016-08-25 10:13:21 +00001682 " ${name}\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001683 " !`;",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001684 "var x = `hello\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001685 " ${ name }\n"
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001686 " !`;");
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001687
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001688 verifyFormat("var x =\n"
1689 " `hello ${world}` >= some();",
1690 getGoogleJSStyleWithColumns(34)); // Barely doesn't fit.
1691 verifyFormat("var x = `hello ${world}` >= some();",
Daniel Jasper553a5b02015-07-02 13:08:28 +00001692 getGoogleJSStyleWithColumns(35)); // Barely fits.
Martin Probste71b4cb2016-05-17 06:29:29 +00001693 verifyFormat("var x = `hellö ${wörld}` >= söme();",
1694 getGoogleJSStyleWithColumns(35)); // Fits due to UTF-8.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001695 verifyFormat("var x = `hello\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001696 " ${world}` >=\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +00001697 " some();",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001698 "var x =\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001699 " `hello\n"
1700 " ${world}` >= some();",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001701 getGoogleJSStyleWithColumns(21)); // Barely doesn't fit.
1702 verifyFormat("var x = `hello\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001703 " ${world}` >= some();",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001704 "var x =\n"
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001705 " `hello\n"
1706 " ${world}` >= some();",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001707 getGoogleJSStyleWithColumns(22)); // Barely fits.
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001708
Daniel Jasper553a5b02015-07-02 13:08:28 +00001709 verifyFormat("var x =\n"
1710 " `h`;",
1711 getGoogleJSStyleWithColumns(11));
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001712 verifyFormat("var x =\n `multi\n line`;", "var x = `multi\n line`;",
1713 getGoogleJSStyleWithColumns(13));
Daniel Jasper553a5b02015-07-02 13:08:28 +00001714 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
1715 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`);");
Martin Probste71b4cb2016-05-17 06:29:29 +00001716 // Repro for an obscure width-miscounting issue with template strings.
1717 verifyFormat(
1718 "someLongVariable =\n"
1719 " "
1720 "`${logPrefix[11]}/${logPrefix[12]}/${logPrefix[13]}${logPrefix[14]}`;",
1721 "someLongVariable = "
1722 "`${logPrefix[11]}/${logPrefix[12]}/${logPrefix[13]}${logPrefix[14]}`;");
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001723
Daniel Jasperf69b9222015-05-02 08:05:38 +00001724 // Make sure template strings get a proper ColumnWidth assigned, even if they
1725 // are first token in line.
1726 verifyFormat(
1727 "var a = aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
Daniel Jasper41a2bf72015-12-21 13:52:19 +00001728 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`;");
Daniel Jasperf69b9222015-05-02 08:05:38 +00001729
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001730 // Two template strings.
1731 verifyFormat("var x = `hello` == `hello`;");
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001732
1733 // Comments in template strings.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001734 verifyFormat("var x = `//a`;\n"
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001735 "var y;",
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001736 "var x =\n `//a`;\n"
1737 "var y ;");
1738 verifyFormat("var x = `/*a`;\n"
1739 "var y;",
1740 "var x =\n `/*a`;\n"
1741 "var y;");
Daniel Jasper2ebb0c52015-06-14 07:16:57 +00001742 // Unterminated string literals in a template string.
1743 verifyFormat("var x = `'`; // comment with matching quote '\n"
1744 "var y;");
1745 verifyFormat("var x = `\"`; // comment with matching quote \"\n"
1746 "var y;");
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001747 verifyFormat("it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa);",
1748 "it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa) ;",
1749 getGoogleJSStyleWithColumns(40));
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001750 // Backticks in a comment - not a template string.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001751 verifyFormat("var x = 1 // `/*a`;\n"
1752 " ;",
1753 "var x =\n 1 // `/*a`;\n"
1754 " ;");
1755 verifyFormat("/* ` */ var x = 1; /* ` */", "/* ` */ var x\n= 1; /* ` */");
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001756 // Comment spans multiple template strings.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001757 verifyFormat("var x = `/*a`;\n"
1758 "var y = ` */ `;",
1759 "var x =\n `/*a`;\n"
1760 "var y =\n ` */ `;");
Daniel Jasper0d6ac272015-04-16 08:20:51 +00001761 // Escaped backtick.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001762 verifyFormat("var x = ` \\` a`;\n"
1763 "var y;",
1764 "var x = ` \\` a`;\n"
1765 "var y;");
Martin Probst6181da42016-08-25 10:13:21 +00001766 // Escaped dollar.
1767 verifyFormat("var x = ` \\${foo}`;\n");
Daniel Jasperf2019292017-01-31 12:07:35 +00001768
1769 // The token stream can contain two string_literals in sequence, but that
1770 // doesn't mean that they are implicitly concatenated in JavaScript.
1771 verifyFormat("var f = `aaaa ${a ? 'a' : 'b'}`;");
Daniel Jasper24de6fb2017-01-31 13:03:07 +00001772
1773 // Ensure that scopes are appropriately set around evaluated expressions in
1774 // template strings.
1775 verifyFormat("var f = `aaaaaaaaaaaaa:${aaaaaaa.aaaaa} aaaaaaaa\n"
1776 " aaaaaaaaaaaaa:${aaaaaaa.aaaaa} aaaaaaaa`;",
1777 "var f = `aaaaaaaaaaaaa:${aaaaaaa. aaaaa} aaaaaaaa\n"
1778 " aaaaaaaaaaaaa:${ aaaaaaa. aaaaa} aaaaaaaa`;");
Daniel Jasperc06f6da2017-02-03 14:32:38 +00001779 verifyFormat("var x = someFunction(`${})`) //\n"
1780 " .oooooooooooooooooon();");
Daniel Jasper98e0b122017-02-20 14:51:16 +00001781 verifyFormat("var x = someFunction(`${aaaa}${\n"
1782 " aaaaa( //\n"
1783 " aaaaa)\n"
1784 " })`);");
Martin Probst6181da42016-08-25 10:13:21 +00001785}
1786
Daniel Jasper3f119412017-01-31 14:39:33 +00001787TEST_F(FormatTestJS, TemplateStringMultiLineExpression) {
Daniel Jasper98e0b122017-02-20 14:51:16 +00001788 verifyFormat("var f = `aaaaaaaaaaaaaaaaaa: ${\n"
1789 " aaaaa + //\n"
1790 " bbbb\n"
1791 " }`;",
Daniel Jasper3f119412017-01-31 14:39:33 +00001792 "var f = `aaaaaaaaaaaaaaaaaa: ${aaaaa + //\n"
1793 " bbbb}`;");
Daniel Jasper3f119412017-01-31 14:39:33 +00001794 verifyFormat("var f = `\n"
Daniel Jasper98e0b122017-02-20 14:51:16 +00001795 " aaaaaaaaaaaaaaaaaa: ${\n"
1796 " aaaaa + //\n"
1797 " bbbb\n"
1798 " }`;",
Daniel Jasper3f119412017-01-31 14:39:33 +00001799 "var f = `\n"
1800 " aaaaaaaaaaaaaaaaaa: ${ aaaaa + //\n"
1801 " bbbb }`;");
1802 verifyFormat("var f = `\n"
Daniel Jasper98e0b122017-02-20 14:51:16 +00001803 " aaaaaaaaaaaaaaaaaa: ${\n"
Daniel Jasper3f119412017-01-31 14:39:33 +00001804 " someFunction(\n"
1805 " aaaaa + //\n"
Daniel Jasper98e0b122017-02-20 14:51:16 +00001806 " bbbb)\n"
1807 " }`;",
Daniel Jasper3f119412017-01-31 14:39:33 +00001808 "var f = `\n"
Daniel Jasper98e0b122017-02-20 14:51:16 +00001809 " aaaaaaaaaaaaaaaaaa: ${someFunction (\n"
Daniel Jasper3f119412017-01-31 14:39:33 +00001810 " aaaaa + //\n"
1811 " bbbb)}`;");
Daniel Jasper98e0b122017-02-20 14:51:16 +00001812
1813 // It might be preferable to wrap before "someFunction".
Daniel Jasper3f119412017-01-31 14:39:33 +00001814 verifyFormat("var f = `\n"
Daniel Jasper98e0b122017-02-20 14:51:16 +00001815 " aaaaaaaaaaaaaaaaaa: ${someFunction({\n"
Daniel Jasper3f119412017-01-31 14:39:33 +00001816 " aaaa: aaaaa,\n"
1817 " bbbb: bbbbb,\n"
1818 " })}`;",
1819 "var f = `\n"
Daniel Jasper98e0b122017-02-20 14:51:16 +00001820 " aaaaaaaaaaaaaaaaaa: ${someFunction ({\n"
Daniel Jasper3f119412017-01-31 14:39:33 +00001821 " aaaa: aaaaa,\n"
1822 " bbbb: bbbbb,\n"
1823 " })}`;");
1824}
1825
Martin Probst717f6dc2016-10-21 05:11:38 +00001826TEST_F(FormatTestJS, TemplateStringASI) {
1827 verifyFormat("var x = `hello${world}`;", "var x = `hello${\n"
1828 " world\n"
1829 "}`;");
1830}
1831
Martin Probst6181da42016-08-25 10:13:21 +00001832TEST_F(FormatTestJS, NestedTemplateStrings) {
1833 verifyFormat(
1834 "var x = `<ul>${xs.map(x => `<li>${x}</li>`).join('\\n')}</ul>`;");
1835 verifyFormat("var x = `he${({text: 'll'}.text)}o`;");
Daniel Jasper58209dd2016-09-17 07:20:36 +00001836
1837 // Crashed at some point.
1838 verifyFormat("}");
Martin Probst6181da42016-08-25 10:13:21 +00001839}
1840
1841TEST_F(FormatTestJS, TaggedTemplateStrings) {
1842 verifyFormat("var x = html`<ul>`;");
Martin Probst37a7f912017-07-04 15:30:21 +00001843 verifyFormat("yield `hello`;");
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001844}
1845
Martin Probst805c6162016-04-19 14:59:16 +00001846TEST_F(FormatTestJS, CastSyntax) {
1847 verifyFormat("var x = <type>foo;");
1848 verifyFormat("var x = foo as type;");
Martin Probstdce8e412016-06-22 14:35:14 +00001849 verifyFormat("let x = (a + b) as\n"
1850 " LongTypeIsLong;",
1851 getGoogleJSStyleWithColumns(20));
Daniel Jasper887a3992016-06-14 13:54:38 +00001852 verifyFormat("foo = <Bar[]>[\n"
1853 " 1, //\n"
1854 " 2\n"
1855 "];");
Martin Probste1e12a72016-08-19 14:35:01 +00001856 verifyFormat("var x = [{x: 1} as type];");
Martin Probsted87d782016-08-22 14:23:30 +00001857 verifyFormat("x = x as [a, b];");
1858 verifyFormat("x = x as {a: string};");
1859 verifyFormat("x = x as (string);");
Martin Probst34ecf422016-09-06 18:55:34 +00001860 verifyFormat("x = x! as (string);");
Daniel Jasper01b87832017-03-01 19:26:12 +00001861 verifyFormat("var x = something.someFunction() as\n"
1862 " something;",
1863 getGoogleJSStyleWithColumns(40));
Martin Probst805c6162016-04-19 14:59:16 +00001864}
Daniel Jasperbc46b932015-03-15 13:59:51 +00001865
1866TEST_F(FormatTestJS, TypeArguments) {
1867 verifyFormat("class X<Y> {}");
1868 verifyFormat("new X<Y>();");
1869 verifyFormat("foo<Y>(a);");
1870 verifyFormat("var x: X<Y>[];");
1871 verifyFormat("class C extends D<E> implements F<G>, H<I> {}");
Daniel Jasper20580fd2015-06-11 13:31:45 +00001872 verifyFormat("function f(a: List<any> = null) {}");
1873 verifyFormat("function f(): List<any> {}");
Daniel Jasper5a3de1d2015-07-03 10:37:23 +00001874 verifyFormat("function aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa():\n"
1875 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb {}");
Daniel Jasper6501f7e2015-10-27 12:38:37 +00001876 verifyFormat("function aaaaaaaaaa(\n"
1877 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa,\n"
1878 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa):\n"
Daniel Jasperb2328b12015-07-06 14:07:51 +00001879 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa {}");
Daniel Jasperbc46b932015-03-15 13:59:51 +00001880}
1881
Daniel Jasper779c66f2015-12-30 08:00:58 +00001882TEST_F(FormatTestJS, UserDefinedTypeGuards) {
1883 verifyFormat(
1884 "function foo(check: Object):\n"
1885 " check is {foo: string, bar: string, baz: string, foobar: string} {\n"
1886 " return 'bar' in check;\n"
1887 "}\n");
1888}
1889
Daniel Jaspera74f5072015-04-13 15:01:40 +00001890TEST_F(FormatTestJS, OptionalTypes) {
Daniel Jasper20580fd2015-06-11 13:31:45 +00001891 verifyFormat("function x(a?: b, c?, d?) {}");
Daniel Jaspera74f5072015-04-13 15:01:40 +00001892 verifyFormat("class X {\n"
1893 " y?: z;\n"
1894 " z?;\n"
1895 "}");
Daniel Jasper9326f912015-05-05 08:40:32 +00001896 verifyFormat("interface X {\n"
1897 " y?(): z;\n"
1898 "}");
Daniel Jasper3e0dcc22015-05-27 05:37:40 +00001899 verifyFormat("constructor({aa}: {\n"
1900 " aa?: string,\n"
1901 " aaaaaaaa?: string,\n"
1902 " aaaaaaaaaaaaaaa?: boolean,\n"
1903 " aaaaaa?: List<string>\n"
Daniel Jasper20580fd2015-06-11 13:31:45 +00001904 "}) {}");
Daniel Jaspera74f5072015-04-13 15:01:40 +00001905}
1906
Daniel Jasperd9309772015-04-13 15:03:30 +00001907TEST_F(FormatTestJS, IndexSignature) {
1908 verifyFormat("var x: {[k: string]: v};");
1909}
1910
Daniel Jasper6501f7e2015-10-27 12:38:37 +00001911TEST_F(FormatTestJS, WrapAfterParen) {
1912 verifyFormat("xxxxxxxxxxx(\n"
1913 " aaa, aaa);",
1914 getGoogleJSStyleWithColumns(20));
1915 verifyFormat("xxxxxxxxxxx(\n"
1916 " aaa, aaa, aaa,\n"
1917 " aaa, aaa, aaa);",
1918 getGoogleJSStyleWithColumns(20));
1919 verifyFormat("xxxxxxxxxxx(\n"
1920 " aaaaaaaaaaaaaaaaaaaaaaaa,\n"
1921 " function(x) {\n"
1922 " y(); //\n"
1923 " });",
1924 getGoogleJSStyleWithColumns(40));
1925 verifyFormat("while (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n"
1926 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}");
1927}
1928
Daniel Jasperd196abb2016-01-08 08:14:58 +00001929TEST_F(FormatTestJS, JSDocAnnotations) {
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001930 verifyFormat("/**\n"
1931 " * @export {this.is.a.long.path.to.a.Type}\n"
1932 " */",
1933 "/**\n"
1934 " * @export {this.is.a.long.path.to.a.Type}\n"
1935 " */",
1936 getGoogleJSStyleWithColumns(20));
Martin Probstbb46a7d2017-02-28 11:08:24 +00001937 verifyFormat("/**\n"
1938 " * @mods {this.is.a.long.path.to.a.Type}\n"
1939 " */",
1940 "/**\n"
1941 " * @mods {this.is.a.long.path.to.a.Type}\n"
1942 " */",
1943 getGoogleJSStyleWithColumns(20));
1944 verifyFormat("/**\n"
1945 " * @param {this.is.a.long.path.to.a.Type}\n"
1946 " */",
1947 "/**\n"
1948 " * @param {this.is.a.long.path.to.a.Type}\n"
1949 " */",
1950 getGoogleJSStyleWithColumns(20));
Martin Probstb4cdb652017-03-13 09:39:23 +00001951 verifyFormat("/**\n"
1952 " * @see http://very/very/long/url/is/long\n"
1953 " */",
1954 "/**\n"
1955 " * @see http://very/very/long/url/is/long\n"
1956 " */",
1957 getGoogleJSStyleWithColumns(20));
Martin Probstbb46a7d2017-02-28 11:08:24 +00001958 verifyFormat(
1959 "/**\n"
1960 " * @param This is a\n"
1961 " * long comment but\n"
1962 " * no type\n"
1963 " */",
1964 "/**\n"
1965 " * @param This is a long comment but no type\n"
1966 " */",
1967 getGoogleJSStyleWithColumns(20));
Krasimir Georgiev17725d82017-03-08 08:55:12 +00001968 // Don't break @param line, but reindent it and reflow unrelated lines.
1969 verifyFormat("{\n"
1970 " /**\n"
1971 " * long long long\n"
1972 " * long\n"
1973 " * @param {this.is.a.long.path.to.a.Type} a\n"
1974 " * long long long\n"
1975 " * long long\n"
1976 " */\n"
1977 " function f(a) {}\n"
1978 "}",
1979 "{\n"
1980 "/**\n"
1981 " * long long long long\n"
1982 " * @param {this.is.a.long.path.to.a.Type} a\n"
1983 " * long long long long\n"
1984 " * long\n"
1985 " */\n"
1986 " function f(a) {}\n"
1987 "}",
1988 getGoogleJSStyleWithColumns(20));
Daniel Jasperd196abb2016-01-08 08:14:58 +00001989}
1990
Daniel Jasperabd1f572016-03-02 22:44:03 +00001991TEST_F(FormatTestJS, RequoteStringsSingle) {
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00001992 verifyFormat("var x = 'foo';", "var x = \"foo\";");
1993 verifyFormat("var x = 'fo\\'o\\'';", "var x = \"fo'o'\";");
1994 verifyFormat("var x = 'fo\\'o\\'';", "var x = \"fo\\'o'\";");
1995 verifyFormat(
1996 "var x =\n"
1997 " 'foo\\'';",
1998 // Code below is 15 chars wide, doesn't fit into the line with the
1999 // \ escape added.
2000 "var x = \"foo'\";", getGoogleJSStyleWithColumns(15));
Daniel Jasperabd1f572016-03-02 22:44:03 +00002001 // Removes no-longer needed \ escape from ".
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00002002 verifyFormat("var x = 'fo\"o';", "var x = \"fo\\\"o\";");
Daniel Jasperabd1f572016-03-02 22:44:03 +00002003 // Code below fits into 15 chars *after* removing the \ escape.
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00002004 verifyFormat("var x = 'fo\"o';", "var x = \"fo\\\"o\";",
2005 getGoogleJSStyleWithColumns(15));
Martin Probsta1669792016-05-12 11:20:32 +00002006 verifyFormat("// clang-format off\n"
2007 "let x = \"double\";\n"
2008 "// clang-format on\n"
2009 "let x = 'single';\n",
2010 "// clang-format off\n"
2011 "let x = \"double\";\n"
2012 "// clang-format on\n"
2013 "let x = \"single\";\n");
Daniel Jasperabd1f572016-03-02 22:44:03 +00002014}
2015
Martin Probsta9855af2016-09-02 14:29:48 +00002016TEST_F(FormatTestJS, RequoteAndIndent) {
2017 verifyFormat("let x = someVeryLongFunctionThatGoesOnAndOn(\n"
2018 " 'double quoted string that needs wrapping');",
2019 "let x = someVeryLongFunctionThatGoesOnAndOn("
2020 "\"double quoted string that needs wrapping\");");
Daniel Jasper496c1992016-09-07 22:48:53 +00002021
2022 verifyFormat("let x =\n"
2023 " 'foo\\'oo';\n"
2024 "let x =\n"
2025 " 'foo\\'oo';",
2026 "let x=\"foo'oo\";\n"
2027 "let x=\"foo'oo\";",
2028 getGoogleJSStyleWithColumns(15));
Martin Probsta9855af2016-09-02 14:29:48 +00002029}
2030
Daniel Jasperabd1f572016-03-02 22:44:03 +00002031TEST_F(FormatTestJS, RequoteStringsDouble) {
2032 FormatStyle DoubleQuotes = getGoogleStyle(FormatStyle::LK_JavaScript);
2033 DoubleQuotes.JavaScriptQuotes = FormatStyle::JSQS_Double;
2034 verifyFormat("var x = \"foo\";", DoubleQuotes);
Daniel Jasper1dcbbcfc2016-03-14 19:21:36 +00002035 verifyFormat("var x = \"foo\";", "var x = 'foo';", DoubleQuotes);
2036 verifyFormat("var x = \"fo'o\";", "var x = 'fo\\'o';", DoubleQuotes);
Daniel Jasperabd1f572016-03-02 22:44:03 +00002037}
2038
2039TEST_F(FormatTestJS, RequoteStringsLeave) {
2040 FormatStyle LeaveQuotes = getGoogleStyle(FormatStyle::LK_JavaScript);
2041 LeaveQuotes.JavaScriptQuotes = FormatStyle::JSQS_Leave;
2042 verifyFormat("var x = \"foo\";", LeaveQuotes);
2043 verifyFormat("var x = 'foo';", LeaveQuotes);
2044}
2045
Martin Probst7ea9b6d2016-05-29 14:41:36 +00002046TEST_F(FormatTestJS, SupportShebangLines) {
2047 verifyFormat("#!/usr/bin/env node\n"
2048 "var x = hello();",
2049 "#!/usr/bin/env node\n"
2050 "var x = hello();");
2051}
2052
Martin Probst0eb40cf2016-06-13 00:49:54 +00002053TEST_F(FormatTestJS, NonNullAssertionOperator) {
2054 verifyFormat("let x = foo!.bar();\n");
2055 verifyFormat("let x = foo ? bar! : baz;\n");
2056 verifyFormat("let x = !foo;\n");
2057 verifyFormat("let x = foo[0]!;\n");
2058 verifyFormat("let x = (foo)!;\n");
Martin Probstab60acb2017-05-22 14:58:26 +00002059 verifyFormat("let x = x(foo!);\n");
2060 verifyFormat(
2061 "a.aaaaaa(a.a!).then(\n"
2062 " x => x(x));\n",
2063 getGoogleJSStyleWithColumns(20));
Daniel Jasper8315ea12016-11-09 14:12:55 +00002064 verifyFormat("let x = foo! - 1;\n");
Martin Probst0eb40cf2016-06-13 00:49:54 +00002065 verifyFormat("let x = {foo: 1}!;\n");
Martin Probst22b8d2692017-03-13 09:14:23 +00002066 verifyFormat(
2067 "let x = hello.foo()!\n"
2068 " .foo()!\n"
2069 " .foo()!\n"
2070 " .foo()!;\n",
2071 getGoogleJSStyleWithColumns(20));
Martin Probst79f9c5f2017-05-12 13:00:33 +00002072 verifyFormat("let x = namespace!;\n");
Martin Probst82b3d902017-05-15 08:15:53 +00002073 verifyFormat("return !!x;\n");
Martin Probst0eb40cf2016-06-13 00:49:54 +00002074}
2075
Martin Probst31d6da72016-06-23 21:51:49 +00002076TEST_F(FormatTestJS, Conditional) {
2077 verifyFormat("y = x ? 1 : 2;");
Daniel Jasperd9d8da22016-07-12 15:45:53 +00002078 verifyFormat("x ? 1 : 2;");
Martin Probst31d6da72016-06-23 21:51:49 +00002079 verifyFormat("class Foo {\n"
2080 " field = true ? 1 : 2;\n"
2081 " method(a = true ? 1 : 2) {}\n"
2082 "}");
2083}
2084
Martin Probstfbbe75b2016-09-18 17:33:51 +00002085TEST_F(FormatTestJS, ImportComments) {
2086 verifyFormat("import {x} from 'x'; // from some location",
2087 getGoogleJSStyleWithColumns(25));
2088 verifyFormat("// taze: x from 'location'", getGoogleJSStyleWithColumns(10));
Martin Probst2083f312017-05-09 12:45:48 +00002089 verifyFormat("/// <reference path=\"some/location\" />", getGoogleJSStyleWithColumns(10));
Martin Probstfbbe75b2016-09-18 17:33:51 +00002090}
Martin Probst4ef03702017-05-04 15:04:04 +00002091
2092TEST_F(FormatTestJS, Exponentiation) {
2093 verifyFormat("squared = x ** 2;");
2094 verifyFormat("squared **= 2;");
2095}
2096
Martin Probst38423272017-06-06 12:38:29 +00002097TEST_F(FormatTestJS, NestedLiterals) {
2098 FormatStyle FourSpaces = getGoogleJSStyleWithColumns(15);
2099 FourSpaces.IndentWidth = 4;
2100 verifyFormat("var l = [\n"
2101 " [\n"
2102 " 1,\n"
2103 " ],\n"
2104 "];", FourSpaces);
2105 verifyFormat("var l = [\n"
2106 " {\n"
2107 " 1: 1,\n"
2108 " },\n"
2109 "];", FourSpaces);
2110 verifyFormat("someFunction(\n"
2111 " p1,\n"
2112 " [\n"
2113 " 1,\n"
2114 " ],\n"
2115 ");", FourSpaces);
2116 verifyFormat("someFunction(\n"
2117 " p1,\n"
2118 " {\n"
2119 " 1: 1,\n"
2120 " },\n"
2121 ");", FourSpaces);
2122 verifyFormat("var o = {\n"
2123 " 1: 1,\n"
2124 " 2: {\n"
2125 " 3: 3,\n"
2126 " },\n"
2127 "};", FourSpaces);
2128 verifyFormat("var o = {\n"
2129 " 1: 1,\n"
2130 " 2: [\n"
2131 " 3,\n"
2132 " ],\n"
2133 "};", FourSpaces);
2134}
2135
Martin Probst64d31ed2017-08-08 14:52:42 +00002136TEST_F(FormatTestJS, BackslashesInComments) {
2137 verifyFormat("// hello \\\n"
2138 "if (x) foo();\n",
2139 "// hello \\\n"
2140 " if ( x) \n"
2141 " foo();\n");
2142 verifyFormat("/* ignore \\\n"
2143 " */\n"
2144 "if (x) foo();\n",
2145 "/* ignore \\\n"
2146 " */\n"
2147 " if ( x) foo();\n");
2148 verifyFormat("// st \\ art\\\n"
2149 "// comment"
2150 "// continue \\\n"
2151 "formatMe();\n",
2152 "// st \\ art\\\n"
2153 "// comment"
2154 "// continue \\\n"
2155 "formatMe( );\n");
2156}
2157
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002158} // end namespace tooling
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +00002159} // end namespace clang