blob: a06daac24ecf9f269e9de0a164f36475bcd5e493 [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 Jasper17062ff2014-06-10 14:44:02 +0000154}
155
Daniel Jasperf46dec82015-03-31 14:34:15 +0000156TEST_F(FormatTestJS, MethodsInObjectLiterals) {
157 verifyFormat("var o = {\n"
158 " value: 'test',\n"
159 " get value() { // getter\n"
160 " return this.value;\n"
161 " }\n"
162 "};");
163 verifyFormat("var o = {\n"
164 " value: 'test',\n"
165 " set value(val) { // setter\n"
166 " this.value = val;\n"
167 " }\n"
168 "};");
169 verifyFormat("var o = {\n"
170 " value: 'test',\n"
171 " someMethod(val) { // method\n"
172 " doSomething(this.value + val);\n"
173 " }\n"
174 "};");
Daniel Jasper739ec532015-04-04 07:56:55 +0000175 verifyFormat("var o = {\n"
176 " someMethod(val) { // method\n"
177 " doSomething(this.value + val);\n"
178 " },\n"
179 " someOtherMethod(val) { // method\n"
180 " doSomething(this.value + val);\n"
181 " }\n"
182 "};");
Daniel Jasperf46dec82015-03-31 14:34:15 +0000183}
184
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000185TEST_F(FormatTestJS, SpacesInContainerLiterals) {
186 verifyFormat("var arr = [1, 2, 3];");
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000187 verifyFormat("f({a: 1, b: 2, c: 3});");
Nico Weber514ecc82014-02-02 20:50:45 +0000188
Daniel Jasper2a958322014-05-21 13:26:58 +0000189 verifyFormat("var object_literal_with_long_name = {\n"
190 " a: 'aaaaaaaaaaaaaaaaaa',\n"
191 " b: 'bbbbbbbbbbbbbbbbbb'\n"
192 "};");
193
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000194 verifyFormat("f({a: 1, b: 2, c: 3});",
Nico Weber514ecc82014-02-02 20:50:45 +0000195 getChromiumStyle(FormatStyle::LK_JavaScript));
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000196 verifyFormat("f({'a': [{}]});");
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000197}
198
Daniel Jasper86fee2f2014-01-31 12:49:42 +0000199TEST_F(FormatTestJS, SingleQuoteStrings) {
200 verifyFormat("this.function('', true);");
201}
202
Daniel Jasper4a39c842014-05-06 13:54:10 +0000203TEST_F(FormatTestJS, GoogScopes) {
204 verifyFormat("goog.scope(function() {\n"
205 "var x = a.b;\n"
206 "var y = c.d;\n"
207 "}); // goog.scope");
Daniel Jasper02c7bca2015-03-30 09:56:50 +0000208 verifyFormat("goog.scope(function() {\n"
209 "// test\n"
210 "var x = 0;\n"
211 "// test\n"
212 "});");
Daniel Jasper4a39c842014-05-06 13:54:10 +0000213}
214
Daniel Jasper616de8642014-11-23 16:46:28 +0000215TEST_F(FormatTestJS, GoogModules) {
216 verifyFormat("goog.module('this.is.really.absurdly.long');",
217 getGoogleJSStyleWithColumns(40));
218 verifyFormat("goog.require('this.is.really.absurdly.long');",
219 getGoogleJSStyleWithColumns(40));
220 verifyFormat("goog.provide('this.is.really.absurdly.long');",
221 getGoogleJSStyleWithColumns(40));
222 verifyFormat("var long = goog.require('this.is.really.absurdly.long');",
223 getGoogleJSStyleWithColumns(40));
Daniel Jasper53c38f42014-11-27 14:46:03 +0000224
225 // These should be wrapped normally.
226 verifyFormat(
227 "var MyLongClassName =\n"
228 " goog.module.get('my.long.module.name.followedBy.MyLongClassName');");
Daniel Jasper616de8642014-11-23 16:46:28 +0000229}
230
Daniel Jasperad9eb0d2014-06-30 13:24:54 +0000231TEST_F(FormatTestJS, FormatsFreestandingFunctions) {
232 verifyFormat("function outer1(a, b) {\n"
233 " function inner1(a, b) { return a; }\n"
234 " inner1(a, b);\n"
235 "}\n"
236 "function outer2(a, b) {\n"
237 " function inner2(a, b) { return a; }\n"
238 " inner2(a, b);\n"
239 "}");
240}
241
Daniel Jasper5217a8b2014-06-13 07:02:04 +0000242TEST_F(FormatTestJS, FunctionLiterals) {
Daniel Jasper3f69ba12014-09-05 08:42:27 +0000243 verifyFormat("doFoo(function() {});");
Daniel Jasper79dffb42014-05-07 09:48:30 +0000244 verifyFormat("doFoo(function() { return 1; });");
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000245 verifyFormat("var func = function() {\n"
246 " return 1;\n"
247 "};");
Daniel Jasperc03e16a2014-05-08 09:25:39 +0000248 verifyFormat("return {\n"
249 " body: {\n"
250 " setAttribute: function(key, val) { this[key] = val; },\n"
251 " getAttribute: function(key) { return this[key]; },\n"
252 " style: {direction: ''}\n"
253 " }\n"
254 "};");
Daniel Jaspere551bb72014-11-05 17:22:31 +0000255 EXPECT_EQ("abc = xyz ?\n"
256 " function() {\n"
257 " return 1;\n"
258 " } :\n"
259 " function() {\n"
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000260 " return -1;\n"
261 " };",
Daniel Jasper069e5f42014-05-20 11:14:57 +0000262 format("abc=xyz?function(){return 1;}:function(){return -1;};"));
Daniel Jasperb16b9692014-05-21 12:51:23 +0000263
264 verifyFormat("var closure = goog.bind(\n"
265 " function() { // comment\n"
266 " foo();\n"
267 " bar();\n"
268 " },\n"
269 " this, arg1IsReallyLongAndNeeedsLineBreaks,\n"
270 " arg3IsReallyLongAndNeeedsLineBreaks);");
271 verifyFormat("var closure = goog.bind(function() { // comment\n"
272 " foo();\n"
273 " bar();\n"
274 "}, this);");
Daniel Jasper58cb2ed2014-06-06 13:49:04 +0000275 verifyFormat("return {\n"
276 " a: 'E',\n"
277 " b: function() {\n"
278 " return function() {\n"
279 " f(); //\n"
280 " };\n"
281 " }\n"
282 "};");
Daniel Jasper41368e92014-11-27 15:37:42 +0000283 verifyFormat("{\n"
284 " var someVariable = function(x) {\n"
285 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n"
286 " };\n"
287 "}");
Daniel Jasper7325aee2015-05-08 08:38:52 +0000288 verifyFormat("someLooooooooongFunction(\n"
289 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
290 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
291 " function(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
292 " // code\n"
293 " });");
Daniel Jasper5f3ea472014-05-22 08:36:53 +0000294
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000295 verifyFormat("f({a: function() { return 1; }});",
296 getGoogleJSStyleWithColumns(33));
297 verifyFormat("f({\n"
Daniel Jasper5f3ea472014-05-22 08:36:53 +0000298 " a: function() { return 1; }\n"
Daniel Jaspera4e55f42014-12-04 16:07:17 +0000299 "});",
300 getGoogleJSStyleWithColumns(32));
Daniel Jasper5217a8b2014-06-13 07:02:04 +0000301
302 verifyFormat("return {\n"
303 " a: function SomeFunction() {\n"
304 " // ...\n"
305 " return 1;\n"
306 " }\n"
307 "};");
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000308 verifyFormat("this.someObject.doSomething(aaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
309 " .then(goog.bind(function(aaaaaaaaaaa) {\n"
310 " someFunction();\n"
311 " someFunction();\n"
312 " }, this), aaaaaaaaaaaaaaaaa);");
313
314 // FIXME: This is not ideal yet.
315 verifyFormat("someFunction(goog.bind(\n"
316 " function() {\n"
317 " doSomething();\n"
318 " doSomething();\n"
319 " },\n"
320 " this),\n"
321 " goog.bind(function() {\n"
322 " doSomething();\n"
323 " doSomething();\n"
324 " }, this));");
Daniel Jasper79dffb42014-05-07 09:48:30 +0000325}
326
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000327TEST_F(FormatTestJS, InliningFunctionLiterals) {
328 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
329 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
330 verifyFormat("var func = function() {\n"
331 " return 1;\n"
332 "};",
333 Style);
334 verifyFormat("var func = doSomething(function() { return 1; });", Style);
335 verifyFormat("var outer = function() {\n"
336 " var inner = function() { return 1; }\n"
337 "};",
338 Style);
339 verifyFormat("function outer1(a, b) {\n"
340 " function inner1(a, b) { return a; }\n"
341 "}",
342 Style);
343
344 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
345 verifyFormat("var func = function() { return 1; };", Style);
346 verifyFormat("var func = doSomething(function() { return 1; });", Style);
347 verifyFormat(
348 "var outer = function() { var inner = function() { return 1; } };",
349 Style);
350 verifyFormat("function outer1(a, b) {\n"
351 " function inner1(a, b) { return a; }\n"
352 "}",
353 Style);
354
355 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
356 verifyFormat("var func = function() {\n"
357 " return 1;\n"
358 "};",
359 Style);
360 verifyFormat("var func = doSomething(function() {\n"
361 " return 1;\n"
362 "});",
363 Style);
364 verifyFormat("var outer = function() {\n"
365 " var inner = function() {\n"
366 " return 1;\n"
367 " }\n"
368 "};",
369 Style);
370 verifyFormat("function outer1(a, b) {\n"
371 " function inner1(a, b) {\n"
372 " return a;\n"
373 " }\n"
374 "}",
375 Style);
376}
377
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000378TEST_F(FormatTestJS, MultipleFunctionLiterals) {
379 verifyFormat("promise.then(\n"
380 " function success() {\n"
381 " doFoo();\n"
382 " doBar();\n"
383 " },\n"
384 " function error() {\n"
385 " doFoo();\n"
386 " doBaz();\n"
387 " },\n"
388 " []);\n");
389 verifyFormat("promise.then(\n"
390 " function success() {\n"
391 " doFoo();\n"
392 " doBar();\n"
393 " },\n"
394 " [],\n"
395 " function error() {\n"
396 " doFoo();\n"
397 " doBaz();\n"
398 " });\n");
399 // FIXME: Here, we should probably break right after the "(" for consistency.
400 verifyFormat("promise.then([],\n"
401 " function success() {\n"
402 " doFoo();\n"
403 " doBar();\n"
404 " },\n"
405 " function error() {\n"
406 " doFoo();\n"
407 " doBaz();\n"
408 " });\n");
Daniel Jasper1779d432014-09-29 07:54:54 +0000409
410 verifyFormat("getSomeLongPromise()\n"
411 " .then(function(value) { body(); })\n"
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000412 " .thenCatch(function(error) {\n"
413 " body();\n"
414 " body();\n"
415 " });");
Daniel Jasper1779d432014-09-29 07:54:54 +0000416 verifyFormat("getSomeLongPromise()\n"
417 " .then(function(value) {\n"
418 " body();\n"
419 " body();\n"
420 " })\n"
421 " .thenCatch(function(error) {\n"
422 " body();\n"
423 " body();\n"
424 " });");
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000425
Daniel Jasperacf67e32015-04-07 08:20:35 +0000426 verifyFormat("getSomeLongPromise()\n"
427 " .then(function(value) { body(); })\n"
428 " .thenCatch(function(error) { body(); });");
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000429}
430
Manuel Klimek79e06082015-05-21 12:23:34 +0000431TEST_F(FormatTestJS, ArrowFunctions) {
432 verifyFormat("var x = (a) => {\n"
433 " return a;\n"
434 "};");
435 verifyFormat("var x = (a) => {\n"
436 " function y() { return 42; }\n"
437 " return a;\n"
438 "};");
439 verifyFormat("var x = (a: type): {some: type} => {\n"
440 " return a;\n"
441 "};");
442 verifyFormat("var x = (a) => a;");
443 verifyFormat("var x = (a) => a;");
444}
445
Daniel Jasper166c19b2014-05-06 14:12:21 +0000446TEST_F(FormatTestJS, ReturnStatements) {
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000447 verifyFormat("function() {\n"
448 " return [hello, world];\n"
449 "}");
Daniel Jasper166c19b2014-05-06 14:12:21 +0000450}
451
Manuel Klimek79e06082015-05-21 12:23:34 +0000452TEST_F(FormatTestJS, ClosureStyleCasts) {
Daniel Jasper484033b2014-05-06 14:41:29 +0000453 verifyFormat("var x = /** @type {foo} */ (bar);");
454}
455
Daniel Jasper04a71a42014-05-08 11:58:24 +0000456TEST_F(FormatTestJS, TryCatch) {
457 verifyFormat("try {\n"
458 " f();\n"
459 "} catch (e) {\n"
460 " g();\n"
461 "} finally {\n"
462 " h();\n"
463 "}");
Daniel Jasper8f2e94c2014-09-04 15:03:34 +0000464
465 // But, of course, "catch" is a perfectly fine function name in JavaScript.
466 verifyFormat("someObject.catch();");
Daniel Jasper79121232014-11-27 14:55:17 +0000467 verifyFormat("someObject.new();");
468 verifyFormat("someObject.delete();");
Daniel Jasper04a71a42014-05-08 11:58:24 +0000469}
470
Daniel Jasper49802ef2014-05-22 09:10:04 +0000471TEST_F(FormatTestJS, StringLiteralConcatenation) {
472 verifyFormat("var literal = 'hello ' +\n"
473 " 'world';");
474}
475
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000476TEST_F(FormatTestJS, RegexLiteralClassification) {
477 // Regex literals.
478 verifyFormat("var regex = /abc/;");
479 verifyFormat("f(/abc/);");
480 verifyFormat("f(abc, /abc/);");
481 verifyFormat("some_map[/abc/];");
482 verifyFormat("var x = a ? /abc/ : /abc/;");
483 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}");
484 verifyFormat("var x = !/abc/.test(y);");
485 verifyFormat("var x = a && /abc/.test(y);");
486 verifyFormat("var x = a || /abc/.test(y);");
487 verifyFormat("var x = a + /abc/.search(y);");
Daniel Jasperf7405c12014-05-08 07:45:18 +0000488 verifyFormat("var regexs = {/abc/, /abc/};");
489 verifyFormat("return /abc/;");
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000490
491 // Not regex literals.
492 verifyFormat("var a = a / 2 + b / 3;");
493}
494
495TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) {
Daniel Jasper69694b02015-05-08 07:55:13 +0000496 verifyFormat("var regex = /=/;");
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000497 verifyFormat("var regex = /a*/;");
498 verifyFormat("var regex = /a+/;");
499 verifyFormat("var regex = /a?/;");
500 verifyFormat("var regex = /.a./;");
501 verifyFormat("var regex = /a\\*/;");
502 verifyFormat("var regex = /^a$/;");
503 verifyFormat("var regex = /\\/a/;");
504 verifyFormat("var regex = /(?:x)/;");
505 verifyFormat("var regex = /x(?=y)/;");
506 verifyFormat("var regex = /x(?!y)/;");
507 verifyFormat("var regex = /x|y/;");
508 verifyFormat("var regex = /a{2}/;");
509 verifyFormat("var regex = /a{1,3}/;");
510 verifyFormat("var regex = /[abc]/;");
511 verifyFormat("var regex = /[^abc]/;");
512 verifyFormat("var regex = /[\\b]/;");
513 verifyFormat("var regex = /\\b/;");
514 verifyFormat("var regex = /\\B/;");
515 verifyFormat("var regex = /\\d/;");
516 verifyFormat("var regex = /\\D/;");
517 verifyFormat("var regex = /\\f/;");
518 verifyFormat("var regex = /\\n/;");
519 verifyFormat("var regex = /\\r/;");
520 verifyFormat("var regex = /\\s/;");
521 verifyFormat("var regex = /\\S/;");
522 verifyFormat("var regex = /\\t/;");
523 verifyFormat("var regex = /\\v/;");
524 verifyFormat("var regex = /\\w/;");
525 verifyFormat("var regex = /\\W/;");
526 verifyFormat("var regex = /a(a)\\1/;");
527 verifyFormat("var regex = /\\0/;");
Daniel Jasperfb4333b2014-05-12 11:29:50 +0000528 verifyFormat("var regex = /\\\\/g;");
529 verifyFormat("var regex = /\\a\\\\/g;");
530 verifyFormat("var regex = /\a\\//g;");
Daniel Jasper23376252014-09-09 14:37:39 +0000531 verifyFormat("var regex = /a\\//;\n"
532 "var x = 0;");
Daniel Jasper49a9a282014-10-29 16:51:38 +0000533 EXPECT_EQ("var regex = /\\/*/;\n"
534 "var x = 0;",
535 format("var regex = /\\/*/;\n"
536 "var x=0;"));
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000537}
538
539TEST_F(FormatTestJS, RegexLiteralModifiers) {
540 verifyFormat("var regex = /abc/g;");
541 verifyFormat("var regex = /abc/i;");
542 verifyFormat("var regex = /abc/m;");
543 verifyFormat("var regex = /abc/y;");
544}
545
546TEST_F(FormatTestJS, RegexLiteralLength) {
547 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
548 getGoogleJSStyleWithColumns(60));
549 verifyFormat("var regex =\n"
550 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
551 getGoogleJSStyleWithColumns(60));
Daniel Jasper0580ff02014-12-17 09:11:08 +0000552 verifyFormat("var regex = /\\xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
553 getGoogleJSStyleWithColumns(50));
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000554}
555
556TEST_F(FormatTestJS, RegexLiteralExamples) {
557 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);");
558}
559
Daniel Jasperb10bdff2015-02-18 17:09:53 +0000560TEST_F(FormatTestJS, TypeAnnotations) {
561 verifyFormat("var x: string;");
562 verifyFormat("function x(): string {\n return 'x';\n}");
Manuel Klimek79e06082015-05-21 12:23:34 +0000563 verifyFormat("function x(): {x: string} {\n return {x: 'x'};\n}");
Daniel Jasperb10bdff2015-02-18 17:09:53 +0000564 verifyFormat("function x(y: string): string {\n return 'x';\n}");
565 verifyFormat("for (var y: string in x) {\n x();\n}");
566 verifyFormat("((a: string, b: number): string => a + b);");
567 verifyFormat("var x: (y: number) => string;");
568 verifyFormat("var x: P<string, (a: number) => string>;");
Manuel Klimek79e06082015-05-21 12:23:34 +0000569 verifyFormat("var x = {y: function(): z { return 1; }};");
570 verifyFormat("var x = {y: function(): {a: number} { return 1; }};");
Daniel Jasperb10bdff2015-02-18 17:09:53 +0000571}
572
Daniel Jasper83709082015-02-18 17:14:05 +0000573TEST_F(FormatTestJS, ClassDeclarations) {
574 verifyFormat("class C {\n x: string = 12;\n}");
575 verifyFormat("class C {\n x(): string => 12;\n}");
576 verifyFormat("class C {\n ['x' + 2]: string = 12;\n}");
577 verifyFormat("class C {\n private x: string = 12;\n}");
578 verifyFormat("class C {\n private static x: string = 12;\n}");
579 verifyFormat("class C {\n static x(): string { return 'asd'; }\n}");
580 verifyFormat("class C extends P implements I {}");
Daniel Jasper6a5d38d2015-04-13 14:56:54 +0000581 verifyFormat("class C extends p.P implements i.I {}");
Daniel Jasper83709082015-02-18 17:14:05 +0000582}
583
Daniel Jasper29647492015-05-05 08:12:50 +0000584TEST_F(FormatTestJS, InterfaceDeclarations) {
585 verifyFormat("interface I {\n"
586 " x: string;\n"
587 "}");
588}
589
Daniel Jasper3c42dba2015-02-18 17:17:15 +0000590TEST_F(FormatTestJS, MetadataAnnotations) {
591 verifyFormat("@A\nclass C {\n}");
592 verifyFormat("@A({arg: 'value'})\nclass C {\n}");
593 verifyFormat("@A\n@B\nclass C {\n}");
594 verifyFormat("class C {\n @A x: string;\n}");
595 verifyFormat("class C {\n"
596 " @A\n"
597 " private x(): string {\n"
598 " return 'y';\n"
599 " }\n"
600 "}");
Daniel Jasper6fa9ec72015-02-19 16:03:16 +0000601 verifyFormat("class X {}\n"
602 "class Y {}");
Daniel Jasper3c42dba2015-02-18 17:17:15 +0000603}
604
Daniel Jasper354aa512015-02-19 16:07:32 +0000605TEST_F(FormatTestJS, Modules) {
606 verifyFormat("import SomeThing from 'some/module.js';");
607 verifyFormat("import {X, Y} from 'some/module.js';");
608 verifyFormat("import {\n"
609 " VeryLongImportsAreAnnoying,\n"
610 " VeryLongImportsAreAnnoying,\n"
611 " VeryLongImportsAreAnnoying,\n"
612 " VeryLongImportsAreAnnoying\n"
613 "} from 'some/module.js';");
614 verifyFormat("import {\n"
615 " X,\n"
616 " Y,\n"
617 "} from 'some/module.js';");
618 verifyFormat("import {\n"
619 " X,\n"
620 " Y,\n"
621 "} from 'some/long/module.js';",
622 getGoogleJSStyleWithColumns(20));
623 verifyFormat("import {X as myLocalX, Y as myLocalY} from 'some/module.js';");
624 verifyFormat("import * as lib from 'some/module.js';");
Daniel Jasper60948b12015-03-15 13:55:54 +0000625 verifyFormat("var x = {import: 1};\nx.import = 2;");
Daniel Jasperfca735c2015-02-19 16:14:18 +0000626
627 verifyFormat("export function fn() {\n"
628 " return 'fn';\n"
629 "}");
Daniel Jasper668c7bb2015-05-11 09:03:10 +0000630 verifyFormat("export function A() {\n"
631 "}\n"
632 "export default function B() {\n"
633 "}\n"
634 "export function C() {\n"
635 "}");
Daniel Jasper354aa512015-02-19 16:07:32 +0000636 verifyFormat("export const x = 12;");
637 verifyFormat("export default class X {}");
Daniel Jasperfca735c2015-02-19 16:14:18 +0000638 verifyFormat("export {X, Y} from 'some/module.js';");
639 verifyFormat("export {\n"
640 " X,\n"
641 " Y,\n"
642 "} from 'some/module.js';");
643 verifyFormat("export class C {\n"
644 " x: number;\n"
645 " y: string;\n"
646 "}");
647 verifyFormat("export class X { y: number; }");
648 verifyFormat("export default class X { y: number }");
649 verifyFormat("export default function() {\n return 1;\n}");
650 verifyFormat("export var x = 12;");
651 verifyFormat("export var x: number = 12;");
652 verifyFormat("export const y = {\n"
653 " a: 1,\n"
654 " b: 2\n"
655 "};");
Daniel Jasper354aa512015-02-19 16:07:32 +0000656}
657
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000658TEST_F(FormatTestJS, TemplateStrings) {
659 // Keeps any whitespace/indentation within the template string.
660 EXPECT_EQ("var x = `hello\n"
661 " ${ name }\n"
662 " !`;",
663 format("var x = `hello\n"
664 " ${ name }\n"
665 " !`;"));
666
667 // FIXME: +1 / -1 offsets are to work around clang-format miscalculating
668 // widths for unknown tokens that are not whitespace (e.g. '`'). Remove when
669 // the code is corrected.
670
671 verifyFormat("var x =\n"
672 " `hello ${world}` >= some();",
673 getGoogleJSStyleWithColumns(34)); // Barely doesn't fit.
674 verifyFormat("var x = `hello ${world}` >= some();",
675 getGoogleJSStyleWithColumns(35 + 1)); // Barely fits.
676 EXPECT_EQ("var x = `hello\n"
677 " ${world}` >=\n"
678 " some();",
679 format("var x =\n"
680 " `hello\n"
681 " ${world}` >= some();",
682 getGoogleJSStyleWithColumns(21))); // Barely doesn't fit.
683 EXPECT_EQ("var x = `hello\n"
684 " ${world}` >= some();",
685 format("var x =\n"
686 " `hello\n"
687 " ${world}` >= some();",
688 getGoogleJSStyleWithColumns(22))); // Barely fits.
689
690 verifyFormat("var x =\n `h`;", getGoogleJSStyleWithColumns(13 - 1));
691 EXPECT_EQ(
692 "var x =\n `multi\n line`;",
693 format("var x = `multi\n line`;", getGoogleJSStyleWithColumns(14 - 1)));
694
Daniel Jasperf69b9222015-05-02 08:05:38 +0000695 // Make sure template strings get a proper ColumnWidth assigned, even if they
696 // are first token in line.
697 verifyFormat(
698 "var a = aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
699 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`;");
700
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000701 // Two template strings.
702 verifyFormat("var x = `hello` == `hello`;");
Daniel Jasper0d6ac272015-04-16 08:20:51 +0000703
704 // Comments in template strings.
705 EXPECT_EQ("var x = `//a`;\n"
706 "var y;",
707 format("var x =\n `//a`;\n"
708 "var y ;"));
709 EXPECT_EQ("var x = `/*a`;\n"
710 "var y;",
711 format("var x =\n `/*a`;\n"
712 "var y;"));
713 // Backticks in a comment - not a template string.
714 EXPECT_EQ("var x = 1 // `/*a`;\n"
715 " ;",
716 format("var x =\n 1 // `/*a`;\n"
717 " ;"));
718 EXPECT_EQ("/* ` */ var x = 1; /* ` */",
719 format("/* ` */ var x\n= 1; /* ` */"));
720 // Comment spans multiple template strings.
721 EXPECT_EQ("var x = `/*a`;\n"
722 "var y = ` */ `;",
723 format("var x =\n `/*a`;\n"
724 "var y =\n ` */ `;"));
725 // Escaped backtick.
726 EXPECT_EQ("var x = ` \\` a`;\n"
727 "var y;",
728 format("var x = ` \\` a`;\n"
729 "var y;"));
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000730}
731
Daniel Jasperbc46b932015-03-15 13:59:51 +0000732TEST_F(FormatTestJS, CastSyntax) {
733 verifyFormat("var x = <type>foo;");
734}
735
736TEST_F(FormatTestJS, TypeArguments) {
737 verifyFormat("class X<Y> {}");
738 verifyFormat("new X<Y>();");
739 verifyFormat("foo<Y>(a);");
740 verifyFormat("var x: X<Y>[];");
741 verifyFormat("class C extends D<E> implements F<G>, H<I> {}");
Daniel Jasperd2219062015-05-02 07:54:58 +0000742 verifyFormat("function f(a: List<any> = null) {\n}");
743 verifyFormat("function f(): List<any> {\n}");
Daniel Jasperbc46b932015-03-15 13:59:51 +0000744}
745
Daniel Jaspera74f5072015-04-13 15:01:40 +0000746TEST_F(FormatTestJS, OptionalTypes) {
747 verifyFormat("function x(a?: b, c?, d?) {\n}");
748 verifyFormat("class X {\n"
749 " y?: z;\n"
750 " z?;\n"
751 "}");
Daniel Jasper9326f912015-05-05 08:40:32 +0000752 verifyFormat("interface X {\n"
753 " y?(): z;\n"
754 "}");
755 verifyFormat("x ? 1 : 2;");
Daniel Jasper3e0dcc22015-05-27 05:37:40 +0000756 verifyFormat("constructor({aa}: {\n"
757 " aa?: string,\n"
758 " aaaaaaaa?: string,\n"
759 " aaaaaaaaaaaaaaa?: boolean,\n"
760 " aaaaaa?: List<string>\n"
761 "}) {\n"
762 "}");
Daniel Jaspera74f5072015-04-13 15:01:40 +0000763}
764
Daniel Jasperd9309772015-04-13 15:03:30 +0000765TEST_F(FormatTestJS, IndexSignature) {
766 verifyFormat("var x: {[k: string]: v};");
767}
768
Alexander Kornienkoa48a12c2013-12-03 10:50:16 +0000769} // end namespace tooling
770} // end namespace clang