blob: d95ff9ba8341a57fe99d7d7382f7401a9718f71e [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));
27 tooling::Replacements Replaces = reformat(Style, Code, Ranges);
28 std::string Result = applyAllReplacements(Code, Replaces);
29 EXPECT_NE("", Result);
30 DEBUG(llvm::errs() << "\n" << Result << "\n\n");
31 return Result;
32 }
33
Daniel Jasper069e5f42014-05-20 11:14:57 +000034 static std::string format(
35 llvm::StringRef Code,
36 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) {
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000037 return format(Code, 0, Code.size(), Style);
38 }
39
Alexander Kornienkoc1637f12013-12-10 11:28:13 +000040 static FormatStyle getGoogleJSStyleWithColumns(unsigned ColumnLimit) {
Nico Weber514ecc82014-02-02 20:50:45 +000041 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000042 Style.ColumnLimit = ColumnLimit;
43 return Style;
44 }
45
Nico Weber514ecc82014-02-02 20:50:45 +000046 static void verifyFormat(
47 llvm::StringRef Code,
48 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) {
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000049 EXPECT_EQ(Code.str(), format(test::messUp(Code), Style));
50 }
51};
52
53TEST_F(FormatTestJS, UnderstandsJavaScriptOperators) {
54 verifyFormat("a == = b;");
55 verifyFormat("a != = b;");
56
57 verifyFormat("a === b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +000058 verifyFormat("aaaaaaa ===\n b;", getGoogleJSStyleWithColumns(10));
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000059 verifyFormat("a !== b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +000060 verifyFormat("aaaaaaa !==\n b;", getGoogleJSStyleWithColumns(10));
61 verifyFormat("if (a + b + c +\n"
62 " d !==\n"
63 " e + f + g)\n"
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000064 " q();",
Alexander Kornienkoc1637f12013-12-10 11:28:13 +000065 getGoogleJSStyleWithColumns(20));
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000066
67 verifyFormat("a >> >= b;");
68
69 verifyFormat("a >>> b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +000070 verifyFormat("aaaaaaa >>>\n b;", getGoogleJSStyleWithColumns(10));
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000071 verifyFormat("a >>>= b;");
Daniel Jaspere551bb72014-11-05 17:22:31 +000072 verifyFormat("aaaaaaa >>>=\n b;", getGoogleJSStyleWithColumns(10));
73 verifyFormat("if (a + b + c +\n"
74 " d >>>\n"
75 " e + f + g)\n"
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000076 " q();",
Alexander Kornienkoc1637f12013-12-10 11:28:13 +000077 getGoogleJSStyleWithColumns(20));
Daniel Jaspere551bb72014-11-05 17:22:31 +000078 verifyFormat("var x = aaaaaaaaaa ?\n"
79 " bbbbbb :\n"
80 " ccc;",
Alexander Kornienkoc1637f12013-12-10 11:28:13 +000081 getGoogleJSStyleWithColumns(20));
Daniel Jasper78214392014-05-19 07:27:02 +000082
83 verifyFormat("var b = a.map((x) => x + 1);");
Daniel Jasper3549ea12014-09-19 10:48:15 +000084 verifyFormat("return ('aaa') in bbbb;");
Daniel Jasper08051992015-05-26 07:18:56 +000085
86 // ES6 spread operator.
87 verifyFormat("someFunction(...a);");
88 verifyFormat("var x = [1, ...a, 2];");
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +000089}
90
Daniel Jasper3a038de2014-09-05 08:53:45 +000091TEST_F(FormatTestJS, UnderstandsAmpAmp) {
92 verifyFormat("e && e.SomeFunction();");
93}
94
Daniel Jasper4db69bd2014-09-04 18:23:42 +000095TEST_F(FormatTestJS, LiteralOperatorsCanBeKeywords) {
96 verifyFormat("not.and.or.not_eq = 1;");
97}
98
Daniel Jasper0dd52912014-05-19 07:37:07 +000099TEST_F(FormatTestJS, ES6DestructuringAssignment) {
100 verifyFormat("var [a, b, c] = [1, 2, 3];");
Daniel Jasper60948b12015-03-15 13:55:54 +0000101 verifyFormat("var {a, b} = {a: 1, b: 2};");
Daniel Jasper0dd52912014-05-19 07:37:07 +0000102}
103
Daniel Jasper17062ff2014-06-10 14:44:02 +0000104TEST_F(FormatTestJS, ContainerLiterals) {
Manuel Klimek79e06082015-05-21 12:23:34 +0000105 verifyFormat("var x = {y: function(a) { return a; }};");
Daniel Jasper17062ff2014-06-10 14:44:02 +0000106 verifyFormat("return {\n"
107 " link: function() {\n"
108 " f(); //\n"
109 " }\n"
110 "};");
111 verifyFormat("return {\n"
112 " a: a,\n"
113 " link: function() {\n"
114 " f(); //\n"
115 " }\n"
116 "};");
117 verifyFormat("return {\n"
118 " a: a,\n"
Daniel Jasper90ebc982014-09-05 09:27:38 +0000119 " link: function() {\n"
120 " f(); //\n"
121 " },\n"
122 " link: function() {\n"
123 " f(); //\n"
124 " }\n"
Daniel Jasper17062ff2014-06-10 14:44:02 +0000125 "};");
Daniel Jasper94e11d02014-09-04 14:58:30 +0000126 verifyFormat("var stuff = {\n"
127 " // comment for update\n"
128 " update: false,\n"
129 " // comment for modules\n"
130 " modules: false,\n"
131 " // comment for tasks\n"
132 " tasks: false\n"
133 "};");
Daniel Jasper97bfb7b2014-09-05 08:29:31 +0000134 verifyFormat("return {\n"
135 " 'finish':\n"
136 " //\n"
137 " a\n"
138 "};");
Daniel Jasper40874322014-11-27 15:24:48 +0000139 verifyFormat("var obj = {\n"
140 " fooooooooo: function(x) {\n"
141 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n"
142 " }\n"
143 "};");
Daniel Jasper60948b12015-03-15 13:55:54 +0000144 // Simple object literal, as opposed to enum style below.
145 verifyFormat("var obj = {a: 123};");
146 // Enum style top level assignment.
147 verifyFormat("X = {\n a: 123\n};");
148 verifyFormat("X.Y = {\n a: 123\n};");
149 verifyFormat("x = foo && {a: 123};");
Manuel Klimek79e06082015-05-21 12:23:34 +0000150
151 // Arrow functions in object literals.
152 verifyFormat("var x = {y: (a) => { return a; }};");
153 verifyFormat("var x = {y: (a) => a};");
Daniel Jasper8c42d442015-05-29 06:19:49 +0000154
155 // Computed keys.
156 verifyFormat("var x = {\n"
157 " [a]: 1,\n"
158 "};");
Daniel Jasper17062ff2014-06-10 14:44:02 +0000159}
160
Daniel Jasperf46dec82015-03-31 14:34:15 +0000161TEST_F(FormatTestJS, MethodsInObjectLiterals) {
162 verifyFormat("var o = {\n"
163 " value: 'test',\n"
164 " get value() { // getter\n"
165 " return this.value;\n"
166 " }\n"
167 "};");
168 verifyFormat("var o = {\n"
169 " value: 'test',\n"
170 " set value(val) { // setter\n"
171 " this.value = val;\n"
172 " }\n"
173 "};");
174 verifyFormat("var o = {\n"
175 " value: 'test',\n"
176 " someMethod(val) { // method\n"
177 " doSomething(this.value + val);\n"
178 " }\n"
179 "};");
Daniel Jasper739ec532015-04-04 07:56:55 +0000180 verifyFormat("var o = {\n"
181 " someMethod(val) { // method\n"
182 " doSomething(this.value + val);\n"
183 " },\n"
184 " someOtherMethod(val) { // method\n"
185 " doSomething(this.value + val);\n"
186 " }\n"
187 "};");
Daniel Jasperf46dec82015-03-31 14:34:15 +0000188}
189
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000190TEST_F(FormatTestJS, SpacesInContainerLiterals) {
191 verifyFormat("var arr = [1, 2, 3];");
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000192 verifyFormat("f({a: 1, b: 2, c: 3});");
Nico Weber514ecc82014-02-02 20:50:45 +0000193
Daniel Jasper2a958322014-05-21 13:26:58 +0000194 verifyFormat("var object_literal_with_long_name = {\n"
195 " a: 'aaaaaaaaaaaaaaaaaa',\n"
196 " b: 'bbbbbbbbbbbbbbbbbb'\n"
197 "};");
198
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000199 verifyFormat("f({a: 1, b: 2, c: 3});",
Nico Weber514ecc82014-02-02 20:50:45 +0000200 getChromiumStyle(FormatStyle::LK_JavaScript));
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000201 verifyFormat("f({'a': [{}]});");
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000202}
203
Daniel Jasper86fee2f2014-01-31 12:49:42 +0000204TEST_F(FormatTestJS, SingleQuoteStrings) {
205 verifyFormat("this.function('', true);");
206}
207
Daniel Jasper4a39c842014-05-06 13:54:10 +0000208TEST_F(FormatTestJS, GoogScopes) {
209 verifyFormat("goog.scope(function() {\n"
210 "var x = a.b;\n"
211 "var y = c.d;\n"
212 "}); // goog.scope");
Daniel Jasper02c7bca2015-03-30 09:56:50 +0000213 verifyFormat("goog.scope(function() {\n"
214 "// test\n"
215 "var x = 0;\n"
216 "// test\n"
217 "});");
Daniel Jasper4a39c842014-05-06 13:54:10 +0000218}
219
Daniel Jasper616de8642014-11-23 16:46:28 +0000220TEST_F(FormatTestJS, GoogModules) {
221 verifyFormat("goog.module('this.is.really.absurdly.long');",
222 getGoogleJSStyleWithColumns(40));
223 verifyFormat("goog.require('this.is.really.absurdly.long');",
224 getGoogleJSStyleWithColumns(40));
225 verifyFormat("goog.provide('this.is.really.absurdly.long');",
226 getGoogleJSStyleWithColumns(40));
227 verifyFormat("var long = goog.require('this.is.really.absurdly.long');",
228 getGoogleJSStyleWithColumns(40));
Daniel Jasper53c38f42014-11-27 14:46:03 +0000229
230 // These should be wrapped normally.
231 verifyFormat(
232 "var MyLongClassName =\n"
233 " goog.module.get('my.long.module.name.followedBy.MyLongClassName');");
Daniel Jasper616de8642014-11-23 16:46:28 +0000234}
235
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000236TEST_F(FormatTestJS, FormatsFreestandingFunctions) {
237 verifyFormat("function outer1(a, b) {\n"
238 " function inner1(a, b) { return a; }\n"
239 " inner1(a, b);\n"
240 "}\n"
241 "function outer2(a, b) {\n"
242 " function inner2(a, b) { return a; }\n"
243 " inner2(a, b);\n"
244 "}");
245}
246
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000247TEST_F(FormatTestJS, ArrayLiterals) {
248 verifyFormat("var aaaaa: List<SomeThing> = [\n"
249 " new SomeThingAAAAAAAAAAAA(),\n"
250 " new SomeThingBBBBBBBBB()\n"
251 "];");
252}
253
Daniel Jasper5217a8b2014-06-13 07:02:04 +0000254TEST_F(FormatTestJS, FunctionLiterals) {
Daniel Jasper3f69ba12014-09-05 08:42:27 +0000255 verifyFormat("doFoo(function() {});");
Daniel Jasper79dffb42014-05-07 09:48:30 +0000256 verifyFormat("doFoo(function() { return 1; });");
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000257 verifyFormat("var func = function() {\n"
258 " return 1;\n"
259 "};");
Daniel Jasperc03e16a2014-05-08 09:25:39 +0000260 verifyFormat("return {\n"
261 " body: {\n"
262 " setAttribute: function(key, val) { this[key] = val; },\n"
263 " getAttribute: function(key) { return this[key]; },\n"
264 " style: {direction: ''}\n"
265 " }\n"
266 "};");
Daniel Jaspere551bb72014-11-05 17:22:31 +0000267 EXPECT_EQ("abc = xyz ?\n"
268 " function() {\n"
269 " return 1;\n"
270 " } :\n"
271 " function() {\n"
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000272 " return -1;\n"
273 " };",
Daniel Jasper069e5f42014-05-20 11:14:57 +0000274 format("abc=xyz?function(){return 1;}:function(){return -1;};"));
Daniel Jasperb16b9692014-05-21 12:51:23 +0000275
276 verifyFormat("var closure = goog.bind(\n"
277 " function() { // comment\n"
278 " foo();\n"
279 " bar();\n"
280 " },\n"
281 " this, arg1IsReallyLongAndNeeedsLineBreaks,\n"
282 " arg3IsReallyLongAndNeeedsLineBreaks);");
283 verifyFormat("var closure = goog.bind(function() { // comment\n"
284 " foo();\n"
285 " bar();\n"
286 "}, this);");
Daniel Jasper58cb2ed2014-06-06 13:49:04 +0000287 verifyFormat("return {\n"
288 " a: 'E',\n"
289 " b: function() {\n"
290 " return function() {\n"
291 " f(); //\n"
292 " };\n"
293 " }\n"
294 "};");
Daniel Jasper41368e92014-11-27 15:37:42 +0000295 verifyFormat("{\n"
296 " var someVariable = function(x) {\n"
297 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n"
298 " };\n"
299 "}");
Daniel Jasper7325aee2015-05-08 08:38:52 +0000300 verifyFormat("someLooooooooongFunction(\n"
301 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
302 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
303 " function(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
304 " // code\n"
305 " });");
Daniel Jasper5f3ea472014-05-22 08:36:53 +0000306
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000307 verifyFormat("f({a: function() { return 1; }});",
308 getGoogleJSStyleWithColumns(33));
309 verifyFormat("f({\n"
Daniel Jasper5f3ea472014-05-22 08:36:53 +0000310 " a: function() { return 1; }\n"
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000311 "});",
312 getGoogleJSStyleWithColumns(32));
Daniel Jasper5217a8b2014-06-13 07:02:04 +0000313
314 verifyFormat("return {\n"
315 " a: function SomeFunction() {\n"
316 " // ...\n"
317 " return 1;\n"
318 " }\n"
319 "};");
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000320 verifyFormat("this.someObject.doSomething(aaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
321 " .then(goog.bind(function(aaaaaaaaaaa) {\n"
322 " someFunction();\n"
323 " someFunction();\n"
324 " }, this), aaaaaaaaaaaaaaaaa);");
325
326 // FIXME: This is not ideal yet.
327 verifyFormat("someFunction(goog.bind(\n"
328 " function() {\n"
329 " doSomething();\n"
330 " doSomething();\n"
331 " },\n"
332 " this),\n"
333 " goog.bind(function() {\n"
334 " doSomething();\n"
335 " doSomething();\n"
336 " }, this));");
Daniel Jasper79dffb42014-05-07 09:48:30 +0000337}
338
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000339TEST_F(FormatTestJS, InliningFunctionLiterals) {
340 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
341 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
342 verifyFormat("var func = function() {\n"
343 " return 1;\n"
344 "};",
345 Style);
346 verifyFormat("var func = doSomething(function() { return 1; });", Style);
347 verifyFormat("var outer = function() {\n"
348 " var inner = function() { return 1; }\n"
349 "};",
350 Style);
351 verifyFormat("function outer1(a, b) {\n"
352 " function inner1(a, b) { return a; }\n"
353 "}",
354 Style);
355
356 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
357 verifyFormat("var func = function() { return 1; };", Style);
358 verifyFormat("var func = doSomething(function() { return 1; });", Style);
359 verifyFormat(
360 "var outer = function() { var inner = function() { return 1; } };",
361 Style);
362 verifyFormat("function outer1(a, b) {\n"
363 " function inner1(a, b) { return a; }\n"
364 "}",
365 Style);
366
367 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
368 verifyFormat("var func = function() {\n"
369 " return 1;\n"
370 "};",
371 Style);
372 verifyFormat("var func = doSomething(function() {\n"
373 " return 1;\n"
374 "});",
375 Style);
376 verifyFormat("var outer = function() {\n"
377 " var inner = function() {\n"
378 " return 1;\n"
379 " }\n"
380 "};",
381 Style);
382 verifyFormat("function outer1(a, b) {\n"
383 " function inner1(a, b) {\n"
384 " return a;\n"
385 " }\n"
386 "}",
387 Style);
388}
389
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000390TEST_F(FormatTestJS, MultipleFunctionLiterals) {
391 verifyFormat("promise.then(\n"
392 " function success() {\n"
393 " doFoo();\n"
394 " doBar();\n"
395 " },\n"
396 " function error() {\n"
397 " doFoo();\n"
398 " doBaz();\n"
399 " },\n"
400 " []);\n");
401 verifyFormat("promise.then(\n"
402 " function success() {\n"
403 " doFoo();\n"
404 " doBar();\n"
405 " },\n"
406 " [],\n"
407 " function error() {\n"
408 " doFoo();\n"
409 " doBaz();\n"
410 " });\n");
411 // FIXME: Here, we should probably break right after the "(" for consistency.
412 verifyFormat("promise.then([],\n"
413 " function success() {\n"
414 " doFoo();\n"
415 " doBar();\n"
416 " },\n"
417 " function error() {\n"
418 " doFoo();\n"
419 " doBaz();\n"
420 " });\n");
Daniel Jasper1779d432014-09-29 07:54:54 +0000421
422 verifyFormat("getSomeLongPromise()\n"
423 " .then(function(value) { body(); })\n"
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000424 " .thenCatch(function(error) {\n"
425 " body();\n"
426 " body();\n"
427 " });");
Daniel Jasper1779d432014-09-29 07:54:54 +0000428 verifyFormat("getSomeLongPromise()\n"
429 " .then(function(value) {\n"
430 " body();\n"
431 " body();\n"
432 " })\n"
433 " .thenCatch(function(error) {\n"
434 " body();\n"
435 " body();\n"
436 " });");
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000437
Daniel Jasperacf67e32015-04-07 08:20:35 +0000438 verifyFormat("getSomeLongPromise()\n"
439 " .then(function(value) { body(); })\n"
440 " .thenCatch(function(error) { body(); });");
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000441}
442
Manuel Klimek79e06082015-05-21 12:23:34 +0000443TEST_F(FormatTestJS, ArrowFunctions) {
444 verifyFormat("var x = (a) => {\n"
445 " return a;\n"
446 "};");
447 verifyFormat("var x = (a) => {\n"
448 " function y() { return 42; }\n"
449 " return a;\n"
450 "};");
451 verifyFormat("var x = (a: type): {some: type} => {\n"
452 " return a;\n"
453 "};");
454 verifyFormat("var x = (a) => a;");
455 verifyFormat("var x = (a) => a;");
456}
457
Daniel Jasper166c19b2014-05-06 14:12:21 +0000458TEST_F(FormatTestJS, ReturnStatements) {
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000459 verifyFormat("function() {\n"
460 " return [hello, world];\n"
461 "}");
Daniel Jasper166c19b2014-05-06 14:12:21 +0000462}
463
Manuel Klimek79e06082015-05-21 12:23:34 +0000464TEST_F(FormatTestJS, ClosureStyleCasts) {
Daniel Jasper484033b2014-05-06 14:41:29 +0000465 verifyFormat("var x = /** @type {foo} */ (bar);");
466}
467
Daniel Jasper04a71a42014-05-08 11:58:24 +0000468TEST_F(FormatTestJS, TryCatch) {
469 verifyFormat("try {\n"
470 " f();\n"
471 "} catch (e) {\n"
472 " g();\n"
473 "} finally {\n"
474 " h();\n"
475 "}");
Daniel Jasper8f2e94c2014-09-04 15:03:34 +0000476
477 // But, of course, "catch" is a perfectly fine function name in JavaScript.
478 verifyFormat("someObject.catch();");
Daniel Jasper79121232014-11-27 14:55:17 +0000479 verifyFormat("someObject.new();");
480 verifyFormat("someObject.delete();");
Daniel Jasper04a71a42014-05-08 11:58:24 +0000481}
482
Daniel Jasper49802ef2014-05-22 09:10:04 +0000483TEST_F(FormatTestJS, StringLiteralConcatenation) {
484 verifyFormat("var literal = 'hello ' +\n"
485 " 'world';");
486}
487
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000488TEST_F(FormatTestJS, RegexLiteralClassification) {
489 // Regex literals.
490 verifyFormat("var regex = /abc/;");
491 verifyFormat("f(/abc/);");
492 verifyFormat("f(abc, /abc/);");
493 verifyFormat("some_map[/abc/];");
494 verifyFormat("var x = a ? /abc/ : /abc/;");
495 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}");
496 verifyFormat("var x = !/abc/.test(y);");
497 verifyFormat("var x = a && /abc/.test(y);");
498 verifyFormat("var x = a || /abc/.test(y);");
499 verifyFormat("var x = a + /abc/.search(y);");
Daniel Jasperf7405c12014-05-08 07:45:18 +0000500 verifyFormat("var regexs = {/abc/, /abc/};");
501 verifyFormat("return /abc/;");
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000502
503 // Not regex literals.
504 verifyFormat("var a = a / 2 + b / 3;");
505}
506
507TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) {
Daniel Jasper69694b02015-05-08 07:55:13 +0000508 verifyFormat("var regex = /=/;");
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000509 verifyFormat("var regex = /a*/;");
510 verifyFormat("var regex = /a+/;");
511 verifyFormat("var regex = /a?/;");
512 verifyFormat("var regex = /.a./;");
513 verifyFormat("var regex = /a\\*/;");
514 verifyFormat("var regex = /^a$/;");
515 verifyFormat("var regex = /\\/a/;");
516 verifyFormat("var regex = /(?:x)/;");
517 verifyFormat("var regex = /x(?=y)/;");
518 verifyFormat("var regex = /x(?!y)/;");
519 verifyFormat("var regex = /x|y/;");
520 verifyFormat("var regex = /a{2}/;");
521 verifyFormat("var regex = /a{1,3}/;");
522 verifyFormat("var regex = /[abc]/;");
523 verifyFormat("var regex = /[^abc]/;");
524 verifyFormat("var regex = /[\\b]/;");
525 verifyFormat("var regex = /\\b/;");
526 verifyFormat("var regex = /\\B/;");
527 verifyFormat("var regex = /\\d/;");
528 verifyFormat("var regex = /\\D/;");
529 verifyFormat("var regex = /\\f/;");
530 verifyFormat("var regex = /\\n/;");
531 verifyFormat("var regex = /\\r/;");
532 verifyFormat("var regex = /\\s/;");
533 verifyFormat("var regex = /\\S/;");
534 verifyFormat("var regex = /\\t/;");
535 verifyFormat("var regex = /\\v/;");
536 verifyFormat("var regex = /\\w/;");
537 verifyFormat("var regex = /\\W/;");
538 verifyFormat("var regex = /a(a)\\1/;");
539 verifyFormat("var regex = /\\0/;");
Daniel Jasperfb4333b2014-05-12 11:29:50 +0000540 verifyFormat("var regex = /\\\\/g;");
541 verifyFormat("var regex = /\\a\\\\/g;");
542 verifyFormat("var regex = /\a\\//g;");
Daniel Jasper23376252014-09-09 14:37:39 +0000543 verifyFormat("var regex = /a\\//;\n"
544 "var x = 0;");
Daniel Jasper49a9a282014-10-29 16:51:38 +0000545 EXPECT_EQ("var regex = /\\/*/;\n"
546 "var x = 0;",
547 format("var regex = /\\/*/;\n"
548 "var x=0;"));
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000549}
550
551TEST_F(FormatTestJS, RegexLiteralModifiers) {
552 verifyFormat("var regex = /abc/g;");
553 verifyFormat("var regex = /abc/i;");
554 verifyFormat("var regex = /abc/m;");
555 verifyFormat("var regex = /abc/y;");
556}
557
558TEST_F(FormatTestJS, RegexLiteralLength) {
559 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
560 getGoogleJSStyleWithColumns(60));
561 verifyFormat("var regex =\n"
562 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
563 getGoogleJSStyleWithColumns(60));
Daniel Jasper0580ff02014-12-17 09:11:08 +0000564 verifyFormat("var regex = /\\xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
565 getGoogleJSStyleWithColumns(50));
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000566}
567
568TEST_F(FormatTestJS, RegexLiteralExamples) {
569 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);");
570}
571
Daniel Jasperb10bdff2015-02-18 17:09:53 +0000572TEST_F(FormatTestJS, TypeAnnotations) {
573 verifyFormat("var x: string;");
574 verifyFormat("function x(): string {\n return 'x';\n}");
Manuel Klimek79e06082015-05-21 12:23:34 +0000575 verifyFormat("function x(): {x: string} {\n return {x: 'x'};\n}");
Daniel Jasperb10bdff2015-02-18 17:09:53 +0000576 verifyFormat("function x(y: string): string {\n return 'x';\n}");
577 verifyFormat("for (var y: string in x) {\n x();\n}");
578 verifyFormat("((a: string, b: number): string => a + b);");
579 verifyFormat("var x: (y: number) => string;");
580 verifyFormat("var x: P<string, (a: number) => string>;");
Manuel Klimek79e06082015-05-21 12:23:34 +0000581 verifyFormat("var x = {y: function(): z { return 1; }};");
582 verifyFormat("var x = {y: function(): {a: number} { return 1; }};");
Daniel Jasperb10bdff2015-02-18 17:09:53 +0000583}
584
Daniel Jasper83709082015-02-18 17:14:05 +0000585TEST_F(FormatTestJS, ClassDeclarations) {
586 verifyFormat("class C {\n x: string = 12;\n}");
587 verifyFormat("class C {\n x(): string => 12;\n}");
588 verifyFormat("class C {\n ['x' + 2]: string = 12;\n}");
589 verifyFormat("class C {\n private x: string = 12;\n}");
590 verifyFormat("class C {\n private static x: string = 12;\n}");
591 verifyFormat("class C {\n static x(): string { return 'asd'; }\n}");
592 verifyFormat("class C extends P implements I {}");
Daniel Jasper6a5d38d2015-04-13 14:56:54 +0000593 verifyFormat("class C extends p.P implements i.I {}");
Daniel Jasper83709082015-02-18 17:14:05 +0000594}
595
Daniel Jasper29647492015-05-05 08:12:50 +0000596TEST_F(FormatTestJS, InterfaceDeclarations) {
597 verifyFormat("interface I {\n"
598 " x: string;\n"
599 "}");
600}
601
Daniel Jasper3c42dba2015-02-18 17:17:15 +0000602TEST_F(FormatTestJS, MetadataAnnotations) {
603 verifyFormat("@A\nclass C {\n}");
604 verifyFormat("@A({arg: 'value'})\nclass C {\n}");
605 verifyFormat("@A\n@B\nclass C {\n}");
606 verifyFormat("class C {\n @A x: string;\n}");
607 verifyFormat("class C {\n"
608 " @A\n"
609 " private x(): string {\n"
610 " return 'y';\n"
611 " }\n"
612 "}");
Daniel Jasper6fa9ec72015-02-19 16:03:16 +0000613 verifyFormat("class X {}\n"
614 "class Y {}");
Daniel Jasper3c42dba2015-02-18 17:17:15 +0000615}
616
Daniel Jasper354aa512015-02-19 16:07:32 +0000617TEST_F(FormatTestJS, Modules) {
618 verifyFormat("import SomeThing from 'some/module.js';");
619 verifyFormat("import {X, Y} from 'some/module.js';");
620 verifyFormat("import {\n"
621 " VeryLongImportsAreAnnoying,\n"
622 " VeryLongImportsAreAnnoying,\n"
623 " VeryLongImportsAreAnnoying,\n"
624 " VeryLongImportsAreAnnoying\n"
625 "} from 'some/module.js';");
626 verifyFormat("import {\n"
627 " X,\n"
628 " Y,\n"
629 "} from 'some/module.js';");
630 verifyFormat("import {\n"
631 " X,\n"
632 " Y,\n"
633 "} from 'some/long/module.js';",
634 getGoogleJSStyleWithColumns(20));
635 verifyFormat("import {X as myLocalX, Y as myLocalY} from 'some/module.js';");
636 verifyFormat("import * as lib from 'some/module.js';");
Daniel Jasper60948b12015-03-15 13:55:54 +0000637 verifyFormat("var x = {import: 1};\nx.import = 2;");
Daniel Jasperfca735c2015-02-19 16:14:18 +0000638
639 verifyFormat("export function fn() {\n"
640 " return 'fn';\n"
641 "}");
Daniel Jasper668c7bb2015-05-11 09:03:10 +0000642 verifyFormat("export function A() {\n"
643 "}\n"
644 "export default function B() {\n"
645 "}\n"
646 "export function C() {\n"
647 "}");
Daniel Jasper354aa512015-02-19 16:07:32 +0000648 verifyFormat("export const x = 12;");
649 verifyFormat("export default class X {}");
Daniel Jasperfca735c2015-02-19 16:14:18 +0000650 verifyFormat("export {X, Y} from 'some/module.js';");
651 verifyFormat("export {\n"
652 " X,\n"
653 " Y,\n"
654 "} from 'some/module.js';");
655 verifyFormat("export class C {\n"
656 " x: number;\n"
657 " y: string;\n"
658 "}");
659 verifyFormat("export class X { y: number; }");
660 verifyFormat("export default class X { y: number }");
661 verifyFormat("export default function() {\n return 1;\n}");
662 verifyFormat("export var x = 12;");
663 verifyFormat("export var x: number = 12;");
664 verifyFormat("export const y = {\n"
665 " a: 1,\n"
666 " b: 2\n"
667 "};");
Daniel Jasper354aa512015-02-19 16:07:32 +0000668}
669
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000670TEST_F(FormatTestJS, TemplateStrings) {
671 // Keeps any whitespace/indentation within the template string.
672 EXPECT_EQ("var x = `hello\n"
673 " ${ name }\n"
674 " !`;",
675 format("var x = `hello\n"
676 " ${ name }\n"
677 " !`;"));
678
679 // FIXME: +1 / -1 offsets are to work around clang-format miscalculating
680 // widths for unknown tokens that are not whitespace (e.g. '`'). Remove when
681 // the code is corrected.
682
683 verifyFormat("var x =\n"
684 " `hello ${world}` >= some();",
685 getGoogleJSStyleWithColumns(34)); // Barely doesn't fit.
686 verifyFormat("var x = `hello ${world}` >= some();",
687 getGoogleJSStyleWithColumns(35 + 1)); // Barely fits.
688 EXPECT_EQ("var x = `hello\n"
689 " ${world}` >=\n"
690 " some();",
691 format("var x =\n"
692 " `hello\n"
693 " ${world}` >= some();",
694 getGoogleJSStyleWithColumns(21))); // Barely doesn't fit.
695 EXPECT_EQ("var x = `hello\n"
696 " ${world}` >= some();",
697 format("var x =\n"
698 " `hello\n"
699 " ${world}` >= some();",
700 getGoogleJSStyleWithColumns(22))); // Barely fits.
701
702 verifyFormat("var x =\n `h`;", getGoogleJSStyleWithColumns(13 - 1));
703 EXPECT_EQ(
704 "var x =\n `multi\n line`;",
705 format("var x = `multi\n line`;", getGoogleJSStyleWithColumns(14 - 1)));
706
Daniel Jasperf69b9222015-05-02 08:05:38 +0000707 // Make sure template strings get a proper ColumnWidth assigned, even if they
708 // are first token in line.
709 verifyFormat(
710 "var a = aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
711 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`;");
712
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000713 // Two template strings.
714 verifyFormat("var x = `hello` == `hello`;");
Daniel Jasper0d6ac272015-04-16 08:20:51 +0000715
716 // Comments in template strings.
717 EXPECT_EQ("var x = `//a`;\n"
718 "var y;",
719 format("var x =\n `//a`;\n"
720 "var y ;"));
721 EXPECT_EQ("var x = `/*a`;\n"
722 "var y;",
723 format("var x =\n `/*a`;\n"
724 "var y;"));
725 // Backticks in a comment - not a template string.
726 EXPECT_EQ("var x = 1 // `/*a`;\n"
727 " ;",
728 format("var x =\n 1 // `/*a`;\n"
729 " ;"));
730 EXPECT_EQ("/* ` */ var x = 1; /* ` */",
731 format("/* ` */ var x\n= 1; /* ` */"));
732 // Comment spans multiple template strings.
733 EXPECT_EQ("var x = `/*a`;\n"
734 "var y = ` */ `;",
735 format("var x =\n `/*a`;\n"
736 "var y =\n ` */ `;"));
737 // Escaped backtick.
738 EXPECT_EQ("var x = ` \\` a`;\n"
739 "var y;",
740 format("var x = ` \\` a`;\n"
741 "var y;"));
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000742}
743
Daniel Jasperbc46b932015-03-15 13:59:51 +0000744TEST_F(FormatTestJS, CastSyntax) {
745 verifyFormat("var x = <type>foo;");
746}
747
748TEST_F(FormatTestJS, TypeArguments) {
749 verifyFormat("class X<Y> {}");
750 verifyFormat("new X<Y>();");
751 verifyFormat("foo<Y>(a);");
752 verifyFormat("var x: X<Y>[];");
753 verifyFormat("class C extends D<E> implements F<G>, H<I> {}");
Daniel Jasperd2219062015-05-02 07:54:58 +0000754 verifyFormat("function f(a: List<any> = null) {\n}");
755 verifyFormat("function f(): List<any> {\n}");
Daniel Jasperbc46b932015-03-15 13:59:51 +0000756}
757
Daniel Jaspera74f5072015-04-13 15:01:40 +0000758TEST_F(FormatTestJS, OptionalTypes) {
759 verifyFormat("function x(a?: b, c?, d?) {\n}");
760 verifyFormat("class X {\n"
761 " y?: z;\n"
762 " z?;\n"
763 "}");
Daniel Jasper9326f912015-05-05 08:40:32 +0000764 verifyFormat("interface X {\n"
765 " y?(): z;\n"
766 "}");
767 verifyFormat("x ? 1 : 2;");
Daniel Jasper3e0dcc22015-05-27 05:37:40 +0000768 verifyFormat("constructor({aa}: {\n"
769 " aa?: string,\n"
770 " aaaaaaaa?: string,\n"
771 " aaaaaaaaaaaaaaa?: boolean,\n"
772 " aaaaaa?: List<string>\n"
773 "}) {\n"
774 "}");
Daniel Jaspera74f5072015-04-13 15:01:40 +0000775}
776
Daniel Jasperd9309772015-04-13 15:03:30 +0000777TEST_F(FormatTestJS, IndexSignature) {
778 verifyFormat("var x: {[k: string]: v};");
779}
780
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000781} // end namespace tooling
782} // end namespace clang