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 verifyFormat("goog.forwardDeclare('this.is.really.absurdly.long');", 281 getGoogleJSStyleWithColumns(40)); 282 283 // These should be wrapped normally. 284 verifyFormat( 285 "var MyLongClassName =\n" 286 " goog.module.get('my.long.module.name.followedBy.MyLongClassName');"); 287 } 288 289 TEST_F(FormatTestJS, FormatsFreestandingFunctions) { 290 verifyFormat("function outer1(a, b) {\n" 291 " function inner1(a, b) { return a; }\n" 292 " inner1(a, b);\n" 293 "}\n" 294 "function outer2(a, b) {\n" 295 " function inner2(a, b) { return a; }\n" 296 " inner2(a, b);\n" 297 "}"); 298 verifyFormat("function f() {}"); 299 } 300 301 TEST_F(FormatTestJS, ArrayLiterals) { 302 verifyFormat("var aaaaa: List<SomeThing> =\n" 303 " [new SomeThingAAAAAAAAAAAA(), new SomeThingBBBBBBBBB()];"); 304 verifyFormat("return [\n" 305 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 306 " ccccccccccccccccccccccccccc\n" 307 "];"); 308 verifyFormat("return [\n" 309 " aaaa().bbbbbbbb('A'),\n" 310 " aaaa().bbbbbbbb('B'),\n" 311 " aaaa().bbbbbbbb('C'),\n" 312 "];"); 313 verifyFormat("var someVariable = SomeFunction([\n" 314 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 315 " ccccccccccccccccccccccccccc\n" 316 "]);"); 317 verifyFormat("var someVariable = SomeFunction([\n" 318 " [aaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbb],\n" 319 "]);", 320 getGoogleJSStyleWithColumns(51)); 321 verifyFormat("var someVariable = SomeFunction(aaaa, [\n" 322 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 323 " ccccccccccccccccccccccccccc\n" 324 "]);"); 325 verifyFormat("var someVariable = SomeFunction(\n" 326 " aaaa,\n" 327 " [\n" 328 " aaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 329 " cccccccccccccccccccccccccc\n" 330 " ],\n" 331 " aaaa);"); 332 verifyFormat("var aaaa = aaaaa || // wrap\n" 333 " [];"); 334 335 verifyFormat("someFunction([], {a: a});"); 336 } 337 338 TEST_F(FormatTestJS, ColumnLayoutForArrayLiterals) { 339 verifyFormat("var array = [\n" 340 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 341 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 342 "];"); 343 verifyFormat("var array = someFunction([\n" 344 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 345 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 346 "]);"); 347 } 348 349 TEST_F(FormatTestJS, FunctionLiterals) { 350 verifyFormat("doFoo(function() {});"); 351 verifyFormat("doFoo(function() { return 1; });"); 352 verifyFormat("var func = function() {\n" 353 " return 1;\n" 354 "};"); 355 verifyFormat("var func = //\n" 356 " function() {\n" 357 " return 1;\n" 358 "};"); 359 verifyFormat("return {\n" 360 " body: {\n" 361 " setAttribute: function(key, val) { this[key] = val; },\n" 362 " getAttribute: function(key) { return this[key]; },\n" 363 " style: {direction: ''}\n" 364 " }\n" 365 "};"); 366 verifyFormat("abc = xyz ? function() {\n" 367 " return 1;\n" 368 "} : function() {\n" 369 " return -1;\n" 370 "};"); 371 372 verifyFormat("var closure = goog.bind(\n" 373 " function() { // comment\n" 374 " foo();\n" 375 " bar();\n" 376 " },\n" 377 " this, arg1IsReallyLongAndNeeedsLineBreaks,\n" 378 " arg3IsReallyLongAndNeeedsLineBreaks);"); 379 verifyFormat("var closure = goog.bind(function() { // comment\n" 380 " foo();\n" 381 " bar();\n" 382 "}, this);"); 383 verifyFormat("return {\n" 384 " a: 'E',\n" 385 " b: function() {\n" 386 " return function() {\n" 387 " f(); //\n" 388 " };\n" 389 " }\n" 390 "};"); 391 verifyFormat("{\n" 392 " var someVariable = function(x) {\n" 393 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n" 394 " };\n" 395 "}"); 396 verifyFormat("someLooooooooongFunction(\n" 397 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 398 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 399 " function(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" 400 " // code\n" 401 " });"); 402 403 verifyFormat("f({a: function() { return 1; }});", 404 getGoogleJSStyleWithColumns(33)); 405 verifyFormat("f({\n" 406 " a: function() { return 1; }\n" 407 "});", 408 getGoogleJSStyleWithColumns(32)); 409 410 verifyFormat("return {\n" 411 " a: function SomeFunction() {\n" 412 " // ...\n" 413 " return 1;\n" 414 " }\n" 415 "};"); 416 verifyFormat("this.someObject.doSomething(aaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 417 " .then(goog.bind(function(aaaaaaaaaaa) {\n" 418 " someFunction();\n" 419 " someFunction();\n" 420 " }, this), aaaaaaaaaaaaaaaaa);"); 421 422 verifyFormat("someFunction(goog.bind(function() {\n" 423 " doSomething();\n" 424 " doSomething();\n" 425 "}, this), goog.bind(function() {\n" 426 " doSomething();\n" 427 " doSomething();\n" 428 "}, this));"); 429 430 // FIXME: This is bad, we should be wrapping before "function() {". 431 verifyFormat("someFunction(function() {\n" 432 " doSomething(); // break\n" 433 "})\n" 434 " .doSomethingElse(\n" 435 " // break\n" 436 " );"); 437 } 438 439 TEST_F(FormatTestJS, InliningFunctionLiterals) { 440 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 441 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline; 442 verifyFormat("var func = function() {\n" 443 " return 1;\n" 444 "};", 445 Style); 446 verifyFormat("var func = doSomething(function() { return 1; });", Style); 447 verifyFormat("var outer = function() {\n" 448 " var inner = function() { return 1; }\n" 449 "};", 450 Style); 451 verifyFormat("function outer1(a, b) {\n" 452 " function inner1(a, b) { return a; }\n" 453 "}", 454 Style); 455 456 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All; 457 verifyFormat("var func = function() { return 1; };", Style); 458 verifyFormat("var func = doSomething(function() { return 1; });", Style); 459 verifyFormat( 460 "var outer = function() { var inner = function() { return 1; } };", 461 Style); 462 verifyFormat("function outer1(a, b) {\n" 463 " function inner1(a, b) { return a; }\n" 464 "}", 465 Style); 466 467 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None; 468 verifyFormat("var func = function() {\n" 469 " return 1;\n" 470 "};", 471 Style); 472 verifyFormat("var func = doSomething(function() {\n" 473 " return 1;\n" 474 "});", 475 Style); 476 verifyFormat("var outer = function() {\n" 477 " var inner = function() {\n" 478 " return 1;\n" 479 " }\n" 480 "};", 481 Style); 482 verifyFormat("function outer1(a, b) {\n" 483 " function inner1(a, b) {\n" 484 " return a;\n" 485 " }\n" 486 "}", 487 Style); 488 489 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty; 490 verifyFormat("var func = function() {\n" 491 " return 1;\n" 492 "};", 493 Style); 494 } 495 496 TEST_F(FormatTestJS, MultipleFunctionLiterals) { 497 verifyFormat("promise.then(\n" 498 " function success() {\n" 499 " doFoo();\n" 500 " doBar();\n" 501 " },\n" 502 " function error() {\n" 503 " doFoo();\n" 504 " doBaz();\n" 505 " },\n" 506 " []);\n"); 507 verifyFormat("promise.then(\n" 508 " function success() {\n" 509 " doFoo();\n" 510 " doBar();\n" 511 " },\n" 512 " [],\n" 513 " function error() {\n" 514 " doFoo();\n" 515 " doBaz();\n" 516 " });\n"); 517 verifyFormat("promise.then(\n" 518 " [],\n" 519 " function success() {\n" 520 " doFoo();\n" 521 " doBar();\n" 522 " },\n" 523 " function error() {\n" 524 " doFoo();\n" 525 " doBaz();\n" 526 " });\n"); 527 528 verifyFormat("getSomeLongPromise()\n" 529 " .then(function(value) { body(); })\n" 530 " .thenCatch(function(error) {\n" 531 " body();\n" 532 " body();\n" 533 " });"); 534 verifyFormat("getSomeLongPromise()\n" 535 " .then(function(value) {\n" 536 " body();\n" 537 " body();\n" 538 " })\n" 539 " .thenCatch(function(error) {\n" 540 " body();\n" 541 " body();\n" 542 " });"); 543 544 verifyFormat("getSomeLongPromise()\n" 545 " .then(function(value) { body(); })\n" 546 " .thenCatch(function(error) { body(); });"); 547 548 verifyFormat("return [aaaaaaaaaaaaaaaaaaaaaa]\n" 549 " .aaaaaaa(function() {\n" 550 " //\n" 551 " })\n" 552 " .bbbbbb();"); 553 } 554 555 TEST_F(FormatTestJS, ArrowFunctions) { 556 verifyFormat("var x = (a) => {\n" 557 " return a;\n" 558 "};"); 559 verifyFormat("var x = (a) => {\n" 560 " function y() { return 42; }\n" 561 " return a;\n" 562 "};"); 563 verifyFormat("var x = (a: type): {some: type} => {\n" 564 " return a;\n" 565 "};"); 566 verifyFormat("var x = (a) => a;"); 567 verifyFormat("return () => [];"); 568 verifyFormat("var aaaaaaaaaaaaaaaaaaaa = {\n" 569 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa:\n" 570 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 571 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) =>\n" 572 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 573 "};"); 574 verifyFormat("var a = a.aaaaaaa(\n" 575 " (a: a) => aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) &&\n" 576 " aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbb));"); 577 verifyFormat("var a = a.aaaaaaa(\n" 578 " (a: a) => aaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) ?\n" 579 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb) :\n" 580 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb));"); 581 582 // FIXME: This is bad, we should be wrapping before "() => {". 583 verifyFormat("someFunction(() => {\n" 584 " doSomething(); // break\n" 585 "})\n" 586 " .doSomethingElse(\n" 587 " // break\n" 588 " );"); 589 } 590 591 TEST_F(FormatTestJS, ReturnStatements) { 592 verifyFormat("function() {\n" 593 " return [hello, world];\n" 594 "}"); 595 } 596 597 TEST_F(FormatTestJS, ForLoops) { 598 verifyFormat("for (var i in [2, 3]) {\n" 599 "}"); 600 verifyFormat("for (var i of [2, 3]) {\n" 601 "}"); 602 } 603 604 TEST_F(FormatTestJS, AutomaticSemicolonInsertion) { 605 // The following statements must not wrap, as otherwise the program meaning 606 // would change due to automatic semicolon insertion. 607 // See http://www.ecma-international.org/ecma-262/5.1/#sec-7.9.1. 608 verifyFormat("return aaaaa;", getGoogleJSStyleWithColumns(10)); 609 verifyFormat("continue aaaaa;", getGoogleJSStyleWithColumns(10)); 610 verifyFormat("break aaaaa;", getGoogleJSStyleWithColumns(10)); 611 verifyFormat("throw aaaaa;", getGoogleJSStyleWithColumns(10)); 612 verifyFormat("aaaaaaaaa++;", getGoogleJSStyleWithColumns(10)); 613 verifyFormat("aaaaaaaaa--;", getGoogleJSStyleWithColumns(10)); 614 verifyFormat("return [\n" 615 " aaa\n" 616 "];", 617 getGoogleJSStyleWithColumns(12)); 618 } 619 620 TEST_F(FormatTestJS, ClosureStyleCasts) { 621 verifyFormat("var x = /** @type {foo} */ (bar);"); 622 } 623 624 TEST_F(FormatTestJS, TryCatch) { 625 verifyFormat("try {\n" 626 " f();\n" 627 "} catch (e) {\n" 628 " g();\n" 629 "} finally {\n" 630 " h();\n" 631 "}"); 632 633 // But, of course, "catch" is a perfectly fine function name in JavaScript. 634 verifyFormat("someObject.catch();"); 635 verifyFormat("someObject.new();"); 636 verifyFormat("someObject.delete();"); 637 } 638 639 TEST_F(FormatTestJS, StringLiteralConcatenation) { 640 verifyFormat("var literal = 'hello ' +\n" 641 " 'world';"); 642 } 643 644 TEST_F(FormatTestJS, RegexLiteralClassification) { 645 // Regex literals. 646 verifyFormat("var regex = /abc/;"); 647 verifyFormat("f(/abc/);"); 648 verifyFormat("f(abc, /abc/);"); 649 verifyFormat("some_map[/abc/];"); 650 verifyFormat("var x = a ? /abc/ : /abc/;"); 651 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}"); 652 verifyFormat("var x = !/abc/.test(y);"); 653 verifyFormat("var x = a && /abc/.test(y);"); 654 verifyFormat("var x = a || /abc/.test(y);"); 655 verifyFormat("var x = a + /abc/.search(y);"); 656 verifyFormat("/abc/.search(y);"); 657 verifyFormat("var regexs = {/abc/, /abc/};"); 658 verifyFormat("return /abc/;"); 659 660 // Not regex literals. 661 verifyFormat("var a = a / 2 + b / 3;"); 662 verifyFormat("var a = a++ / 2;"); 663 // Prefix unary can operate on regex literals, not that it makes sense. 664 verifyFormat("var a = ++/a/;"); 665 666 // This is a known issue, regular expressions are incorrectly detected if 667 // directly following a closing parenthesis. 668 verifyFormat("if (foo) / bar /.exec(baz);"); 669 } 670 671 TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) { 672 verifyFormat("var regex = /=/;"); 673 verifyFormat("var regex = /a*/;"); 674 verifyFormat("var regex = /a+/;"); 675 verifyFormat("var regex = /a?/;"); 676 verifyFormat("var regex = /.a./;"); 677 verifyFormat("var regex = /a\\*/;"); 678 verifyFormat("var regex = /^a$/;"); 679 verifyFormat("var regex = /\\/a/;"); 680 verifyFormat("var regex = /(?:x)/;"); 681 verifyFormat("var regex = /x(?=y)/;"); 682 verifyFormat("var regex = /x(?!y)/;"); 683 verifyFormat("var regex = /x|y/;"); 684 verifyFormat("var regex = /a{2}/;"); 685 verifyFormat("var regex = /a{1,3}/;"); 686 687 verifyFormat("var regex = /[abc]/;"); 688 verifyFormat("var regex = /[^abc]/;"); 689 verifyFormat("var regex = /[\\b]/;"); 690 verifyFormat("var regex = /[/]/;"); 691 verifyFormat("var regex = /[\\/]/;"); 692 verifyFormat("var regex = /\\[/;"); 693 verifyFormat("var regex = /\\\\[/]/;"); 694 verifyFormat("var regex = /}[\"]/;"); 695 verifyFormat("var regex = /}[/\"]/;"); 696 verifyFormat("var regex = /}[\"/]/;"); 697 698 verifyFormat("var regex = /\\b/;"); 699 verifyFormat("var regex = /\\B/;"); 700 verifyFormat("var regex = /\\d/;"); 701 verifyFormat("var regex = /\\D/;"); 702 verifyFormat("var regex = /\\f/;"); 703 verifyFormat("var regex = /\\n/;"); 704 verifyFormat("var regex = /\\r/;"); 705 verifyFormat("var regex = /\\s/;"); 706 verifyFormat("var regex = /\\S/;"); 707 verifyFormat("var regex = /\\t/;"); 708 verifyFormat("var regex = /\\v/;"); 709 verifyFormat("var regex = /\\w/;"); 710 verifyFormat("var regex = /\\W/;"); 711 verifyFormat("var regex = /a(a)\\1/;"); 712 verifyFormat("var regex = /\\0/;"); 713 verifyFormat("var regex = /\\\\/g;"); 714 verifyFormat("var regex = /\\a\\\\/g;"); 715 verifyFormat("var regex = /\a\\//g;"); 716 verifyFormat("var regex = /a\\//;\n" 717 "var x = 0;"); 718 EXPECT_EQ("var regex = /'/g;", format("var regex = /'/g ;")); 719 EXPECT_EQ("var regex = /'/g; //'", format("var regex = /'/g ; //'")); 720 EXPECT_EQ("var regex = /\\/*/;\n" 721 "var x = 0;", 722 format("var regex = /\\/*/;\n" 723 "var x=0;")); 724 EXPECT_EQ("var x = /a\\//;", format("var x = /a\\// \n;")); 725 verifyFormat("var regex = /\"/;", getGoogleJSStyleWithColumns(16)); 726 verifyFormat("var regex =\n" 727 " /\"/;", 728 getGoogleJSStyleWithColumns(15)); 729 verifyFormat("var regex = //\n" 730 " /a/;"); 731 verifyFormat("var regexs = [\n" 732 " /d/, //\n" 733 " /aa/, //\n" 734 "];"); 735 } 736 737 TEST_F(FormatTestJS, RegexLiteralModifiers) { 738 verifyFormat("var regex = /abc/g;"); 739 verifyFormat("var regex = /abc/i;"); 740 verifyFormat("var regex = /abc/m;"); 741 verifyFormat("var regex = /abc/y;"); 742 } 743 744 TEST_F(FormatTestJS, RegexLiteralLength) { 745 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 746 getGoogleJSStyleWithColumns(60)); 747 verifyFormat("var regex =\n" 748 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 749 getGoogleJSStyleWithColumns(60)); 750 verifyFormat("var regex = /\\xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 751 getGoogleJSStyleWithColumns(50)); 752 } 753 754 TEST_F(FormatTestJS, RegexLiteralExamples) { 755 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);"); 756 } 757 758 TEST_F(FormatTestJS, TypeAnnotations) { 759 verifyFormat("var x: string;"); 760 verifyFormat("var x: {a: string; b: number;} = {};"); 761 verifyFormat("function x(): string {\n return 'x';\n}"); 762 verifyFormat("function x(): {x: string} {\n return {x: 'x'};\n}"); 763 verifyFormat("function x(y: string): string {\n return 'x';\n}"); 764 verifyFormat("for (var y: string in x) {\n x();\n}"); 765 verifyFormat("for (var y: string of x) {\n x();\n}"); 766 verifyFormat("function x(y: {a?: number;} = {}): number {\n" 767 " return 12;\n" 768 "}"); 769 verifyFormat("((a: string, b: number): string => a + b);"); 770 verifyFormat("var x: (y: number) => string;"); 771 verifyFormat("var x: P<string, (a: number) => string>;"); 772 verifyFormat("var x = {y: function(): z { return 1; }};"); 773 verifyFormat("var x = {y: function(): {a: number} { return 1; }};"); 774 verifyFormat("function someFunc(args: string[]):\n" 775 " {longReturnValue: string[]} {}", 776 getGoogleJSStyleWithColumns(60)); 777 } 778 779 TEST_F(FormatTestJS, ClassDeclarations) { 780 verifyFormat("class C {\n x: string = 12;\n}"); 781 verifyFormat("class C {\n x(): string => 12;\n}"); 782 verifyFormat("class C {\n ['x' + 2]: string = 12;\n}"); 783 verifyFormat("class C {\n private x: string = 12;\n}"); 784 verifyFormat("class C {\n private static x: string = 12;\n}"); 785 verifyFormat("class C {\n static x(): string { return 'asd'; }\n}"); 786 verifyFormat("class C extends P implements I {}"); 787 verifyFormat("class C extends p.P implements i.I {}"); 788 verifyFormat("class Test {\n" 789 " aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaaa):\n" 790 " aaaaaaaaaaaaaaaaaaaaaa {}\n" 791 "}"); 792 verifyFormat("foo = class Name {\n" 793 " constructor() {}\n" 794 "};"); 795 verifyFormat("foo = class {\n" 796 " constructor() {}\n" 797 "};"); 798 verifyFormat("class C {\n" 799 " x: {y: Z;} = {};\n" 800 " private y: {y: Z;} = {};\n" 801 "}"); 802 803 // ':' is not a type declaration here. 804 verifyFormat("class X {\n" 805 " subs = {\n" 806 " 'b': {\n" 807 " 'c': 1,\n" 808 " },\n" 809 " };\n" 810 "}"); 811 } 812 813 TEST_F(FormatTestJS, InterfaceDeclarations) { 814 verifyFormat("interface I {\n" 815 " x: string;\n" 816 " enum: string[];\n" 817 " enum?: string[];\n" 818 "}\n" 819 "var y;"); 820 // Ensure that state is reset after parsing the interface. 821 verifyFormat("interface a {}\n" 822 "export function b() {}\n" 823 "var x;"); 824 825 // Arrays of object type literals. 826 verifyFormat("interface I {\n" 827 " o: {}[];\n" 828 "}"); 829 } 830 831 TEST_F(FormatTestJS, EnumDeclarations) { 832 verifyFormat("enum Foo {\n" 833 " A = 1,\n" 834 " B\n" 835 "}"); 836 verifyFormat("export /* somecomment*/ enum Foo {\n" 837 " A = 1,\n" 838 " B\n" 839 "}"); 840 verifyFormat("enum Foo {\n" 841 " A = 1, // comment\n" 842 " B\n" 843 "}\n" 844 "var x = 1;"); 845 } 846 847 TEST_F(FormatTestJS, MetadataAnnotations) { 848 verifyFormat("@A\nclass C {\n}"); 849 verifyFormat("@A({arg: 'value'})\nclass C {\n}"); 850 verifyFormat("@A\n@B\nclass C {\n}"); 851 verifyFormat("class C {\n @A x: string;\n}"); 852 verifyFormat("class C {\n" 853 " @A\n" 854 " private x(): string {\n" 855 " return 'y';\n" 856 " }\n" 857 "}"); 858 verifyFormat("class X {}\n" 859 "class Y {}"); 860 } 861 862 TEST_F(FormatTestJS, Modules) { 863 verifyFormat("import SomeThing from 'some/module.js';"); 864 verifyFormat("import {X, Y} from 'some/module.js';"); 865 verifyFormat("import a, {X, Y} from 'some/module.js';"); 866 verifyFormat("import {\n" 867 " VeryLongImportsAreAnnoying,\n" 868 " VeryLongImportsAreAnnoying,\n" 869 " VeryLongImportsAreAnnoying,\n" 870 " VeryLongImportsAreAnnoying\n" 871 "} from 'some/module.js';"); 872 verifyFormat("import {\n" 873 " X,\n" 874 " Y,\n" 875 "} from 'some/module.js';"); 876 verifyFormat("import {\n" 877 " X,\n" 878 " Y,\n" 879 "} from 'some/long/module.js';", 880 getGoogleJSStyleWithColumns(20)); 881 verifyFormat("import {X as myLocalX, Y as myLocalY} from 'some/module.js';"); 882 verifyFormat("import * as lib from 'some/module.js';"); 883 verifyFormat("var x = {import: 1};\nx.import = 2;"); 884 885 verifyFormat("export function fn() {\n" 886 " return 'fn';\n" 887 "}"); 888 verifyFormat("export function A() {}\n" 889 "export default function B() {}\n" 890 "export function C() {}"); 891 verifyFormat("export const x = 12;"); 892 verifyFormat("export default class X {}"); 893 verifyFormat("export {X, Y} from 'some/module.js';"); 894 verifyFormat("export {\n" 895 " X,\n" 896 " Y,\n" 897 "} from 'some/module.js';"); 898 verifyFormat("export class C {\n" 899 " x: number;\n" 900 " y: string;\n" 901 "}"); 902 verifyFormat("export class X { y: number; }"); 903 verifyFormat("export abstract class X { y: number; }"); 904 verifyFormat("export default class X { y: number }"); 905 verifyFormat("export default function() {\n return 1;\n}"); 906 verifyFormat("export var x = 12;"); 907 verifyFormat("class C {}\n" 908 "export function f() {}\n" 909 "var v;"); 910 verifyFormat("export var x: number = 12;"); 911 verifyFormat("export const y = {\n" 912 " a: 1,\n" 913 " b: 2\n" 914 "};"); 915 verifyFormat("export enum Foo {\n" 916 " BAR,\n" 917 " // adsdasd\n" 918 " BAZ\n" 919 "}"); 920 verifyFormat("export default [\n" 921 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 922 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n" 923 "];"); 924 verifyFormat("export default [];"); 925 verifyFormat("export default () => {};"); 926 verifyFormat("export interface Foo { foo: number; }\n" 927 "export class Bar {\n" 928 " blah(): string { return this.blah; };\n" 929 "}"); 930 } 931 932 TEST_F(FormatTestJS, TemplateStrings) { 933 // Keeps any whitespace/indentation within the template string. 934 EXPECT_EQ("var x = `hello\n" 935 " ${ name }\n" 936 " !`;", 937 format("var x = `hello\n" 938 " ${ name }\n" 939 " !`;")); 940 941 verifyFormat("var x =\n" 942 " `hello ${world}` >= some();", 943 getGoogleJSStyleWithColumns(34)); // Barely doesn't fit. 944 verifyFormat("var x = `hello ${world}` >= some();", 945 getGoogleJSStyleWithColumns(35)); // Barely fits. 946 EXPECT_EQ("var x = `hello\n" 947 " ${world}` >=\n" 948 " some();", 949 format("var x =\n" 950 " `hello\n" 951 " ${world}` >= some();", 952 getGoogleJSStyleWithColumns(21))); // Barely doesn't fit. 953 EXPECT_EQ("var x = `hello\n" 954 " ${world}` >= some();", 955 format("var x =\n" 956 " `hello\n" 957 " ${world}` >= some();", 958 getGoogleJSStyleWithColumns(22))); // Barely fits. 959 960 verifyFormat("var x =\n" 961 " `h`;", 962 getGoogleJSStyleWithColumns(11)); 963 EXPECT_EQ( 964 "var x =\n `multi\n line`;", 965 format("var x = `multi\n line`;", getGoogleJSStyleWithColumns(13))); 966 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 967 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`);"); 968 969 // Make sure template strings get a proper ColumnWidth assigned, even if they 970 // are first token in line. 971 verifyFormat( 972 "var a = aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 973 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`;"); 974 975 // Two template strings. 976 verifyFormat("var x = `hello` == `hello`;"); 977 978 // Comments in template strings. 979 EXPECT_EQ("var x = `//a`;\n" 980 "var y;", 981 format("var x =\n `//a`;\n" 982 "var y ;")); 983 EXPECT_EQ("var x = `/*a`;\n" 984 "var y;", 985 format("var x =\n `/*a`;\n" 986 "var y;")); 987 // Unterminated string literals in a template string. 988 verifyFormat("var x = `'`; // comment with matching quote '\n" 989 "var y;"); 990 verifyFormat("var x = `\"`; // comment with matching quote \"\n" 991 "var y;"); 992 EXPECT_EQ("it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa);", 993 format("it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa) ;", 994 getGoogleJSStyleWithColumns(40))); 995 // Backticks in a comment - not a template string. 996 EXPECT_EQ("var x = 1 // `/*a`;\n" 997 " ;", 998 format("var x =\n 1 // `/*a`;\n" 999 " ;")); 1000 EXPECT_EQ("/* ` */ var x = 1; /* ` */", 1001 format("/* ` */ var x\n= 1; /* ` */")); 1002 // Comment spans multiple template strings. 1003 EXPECT_EQ("var x = `/*a`;\n" 1004 "var y = ` */ `;", 1005 format("var x =\n `/*a`;\n" 1006 "var y =\n ` */ `;")); 1007 // Escaped backtick. 1008 EXPECT_EQ("var x = ` \\` a`;\n" 1009 "var y;", 1010 format("var x = ` \\` a`;\n" 1011 "var y;")); 1012 } 1013 1014 TEST_F(FormatTestJS, CastSyntax) { verifyFormat("var x = <type>foo;"); } 1015 1016 TEST_F(FormatTestJS, TypeArguments) { 1017 verifyFormat("class X<Y> {}"); 1018 verifyFormat("new X<Y>();"); 1019 verifyFormat("foo<Y>(a);"); 1020 verifyFormat("var x: X<Y>[];"); 1021 verifyFormat("class C extends D<E> implements F<G>, H<I> {}"); 1022 verifyFormat("function f(a: List<any> = null) {}"); 1023 verifyFormat("function f(): List<any> {}"); 1024 verifyFormat("function aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa():\n" 1025 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb {}"); 1026 verifyFormat("function aaaaaaaaaa(\n" 1027 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa,\n" 1028 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa):\n" 1029 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa {}"); 1030 } 1031 1032 TEST_F(FormatTestJS, UserDefinedTypeGuards) { 1033 verifyFormat( 1034 "function foo(check: Object):\n" 1035 " check is {foo: string, bar: string, baz: string, foobar: string} {\n" 1036 " return 'bar' in check;\n" 1037 "}\n"); 1038 } 1039 1040 TEST_F(FormatTestJS, OptionalTypes) { 1041 verifyFormat("function x(a?: b, c?, d?) {}"); 1042 verifyFormat("class X {\n" 1043 " y?: z;\n" 1044 " z?;\n" 1045 "}"); 1046 verifyFormat("interface X {\n" 1047 " y?(): z;\n" 1048 "}"); 1049 verifyFormat("x ? 1 : 2;"); 1050 verifyFormat("constructor({aa}: {\n" 1051 " aa?: string,\n" 1052 " aaaaaaaa?: string,\n" 1053 " aaaaaaaaaaaaaaa?: boolean,\n" 1054 " aaaaaa?: List<string>\n" 1055 "}) {}"); 1056 } 1057 1058 TEST_F(FormatTestJS, IndexSignature) { 1059 verifyFormat("var x: {[k: string]: v};"); 1060 } 1061 1062 TEST_F(FormatTestJS, WrapAfterParen) { 1063 verifyFormat("xxxxxxxxxxx(\n" 1064 " aaa, aaa);", 1065 getGoogleJSStyleWithColumns(20)); 1066 verifyFormat("xxxxxxxxxxx(\n" 1067 " aaa, aaa, aaa,\n" 1068 " aaa, aaa, aaa);", 1069 getGoogleJSStyleWithColumns(20)); 1070 verifyFormat("xxxxxxxxxxx(\n" 1071 " aaaaaaaaaaaaaaaaaaaaaaaa,\n" 1072 " function(x) {\n" 1073 " y(); //\n" 1074 " });", 1075 getGoogleJSStyleWithColumns(40)); 1076 verifyFormat("while (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n" 1077 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 1078 } 1079 1080 TEST_F(FormatTestJS, JSDocAnnotations) { 1081 EXPECT_EQ("/**\n" 1082 " * @export {this.is.a.long.path.to.a.Type}\n" 1083 " */", 1084 format("/**\n" 1085 " * @export {this.is.a.long.path.to.a.Type}\n" 1086 " */", 1087 getGoogleJSStyleWithColumns(20))); 1088 } 1089 1090 } // end namespace tooling 1091 } // end namespace clang 1092