1 //===- 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 10 #include "FormatTestUtils.h" 11 #include "clang/Format/Format.h" 12 #include "llvm/Support/Debug.h" 13 #include "gtest/gtest.h" 14 15 #define DEBUG_TYPE "format-test" 16 17 namespace clang { 18 namespace format { 19 20 class FormatTestJS : public ::testing::Test { 21 protected: 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 bool IncompleteFormat = false; 28 tooling::Replacements Replaces = 29 reformat(Style, Code, Ranges, "<stdin>", &IncompleteFormat); 30 EXPECT_FALSE(IncompleteFormat); 31 std::string Result = applyAllReplacements(Code, Replaces); 32 EXPECT_NE("", Result); 33 DEBUG(llvm::errs() << "\n" << Result << "\n\n"); 34 return Result; 35 } 36 37 static std::string format( 38 llvm::StringRef Code, 39 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) { 40 return format(Code, 0, Code.size(), Style); 41 } 42 43 static FormatStyle getGoogleJSStyleWithColumns(unsigned ColumnLimit) { 44 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 45 Style.ColumnLimit = ColumnLimit; 46 return Style; 47 } 48 49 static void verifyFormat( 50 llvm::StringRef Code, 51 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) { 52 std::string result = format(test::messUp(Code), Style); 53 EXPECT_EQ(Code.str(), result) << "Formatted:\n" << result; 54 } 55 }; 56 57 TEST_F(FormatTestJS, UnderstandsJavaScriptOperators) { 58 verifyFormat("a == = b;"); 59 verifyFormat("a != = b;"); 60 61 verifyFormat("a === b;"); 62 verifyFormat("aaaaaaa ===\n b;", getGoogleJSStyleWithColumns(10)); 63 verifyFormat("a !== b;"); 64 verifyFormat("aaaaaaa !==\n b;", getGoogleJSStyleWithColumns(10)); 65 verifyFormat("if (a + b + c +\n" 66 " d !==\n" 67 " e + f + g)\n" 68 " q();", 69 getGoogleJSStyleWithColumns(20)); 70 71 verifyFormat("a >> >= b;"); 72 73 verifyFormat("a >>> b;"); 74 verifyFormat("aaaaaaa >>>\n b;", getGoogleJSStyleWithColumns(10)); 75 verifyFormat("a >>>= b;"); 76 verifyFormat("aaaaaaa >>>=\n b;", getGoogleJSStyleWithColumns(10)); 77 verifyFormat("if (a + b + c +\n" 78 " d >>>\n" 79 " e + f + g)\n" 80 " q();", 81 getGoogleJSStyleWithColumns(20)); 82 verifyFormat("var x = aaaaaaaaaa ?\n" 83 " bbbbbb :\n" 84 " ccc;", 85 getGoogleJSStyleWithColumns(20)); 86 87 verifyFormat("var b = a.map((x) => x + 1);"); 88 verifyFormat("return ('aaa') in bbbb;"); 89 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n" 90 " aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 91 FormatStyle Style = getGoogleJSStyleWithColumns(80); 92 Style.AlignOperands = true; 93 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n" 94 " aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 95 Style); 96 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All; 97 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa()\n" 98 " in aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 99 Style); 100 101 // ES6 spread operator. 102 verifyFormat("someFunction(...a);"); 103 verifyFormat("var x = [1, ...a, 2];"); 104 } 105 106 TEST_F(FormatTestJS, UnderstandsAmpAmp) { 107 verifyFormat("e && e.SomeFunction();"); 108 } 109 110 TEST_F(FormatTestJS, LiteralOperatorsCanBeKeywords) { 111 verifyFormat("not.and.or.not_eq = 1;"); 112 } 113 114 TEST_F(FormatTestJS, ReservedWords) { 115 // JavaScript reserved words (aka keywords) are only illegal when used as 116 // Identifiers, but are legal as IdentifierNames. 117 verifyFormat("x.class.struct = 1;"); 118 verifyFormat("x.case = 1;"); 119 verifyFormat("x.interface = 1;"); 120 verifyFormat("x = {\n" 121 " a: 12,\n" 122 " interface: 1,\n" 123 " switch: 1,\n" 124 "};"); 125 verifyFormat("var struct = 2;"); 126 verifyFormat("var union = 2;"); 127 } 128 129 TEST_F(FormatTestJS, CppKeywords) { 130 // Make sure we don't mess stuff up because of C++ keywords. 131 verifyFormat("return operator && (aa);"); 132 } 133 134 TEST_F(FormatTestJS, ES6DestructuringAssignment) { 135 verifyFormat("var [a, b, c] = [1, 2, 3];"); 136 verifyFormat("let [a, b, c] = [1, 2, 3];"); 137 verifyFormat("var {a, b} = {a: 1, b: 2};"); 138 verifyFormat("let {a, b} = {a: 1, b: 2};"); 139 } 140 141 TEST_F(FormatTestJS, ContainerLiterals) { 142 verifyFormat("var x = {y: function(a) { return a; }};"); 143 verifyFormat("return {\n" 144 " link: function() {\n" 145 " f(); //\n" 146 " }\n" 147 "};"); 148 verifyFormat("return {\n" 149 " a: a,\n" 150 " link: function() {\n" 151 " f(); //\n" 152 " }\n" 153 "};"); 154 verifyFormat("return {\n" 155 " a: a,\n" 156 " link: function() {\n" 157 " f(); //\n" 158 " },\n" 159 " link: function() {\n" 160 " f(); //\n" 161 " }\n" 162 "};"); 163 verifyFormat("var stuff = {\n" 164 " // comment for update\n" 165 " update: false,\n" 166 " // comment for modules\n" 167 " modules: false,\n" 168 " // comment for tasks\n" 169 " tasks: false\n" 170 "};"); 171 verifyFormat("return {\n" 172 " 'finish':\n" 173 " //\n" 174 " a\n" 175 "};"); 176 verifyFormat("var obj = {\n" 177 " fooooooooo: function(x) {\n" 178 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n" 179 " }\n" 180 "};"); 181 // Simple object literal, as opposed to enum style below. 182 verifyFormat("var obj = {a: 123};"); 183 // Enum style top level assignment. 184 verifyFormat("X = {\n a: 123\n};"); 185 verifyFormat("X.Y = {\n a: 123\n};"); 186 // But only on the top level, otherwise its a plain object literal assignment. 187 verifyFormat("function x() {\n" 188 " y = {z: 1};\n" 189 "}"); 190 verifyFormat("x = foo && {a: 123};"); 191 192 // Arrow functions in object literals. 193 verifyFormat("var x = {y: (a) => { return a; }};"); 194 verifyFormat("var x = {y: (a) => a};"); 195 196 // Computed keys. 197 verifyFormat("var x = {[a]: 1, b: 2, [c]: 3};"); 198 verifyFormat("var x = {\n" 199 " [a]: 1,\n" 200 " b: 2,\n" 201 " [c]: 3,\n" 202 "};"); 203 204 // Object literals can leave out labels. 205 verifyFormat("f({a}, () => {\n" 206 " g(); //\n" 207 "});"); 208 } 209 210 TEST_F(FormatTestJS, MethodsInObjectLiterals) { 211 verifyFormat("var o = {\n" 212 " value: 'test',\n" 213 " get value() { // getter\n" 214 " return this.value;\n" 215 " }\n" 216 "};"); 217 verifyFormat("var o = {\n" 218 " value: 'test',\n" 219 " set value(val) { // setter\n" 220 " this.value = val;\n" 221 " }\n" 222 "};"); 223 verifyFormat("var o = {\n" 224 " value: 'test',\n" 225 " someMethod(val) { // method\n" 226 " doSomething(this.value + val);\n" 227 " }\n" 228 "};"); 229 verifyFormat("var o = {\n" 230 " someMethod(val) { // method\n" 231 " doSomething(this.value + val);\n" 232 " },\n" 233 " someOtherMethod(val) { // method\n" 234 " doSomething(this.value + val);\n" 235 " }\n" 236 "};"); 237 } 238 239 TEST_F(FormatTestJS, SpacesInContainerLiterals) { 240 verifyFormat("var arr = [1, 2, 3];"); 241 verifyFormat("f({a: 1, b: 2, c: 3});"); 242 243 verifyFormat("var object_literal_with_long_name = {\n" 244 " a: 'aaaaaaaaaaaaaaaaaa',\n" 245 " b: 'bbbbbbbbbbbbbbbbbb'\n" 246 "};"); 247 248 verifyFormat("f({a: 1, b: 2, c: 3});", 249 getChromiumStyle(FormatStyle::LK_JavaScript)); 250 verifyFormat("f({'a': [{}]});"); 251 } 252 253 TEST_F(FormatTestJS, SingleQuoteStrings) { 254 verifyFormat("this.function('', true);"); 255 } 256 257 TEST_F(FormatTestJS, GoogScopes) { 258 verifyFormat("goog.scope(function() {\n" 259 "var x = a.b;\n" 260 "var y = c.d;\n" 261 "}); // goog.scope"); 262 verifyFormat("goog.scope(function() {\n" 263 "// test\n" 264 "var x = 0;\n" 265 "// test\n" 266 "});"); 267 } 268 269 TEST_F(FormatTestJS, GoogModules) { 270 verifyFormat("goog.module('this.is.really.absurdly.long');", 271 getGoogleJSStyleWithColumns(40)); 272 verifyFormat("goog.require('this.is.really.absurdly.long');", 273 getGoogleJSStyleWithColumns(40)); 274 verifyFormat("goog.provide('this.is.really.absurdly.long');", 275 getGoogleJSStyleWithColumns(40)); 276 verifyFormat("var long = goog.require('this.is.really.absurdly.long');", 277 getGoogleJSStyleWithColumns(40)); 278 verifyFormat("goog.setTestOnly('this.is.really.absurdly.long');", 279 getGoogleJSStyleWithColumns(40)); 280 281 // These should be wrapped normally. 282 verifyFormat( 283 "var MyLongClassName =\n" 284 " goog.module.get('my.long.module.name.followedBy.MyLongClassName');"); 285 } 286 287 TEST_F(FormatTestJS, FormatsFreestandingFunctions) { 288 verifyFormat("function outer1(a, b) {\n" 289 " function inner1(a, b) { return a; }\n" 290 " inner1(a, b);\n" 291 "}\n" 292 "function outer2(a, b) {\n" 293 " function inner2(a, b) { return a; }\n" 294 " inner2(a, b);\n" 295 "}"); 296 verifyFormat("function f() {}"); 297 } 298 299 TEST_F(FormatTestJS, ArrayLiterals) { 300 verifyFormat("var aaaaa: List<SomeThing> =\n" 301 " [new SomeThingAAAAAAAAAAAA(), new SomeThingBBBBBBBBB()];"); 302 verifyFormat("return [\n" 303 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 304 " ccccccccccccccccccccccccccc\n" 305 "];"); 306 verifyFormat("return [\n" 307 " aaaa().bbbbbbbb('A'),\n" 308 " aaaa().bbbbbbbb('B'),\n" 309 " aaaa().bbbbbbbb('C'),\n" 310 "];"); 311 verifyFormat("var someVariable = SomeFunction([\n" 312 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 313 " ccccccccccccccccccccccccccc\n" 314 "]);"); 315 verifyFormat("var someVariable = SomeFunction([\n" 316 " [aaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbb],\n" 317 "]);", 318 getGoogleJSStyleWithColumns(51)); 319 verifyFormat("var someVariable = SomeFunction(aaaa, [\n" 320 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 321 " ccccccccccccccccccccccccccc\n" 322 "]);"); 323 verifyFormat("var someVariable = SomeFunction(\n" 324 " aaaa,\n" 325 " [\n" 326 " aaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 327 " cccccccccccccccccccccccccc\n" 328 " ],\n" 329 " aaaa);"); 330 verifyFormat("var aaaa = aaaaa || // wrap\n" 331 " [];"); 332 333 verifyFormat("someFunction([], {a: a});"); 334 } 335 336 TEST_F(FormatTestJS, ColumnLayoutForArrayLiterals) { 337 verifyFormat("var array = [\n" 338 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 339 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 340 "];"); 341 verifyFormat("var array = someFunction([\n" 342 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 343 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 344 "]);"); 345 } 346 347 TEST_F(FormatTestJS, FunctionLiterals) { 348 verifyFormat("doFoo(function() {});"); 349 verifyFormat("doFoo(function() { return 1; });"); 350 verifyFormat("var func = function() {\n" 351 " return 1;\n" 352 "};"); 353 verifyFormat("var func = //\n" 354 " function() {\n" 355 " return 1;\n" 356 "};"); 357 verifyFormat("return {\n" 358 " body: {\n" 359 " setAttribute: function(key, val) { this[key] = val; },\n" 360 " getAttribute: function(key) { return this[key]; },\n" 361 " style: {direction: ''}\n" 362 " }\n" 363 "};"); 364 verifyFormat("abc = xyz ? function() {\n" 365 " return 1;\n" 366 "} : function() {\n" 367 " return -1;\n" 368 "};"); 369 370 verifyFormat("var closure = goog.bind(\n" 371 " function() { // comment\n" 372 " foo();\n" 373 " bar();\n" 374 " },\n" 375 " this, arg1IsReallyLongAndNeeedsLineBreaks,\n" 376 " arg3IsReallyLongAndNeeedsLineBreaks);"); 377 verifyFormat("var closure = goog.bind(function() { // comment\n" 378 " foo();\n" 379 " bar();\n" 380 "}, this);"); 381 verifyFormat("return {\n" 382 " a: 'E',\n" 383 " b: function() {\n" 384 " return function() {\n" 385 " f(); //\n" 386 " };\n" 387 " }\n" 388 "};"); 389 verifyFormat("{\n" 390 " var someVariable = function(x) {\n" 391 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n" 392 " };\n" 393 "}"); 394 verifyFormat("someLooooooooongFunction(\n" 395 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 396 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 397 " function(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" 398 " // code\n" 399 " });"); 400 401 verifyFormat("f({a: function() { return 1; }});", 402 getGoogleJSStyleWithColumns(33)); 403 verifyFormat("f({\n" 404 " a: function() { return 1; }\n" 405 "});", 406 getGoogleJSStyleWithColumns(32)); 407 408 verifyFormat("return {\n" 409 " a: function SomeFunction() {\n" 410 " // ...\n" 411 " return 1;\n" 412 " }\n" 413 "};"); 414 verifyFormat("this.someObject.doSomething(aaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 415 " .then(goog.bind(function(aaaaaaaaaaa) {\n" 416 " someFunction();\n" 417 " someFunction();\n" 418 " }, this), aaaaaaaaaaaaaaaaa);"); 419 420 verifyFormat("someFunction(goog.bind(function() {\n" 421 " doSomething();\n" 422 " doSomething();\n" 423 "}, this), goog.bind(function() {\n" 424 " doSomething();\n" 425 " doSomething();\n" 426 "}, this));"); 427 428 // FIXME: This is bad, we should be wrapping before "function() {". 429 verifyFormat("someFunction(function() {\n" 430 " doSomething(); // break\n" 431 "})\n" 432 " .doSomethingElse(\n" 433 " // break\n" 434 " );"); 435 } 436 437 TEST_F(FormatTestJS, InliningFunctionLiterals) { 438 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 439 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline; 440 verifyFormat("var func = function() {\n" 441 " return 1;\n" 442 "};", 443 Style); 444 verifyFormat("var func = doSomething(function() { return 1; });", Style); 445 verifyFormat("var outer = function() {\n" 446 " var inner = function() { return 1; }\n" 447 "};", 448 Style); 449 verifyFormat("function outer1(a, b) {\n" 450 " function inner1(a, b) { return a; }\n" 451 "}", 452 Style); 453 454 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All; 455 verifyFormat("var func = function() { return 1; };", Style); 456 verifyFormat("var func = doSomething(function() { return 1; });", Style); 457 verifyFormat( 458 "var outer = function() { var inner = function() { return 1; } };", 459 Style); 460 verifyFormat("function outer1(a, b) {\n" 461 " function inner1(a, b) { return a; }\n" 462 "}", 463 Style); 464 465 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None; 466 verifyFormat("var func = function() {\n" 467 " return 1;\n" 468 "};", 469 Style); 470 verifyFormat("var func = doSomething(function() {\n" 471 " return 1;\n" 472 "});", 473 Style); 474 verifyFormat("var outer = function() {\n" 475 " var inner = function() {\n" 476 " return 1;\n" 477 " }\n" 478 "};", 479 Style); 480 verifyFormat("function outer1(a, b) {\n" 481 " function inner1(a, b) {\n" 482 " return a;\n" 483 " }\n" 484 "}", 485 Style); 486 487 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty; 488 verifyFormat("var func = function() {\n" 489 " return 1;\n" 490 "};", 491 Style); 492 } 493 494 TEST_F(FormatTestJS, MultipleFunctionLiterals) { 495 verifyFormat("promise.then(\n" 496 " function success() {\n" 497 " doFoo();\n" 498 " doBar();\n" 499 " },\n" 500 " function error() {\n" 501 " doFoo();\n" 502 " doBaz();\n" 503 " },\n" 504 " []);\n"); 505 verifyFormat("promise.then(\n" 506 " function success() {\n" 507 " doFoo();\n" 508 " doBar();\n" 509 " },\n" 510 " [],\n" 511 " function error() {\n" 512 " doFoo();\n" 513 " doBaz();\n" 514 " });\n"); 515 verifyFormat("promise.then(\n" 516 " [],\n" 517 " function success() {\n" 518 " doFoo();\n" 519 " doBar();\n" 520 " },\n" 521 " function error() {\n" 522 " doFoo();\n" 523 " doBaz();\n" 524 " });\n"); 525 526 verifyFormat("getSomeLongPromise()\n" 527 " .then(function(value) { body(); })\n" 528 " .thenCatch(function(error) {\n" 529 " body();\n" 530 " body();\n" 531 " });"); 532 verifyFormat("getSomeLongPromise()\n" 533 " .then(function(value) {\n" 534 " body();\n" 535 " body();\n" 536 " })\n" 537 " .thenCatch(function(error) {\n" 538 " body();\n" 539 " body();\n" 540 " });"); 541 542 verifyFormat("getSomeLongPromise()\n" 543 " .then(function(value) { body(); })\n" 544 " .thenCatch(function(error) { body(); });"); 545 546 verifyFormat("return [aaaaaaaaaaaaaaaaaaaaaa]\n" 547 " .aaaaaaa(function() {\n" 548 " //\n" 549 " })\n" 550 " .bbbbbb();"); 551 } 552 553 TEST_F(FormatTestJS, ArrowFunctions) { 554 verifyFormat("var x = (a) => {\n" 555 " return a;\n" 556 "};"); 557 verifyFormat("var x = (a) => {\n" 558 " function y() { return 42; }\n" 559 " return a;\n" 560 "};"); 561 verifyFormat("var x = (a: type): {some: type} => {\n" 562 " return a;\n" 563 "};"); 564 verifyFormat("var x = (a) => a;"); 565 verifyFormat("return () => [];"); 566 verifyFormat("var aaaaaaaaaaaaaaaaaaaa = {\n" 567 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa:\n" 568 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 569 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) =>\n" 570 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 571 "};"); 572 verifyFormat("var a = a.aaaaaaa(\n" 573 " (a: a) => aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) &&\n" 574 " aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbb));"); 575 verifyFormat("var a = a.aaaaaaa(\n" 576 " (a: a) => aaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) ?\n" 577 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb) :\n" 578 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb));"); 579 580 // FIXME: This is bad, we should be wrapping before "() => {". 581 verifyFormat("someFunction(() => {\n" 582 " doSomething(); // break\n" 583 "})\n" 584 " .doSomethingElse(\n" 585 " // break\n" 586 " );"); 587 } 588 589 TEST_F(FormatTestJS, ReturnStatements) { 590 verifyFormat("function() {\n" 591 " return [hello, world];\n" 592 "}"); 593 } 594 595 TEST_F(FormatTestJS, ForLoops) { 596 verifyFormat("for (var i in [2, 3]) {\n" 597 "}"); 598 } 599 600 TEST_F(FormatTestJS, AutomaticSemicolonInsertion) { 601 // The following statements must not wrap, as otherwise the program meaning 602 // would change due to automatic semicolon insertion. 603 // See http://www.ecma-international.org/ecma-262/5.1/#sec-7.9.1. 604 verifyFormat("return aaaaa;", getGoogleJSStyleWithColumns(10)); 605 verifyFormat("continue aaaaa;", getGoogleJSStyleWithColumns(10)); 606 verifyFormat("break aaaaa;", getGoogleJSStyleWithColumns(10)); 607 verifyFormat("throw aaaaa;", getGoogleJSStyleWithColumns(10)); 608 verifyFormat("aaaaaaaaa++;", getGoogleJSStyleWithColumns(10)); 609 verifyFormat("aaaaaaaaa--;", getGoogleJSStyleWithColumns(10)); 610 verifyFormat("return [\n" 611 " aaa\n" 612 "];", 613 getGoogleJSStyleWithColumns(12)); 614 } 615 616 TEST_F(FormatTestJS, ClosureStyleCasts) { 617 verifyFormat("var x = /** @type {foo} */ (bar);"); 618 } 619 620 TEST_F(FormatTestJS, TryCatch) { 621 verifyFormat("try {\n" 622 " f();\n" 623 "} catch (e) {\n" 624 " g();\n" 625 "} finally {\n" 626 " h();\n" 627 "}"); 628 629 // But, of course, "catch" is a perfectly fine function name in JavaScript. 630 verifyFormat("someObject.catch();"); 631 verifyFormat("someObject.new();"); 632 verifyFormat("someObject.delete();"); 633 } 634 635 TEST_F(FormatTestJS, StringLiteralConcatenation) { 636 verifyFormat("var literal = 'hello ' +\n" 637 " 'world';"); 638 } 639 640 TEST_F(FormatTestJS, RegexLiteralClassification) { 641 // Regex literals. 642 verifyFormat("var regex = /abc/;"); 643 verifyFormat("f(/abc/);"); 644 verifyFormat("f(abc, /abc/);"); 645 verifyFormat("some_map[/abc/];"); 646 verifyFormat("var x = a ? /abc/ : /abc/;"); 647 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}"); 648 verifyFormat("var x = !/abc/.test(y);"); 649 verifyFormat("var x = a && /abc/.test(y);"); 650 verifyFormat("var x = a || /abc/.test(y);"); 651 verifyFormat("var x = a + /abc/.search(y);"); 652 verifyFormat("/abc/.search(y);"); 653 verifyFormat("var regexs = {/abc/, /abc/};"); 654 verifyFormat("return /abc/;"); 655 656 // Not regex literals. 657 verifyFormat("var a = a / 2 + b / 3;"); 658 verifyFormat("var a = a++ / 2;"); 659 // Prefix unary can operate on regex literals, not that it makes sense. 660 verifyFormat("var a = ++/a/;"); 661 662 // This is a known issue, regular expressions are incorrectly detected if 663 // directly following a closing parenthesis. 664 verifyFormat("if (foo) / bar /.exec(baz);"); 665 } 666 667 TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) { 668 verifyFormat("var regex = /=/;"); 669 verifyFormat("var regex = /a*/;"); 670 verifyFormat("var regex = /a+/;"); 671 verifyFormat("var regex = /a?/;"); 672 verifyFormat("var regex = /.a./;"); 673 verifyFormat("var regex = /a\\*/;"); 674 verifyFormat("var regex = /^a$/;"); 675 verifyFormat("var regex = /\\/a/;"); 676 verifyFormat("var regex = /(?:x)/;"); 677 verifyFormat("var regex = /x(?=y)/;"); 678 verifyFormat("var regex = /x(?!y)/;"); 679 verifyFormat("var regex = /x|y/;"); 680 verifyFormat("var regex = /a{2}/;"); 681 verifyFormat("var regex = /a{1,3}/;"); 682 683 verifyFormat("var regex = /[abc]/;"); 684 verifyFormat("var regex = /[^abc]/;"); 685 verifyFormat("var regex = /[\\b]/;"); 686 verifyFormat("var regex = /[/]/;"); 687 verifyFormat("var regex = /[\\/]/;"); 688 verifyFormat("var regex = /\\[/;"); 689 verifyFormat("var regex = /\\\\[/]/;"); 690 verifyFormat("var regex = /}[\"]/;"); 691 verifyFormat("var regex = /}[/\"]/;"); 692 verifyFormat("var regex = /}[\"/]/;"); 693 694 verifyFormat("var regex = /\\b/;"); 695 verifyFormat("var regex = /\\B/;"); 696 verifyFormat("var regex = /\\d/;"); 697 verifyFormat("var regex = /\\D/;"); 698 verifyFormat("var regex = /\\f/;"); 699 verifyFormat("var regex = /\\n/;"); 700 verifyFormat("var regex = /\\r/;"); 701 verifyFormat("var regex = /\\s/;"); 702 verifyFormat("var regex = /\\S/;"); 703 verifyFormat("var regex = /\\t/;"); 704 verifyFormat("var regex = /\\v/;"); 705 verifyFormat("var regex = /\\w/;"); 706 verifyFormat("var regex = /\\W/;"); 707 verifyFormat("var regex = /a(a)\\1/;"); 708 verifyFormat("var regex = /\\0/;"); 709 verifyFormat("var regex = /\\\\/g;"); 710 verifyFormat("var regex = /\\a\\\\/g;"); 711 verifyFormat("var regex = /\a\\//g;"); 712 verifyFormat("var regex = /a\\//;\n" 713 "var x = 0;"); 714 EXPECT_EQ("var regex = /'/g;", format("var regex = /'/g ;")); 715 EXPECT_EQ("var regex = /'/g; //'", format("var regex = /'/g ; //'")); 716 EXPECT_EQ("var regex = /\\/*/;\n" 717 "var x = 0;", 718 format("var regex = /\\/*/;\n" 719 "var x=0;")); 720 EXPECT_EQ("var x = /a\\//;", format("var x = /a\\// \n;")); 721 verifyFormat("var regex = /\"/;", getGoogleJSStyleWithColumns(16)); 722 verifyFormat("var regex =\n" 723 " /\"/;", 724 getGoogleJSStyleWithColumns(15)); 725 verifyFormat("var regex = //\n" 726 " /a/;"); 727 verifyFormat("var regexs = [\n" 728 " /d/, //\n" 729 " /aa/, //\n" 730 "];"); 731 } 732 733 TEST_F(FormatTestJS, RegexLiteralModifiers) { 734 verifyFormat("var regex = /abc/g;"); 735 verifyFormat("var regex = /abc/i;"); 736 verifyFormat("var regex = /abc/m;"); 737 verifyFormat("var regex = /abc/y;"); 738 } 739 740 TEST_F(FormatTestJS, RegexLiteralLength) { 741 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 742 getGoogleJSStyleWithColumns(60)); 743 verifyFormat("var regex =\n" 744 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 745 getGoogleJSStyleWithColumns(60)); 746 verifyFormat("var regex = /\\xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 747 getGoogleJSStyleWithColumns(50)); 748 } 749 750 TEST_F(FormatTestJS, RegexLiteralExamples) { 751 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);"); 752 } 753 754 TEST_F(FormatTestJS, TypeAnnotations) { 755 verifyFormat("var x: string;"); 756 verifyFormat("var x: {a: string; b: number;} = {};"); 757 verifyFormat("function x(): string {\n return 'x';\n}"); 758 verifyFormat("function x(): {x: string} {\n return {x: 'x'};\n}"); 759 verifyFormat("function x(y: string): string {\n return 'x';\n}"); 760 verifyFormat("for (var y: string in x) {\n x();\n}"); 761 verifyFormat("function x(y: {a?: number;} = {}): number {\n" 762 " return 12;\n" 763 "}"); 764 verifyFormat("((a: string, b: number): string => a + b);"); 765 verifyFormat("var x: (y: number) => string;"); 766 verifyFormat("var x: P<string, (a: number) => string>;"); 767 verifyFormat("var x = {y: function(): z { return 1; }};"); 768 verifyFormat("var x = {y: function(): {a: number} { return 1; }};"); 769 verifyFormat("function someFunc(args: string[]):\n" 770 " {longReturnValue: string[]} {}", 771 getGoogleJSStyleWithColumns(60)); 772 } 773 774 TEST_F(FormatTestJS, ClassDeclarations) { 775 verifyFormat("class C {\n x: string = 12;\n}"); 776 verifyFormat("class C {\n x(): string => 12;\n}"); 777 verifyFormat("class C {\n ['x' + 2]: string = 12;\n}"); 778 verifyFormat("class C {\n private x: string = 12;\n}"); 779 verifyFormat("class C {\n private static x: string = 12;\n}"); 780 verifyFormat("class C {\n static x(): string { return 'asd'; }\n}"); 781 verifyFormat("class C extends P implements I {}"); 782 verifyFormat("class C extends p.P implements i.I {}"); 783 verifyFormat("class Test {\n" 784 " aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaaa):\n" 785 " aaaaaaaaaaaaaaaaaaaaaa {}\n" 786 "}"); 787 verifyFormat("foo = class Name {\n" 788 " constructor() {}\n" 789 "};"); 790 verifyFormat("foo = class {\n" 791 " constructor() {}\n" 792 "};"); 793 verifyFormat("class C {\n" 794 " x: {y: Z;} = {};\n" 795 " private y: {y: Z;} = {};\n" 796 "}"); 797 798 // ':' is not a type declaration here. 799 verifyFormat("class X {\n" 800 " subs = {\n" 801 " 'b': {\n" 802 " 'c': 1,\n" 803 " },\n" 804 " };\n" 805 "}"); 806 } 807 808 TEST_F(FormatTestJS, InterfaceDeclarations) { 809 verifyFormat("interface I {\n" 810 " x: string;\n" 811 " enum: string[];\n" 812 " enum?: string[];\n" 813 "}\n" 814 "var y;"); 815 // Ensure that state is reset after parsing the interface. 816 verifyFormat("interface a {}\n" 817 "export function b() {}\n" 818 "var x;"); 819 820 // Arrays of object type literals. 821 verifyFormat("interface I {\n" 822 " o: {}[];\n" 823 "}"); 824 } 825 826 TEST_F(FormatTestJS, EnumDeclarations) { 827 verifyFormat("enum Foo {\n" 828 " A = 1,\n" 829 " B\n" 830 "}"); 831 verifyFormat("export /* somecomment*/ enum Foo {\n" 832 " A = 1,\n" 833 " B\n" 834 "}"); 835 verifyFormat("enum Foo {\n" 836 " A = 1, // comment\n" 837 " B\n" 838 "}\n" 839 "var x = 1;"); 840 } 841 842 TEST_F(FormatTestJS, MetadataAnnotations) { 843 verifyFormat("@A\nclass C {\n}"); 844 verifyFormat("@A({arg: 'value'})\nclass C {\n}"); 845 verifyFormat("@A\n@B\nclass C {\n}"); 846 verifyFormat("class C {\n @A x: string;\n}"); 847 verifyFormat("class C {\n" 848 " @A\n" 849 " private x(): string {\n" 850 " return 'y';\n" 851 " }\n" 852 "}"); 853 verifyFormat("class X {}\n" 854 "class Y {}"); 855 } 856 857 TEST_F(FormatTestJS, Modules) { 858 verifyFormat("import SomeThing from 'some/module.js';"); 859 verifyFormat("import {X, Y} from 'some/module.js';"); 860 verifyFormat("import a, {X, Y} from 'some/module.js';"); 861 verifyFormat("import {\n" 862 " VeryLongImportsAreAnnoying,\n" 863 " VeryLongImportsAreAnnoying,\n" 864 " VeryLongImportsAreAnnoying,\n" 865 " VeryLongImportsAreAnnoying\n" 866 "} from 'some/module.js';"); 867 verifyFormat("import {\n" 868 " X,\n" 869 " Y,\n" 870 "} from 'some/module.js';"); 871 verifyFormat("import {\n" 872 " X,\n" 873 " Y,\n" 874 "} from 'some/long/module.js';", 875 getGoogleJSStyleWithColumns(20)); 876 verifyFormat("import {X as myLocalX, Y as myLocalY} from 'some/module.js';"); 877 verifyFormat("import * as lib from 'some/module.js';"); 878 verifyFormat("var x = {import: 1};\nx.import = 2;"); 879 880 verifyFormat("export function fn() {\n" 881 " return 'fn';\n" 882 "}"); 883 verifyFormat("export function A() {}\n" 884 "export default function B() {}\n" 885 "export function C() {}"); 886 verifyFormat("export const x = 12;"); 887 verifyFormat("export default class X {}"); 888 verifyFormat("export {X, Y} from 'some/module.js';"); 889 verifyFormat("export {\n" 890 " X,\n" 891 " Y,\n" 892 "} from 'some/module.js';"); 893 verifyFormat("export class C {\n" 894 " x: number;\n" 895 " y: string;\n" 896 "}"); 897 verifyFormat("export class X { y: number; }"); 898 verifyFormat("export abstract class X { y: number; }"); 899 verifyFormat("export default class X { y: number }"); 900 verifyFormat("export default function() {\n return 1;\n}"); 901 verifyFormat("export var x = 12;"); 902 verifyFormat("class C {}\n" 903 "export function f() {}\n" 904 "var v;"); 905 verifyFormat("export var x: number = 12;"); 906 verifyFormat("export const y = {\n" 907 " a: 1,\n" 908 " b: 2\n" 909 "};"); 910 verifyFormat("export enum Foo {\n" 911 " BAR,\n" 912 " // adsdasd\n" 913 " BAZ\n" 914 "}"); 915 verifyFormat("export default [\n" 916 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 917 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n" 918 "];"); 919 verifyFormat("export default [];"); 920 verifyFormat("export default () => {};"); 921 verifyFormat("export interface Foo { foo: number; }\n" 922 "export class Bar {\n" 923 " blah(): string { return this.blah; };\n" 924 "}"); 925 } 926 927 TEST_F(FormatTestJS, TemplateStrings) { 928 // Keeps any whitespace/indentation within the template string. 929 EXPECT_EQ("var x = `hello\n" 930 " ${ name }\n" 931 " !`;", 932 format("var x = `hello\n" 933 " ${ name }\n" 934 " !`;")); 935 936 verifyFormat("var x =\n" 937 " `hello ${world}` >= some();", 938 getGoogleJSStyleWithColumns(34)); // Barely doesn't fit. 939 verifyFormat("var x = `hello ${world}` >= some();", 940 getGoogleJSStyleWithColumns(35)); // Barely fits. 941 EXPECT_EQ("var x = `hello\n" 942 " ${world}` >=\n" 943 " some();", 944 format("var x =\n" 945 " `hello\n" 946 " ${world}` >= some();", 947 getGoogleJSStyleWithColumns(21))); // Barely doesn't fit. 948 EXPECT_EQ("var x = `hello\n" 949 " ${world}` >= some();", 950 format("var x =\n" 951 " `hello\n" 952 " ${world}` >= some();", 953 getGoogleJSStyleWithColumns(22))); // Barely fits. 954 955 verifyFormat("var x =\n" 956 " `h`;", 957 getGoogleJSStyleWithColumns(11)); 958 EXPECT_EQ( 959 "var x =\n `multi\n line`;", 960 format("var x = `multi\n line`;", getGoogleJSStyleWithColumns(13))); 961 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 962 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`);"); 963 964 // Make sure template strings get a proper ColumnWidth assigned, even if they 965 // are first token in line. 966 verifyFormat( 967 "var a = aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 968 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`;"); 969 970 // Two template strings. 971 verifyFormat("var x = `hello` == `hello`;"); 972 973 // Comments in template strings. 974 EXPECT_EQ("var x = `//a`;\n" 975 "var y;", 976 format("var x =\n `//a`;\n" 977 "var y ;")); 978 EXPECT_EQ("var x = `/*a`;\n" 979 "var y;", 980 format("var x =\n `/*a`;\n" 981 "var y;")); 982 // Unterminated string literals in a template string. 983 verifyFormat("var x = `'`; // comment with matching quote '\n" 984 "var y;"); 985 verifyFormat("var x = `\"`; // comment with matching quote \"\n" 986 "var y;"); 987 EXPECT_EQ("it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa);", 988 format("it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa) ;", 989 getGoogleJSStyleWithColumns(40))); 990 // Backticks in a comment - not a template string. 991 EXPECT_EQ("var x = 1 // `/*a`;\n" 992 " ;", 993 format("var x =\n 1 // `/*a`;\n" 994 " ;")); 995 EXPECT_EQ("/* ` */ var x = 1; /* ` */", 996 format("/* ` */ var x\n= 1; /* ` */")); 997 // Comment spans multiple template strings. 998 EXPECT_EQ("var x = `/*a`;\n" 999 "var y = ` */ `;", 1000 format("var x =\n `/*a`;\n" 1001 "var y =\n ` */ `;")); 1002 // Escaped backtick. 1003 EXPECT_EQ("var x = ` \\` a`;\n" 1004 "var y;", 1005 format("var x = ` \\` a`;\n" 1006 "var y;")); 1007 } 1008 1009 TEST_F(FormatTestJS, CastSyntax) { verifyFormat("var x = <type>foo;"); } 1010 1011 TEST_F(FormatTestJS, TypeArguments) { 1012 verifyFormat("class X<Y> {}"); 1013 verifyFormat("new X<Y>();"); 1014 verifyFormat("foo<Y>(a);"); 1015 verifyFormat("var x: X<Y>[];"); 1016 verifyFormat("class C extends D<E> implements F<G>, H<I> {}"); 1017 verifyFormat("function f(a: List<any> = null) {}"); 1018 verifyFormat("function f(): List<any> {}"); 1019 verifyFormat("function aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa():\n" 1020 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb {}"); 1021 verifyFormat("function aaaaaaaaaa(\n" 1022 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa,\n" 1023 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa):\n" 1024 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa {}"); 1025 } 1026 1027 TEST_F(FormatTestJS, UserDefinedTypeGuards) { 1028 verifyFormat( 1029 "function foo(check: Object):\n" 1030 " check is {foo: string, bar: string, baz: string, foobar: string} {\n" 1031 " return 'bar' in check;\n" 1032 "}\n"); 1033 } 1034 1035 TEST_F(FormatTestJS, OptionalTypes) { 1036 verifyFormat("function x(a?: b, c?, d?) {}"); 1037 verifyFormat("class X {\n" 1038 " y?: z;\n" 1039 " z?;\n" 1040 "}"); 1041 verifyFormat("interface X {\n" 1042 " y?(): z;\n" 1043 "}"); 1044 verifyFormat("x ? 1 : 2;"); 1045 verifyFormat("constructor({aa}: {\n" 1046 " aa?: string,\n" 1047 " aaaaaaaa?: string,\n" 1048 " aaaaaaaaaaaaaaa?: boolean,\n" 1049 " aaaaaa?: List<string>\n" 1050 "}) {}"); 1051 } 1052 1053 TEST_F(FormatTestJS, IndexSignature) { 1054 verifyFormat("var x: {[k: string]: v};"); 1055 } 1056 1057 TEST_F(FormatTestJS, WrapAfterParen) { 1058 verifyFormat("xxxxxxxxxxx(\n" 1059 " aaa, aaa);", 1060 getGoogleJSStyleWithColumns(20)); 1061 verifyFormat("xxxxxxxxxxx(\n" 1062 " aaa, aaa, aaa,\n" 1063 " aaa, aaa, aaa);", 1064 getGoogleJSStyleWithColumns(20)); 1065 verifyFormat("xxxxxxxxxxx(\n" 1066 " aaaaaaaaaaaaaaaaaaaaaaaa,\n" 1067 " function(x) {\n" 1068 " y(); //\n" 1069 " });", 1070 getGoogleJSStyleWithColumns(40)); 1071 verifyFormat("while (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n" 1072 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 1073 } 1074 1075 TEST_F(FormatTestJS, JSDocAnnotations) { 1076 EXPECT_EQ("/**\n" 1077 " * @export {this.is.a.long.path.to.a.Type}\n" 1078 " */", 1079 format("/**\n" 1080 " * @export {this.is.a.long.path.to.a.Type}\n" 1081 " */", 1082 getGoogleJSStyleWithColumns(20))); 1083 } 1084 1085 } // end namespace tooling 1086 } // end namespace clang 1087