1 //===- unittest/Format/FormatTestJS.cpp - Formatting unit tests for JS ----===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "FormatTestUtils.h" 10 #include "clang/Format/Format.h" 11 #include "llvm/Support/Debug.h" 12 #include "gtest/gtest.h" 13 14 #define DEBUG_TYPE "format-test" 15 16 namespace clang { 17 namespace format { 18 19 class FormatTestJS : public ::testing::Test { 20 protected: 21 static std::string format(llvm::StringRef Code, unsigned Offset, 22 unsigned Length, const FormatStyle &Style) { 23 LLVM_DEBUG(llvm::errs() << "---\n"); 24 LLVM_DEBUG(llvm::errs() << Code << "\n\n"); 25 std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length)); 26 FormattingAttemptStatus Status; 27 tooling::Replacements Replaces = 28 reformat(Style, Code, Ranges, "<stdin>", &Status); 29 EXPECT_TRUE(Status.FormatComplete); 30 auto Result = applyAllReplacements(Code, Replaces); 31 EXPECT_TRUE(static_cast<bool>(Result)); 32 LLVM_DEBUG(llvm::errs() << "\n" << *Result << "\n\n"); 33 return *Result; 34 } 35 36 static std::string format( 37 llvm::StringRef Code, 38 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) { 39 return format(Code, 0, Code.size(), Style); 40 } 41 42 static FormatStyle getGoogleJSStyleWithColumns(unsigned ColumnLimit) { 43 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 44 Style.ColumnLimit = ColumnLimit; 45 return Style; 46 } 47 48 static void verifyFormat( 49 llvm::StringRef Code, 50 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) { 51 EXPECT_EQ(Code.str(), format(Code, Style)) << "Expected code is not stable"; 52 std::string Result = format(test::messUp(Code), Style); 53 EXPECT_EQ(Code.str(), Result) << "Formatted:\n" << Result; 54 } 55 56 static void verifyFormat( 57 llvm::StringRef Expected, llvm::StringRef Code, 58 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) { 59 EXPECT_EQ(Expected.str(), format(Expected, Style)) 60 << "Expected code is not stable"; 61 std::string Result = format(Code, Style); 62 EXPECT_EQ(Expected.str(), Result) << "Formatted:\n" << Result; 63 } 64 }; 65 66 TEST_F(FormatTestJS, BlockComments) { 67 verifyFormat("/* aaaaaaaaaaaaa */ aaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 68 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 69 // Breaks after a single line block comment. 70 EXPECT_EQ("aaaaa = bbbb.ccccccccccccccc(\n" 71 " /** @type_{!cccc.rrrrrrr.MMMMMMMMMMMM.LLLLLLLLLLL.lala} */\n" 72 " mediaMessage);", 73 format("aaaaa = bbbb.ccccccccccccccc(\n" 74 " /** " 75 "@type_{!cccc.rrrrrrr.MMMMMMMMMMMM.LLLLLLLLLLL.lala} */ " 76 "mediaMessage);", 77 getGoogleJSStyleWithColumns(70))); 78 // Breaks after a multiline block comment. 79 EXPECT_EQ( 80 "aaaaa = bbbb.ccccccccccccccc(\n" 81 " /**\n" 82 " * @type_{!cccc.rrrrrrr.MMMMMMMMMMMM.LLLLLLLLLLL.lala}\n" 83 " */\n" 84 " mediaMessage);", 85 format("aaaaa = bbbb.ccccccccccccccc(\n" 86 " /**\n" 87 " * @type_{!cccc.rrrrrrr.MMMMMMMMMMMM.LLLLLLLLLLL.lala}\n" 88 " */ mediaMessage);", 89 getGoogleJSStyleWithColumns(70))); 90 } 91 92 TEST_F(FormatTestJS, JSDocComments) { 93 // Break the first line of a multiline jsdoc comment. 94 EXPECT_EQ("/**\n" 95 " * jsdoc line 1\n" 96 " * jsdoc line 2\n" 97 " */", 98 format("/** jsdoc line 1\n" 99 " * jsdoc line 2\n" 100 " */", 101 getGoogleJSStyleWithColumns(20))); 102 // Both break after '/**' and break the line itself. 103 EXPECT_EQ("/**\n" 104 " * jsdoc line long\n" 105 " * long jsdoc line 2\n" 106 " */", 107 format("/** jsdoc line long long\n" 108 " * jsdoc line 2\n" 109 " */", 110 getGoogleJSStyleWithColumns(20))); 111 // Break a short first line if the ending '*/' is on a newline. 112 EXPECT_EQ("/**\n" 113 " * jsdoc line 1\n" 114 " */", 115 format("/** jsdoc line 1\n" 116 " */", 117 getGoogleJSStyleWithColumns(20))); 118 // Don't break the first line of a short single line jsdoc comment. 119 verifyFormat("/** jsdoc line 1 */", getGoogleJSStyleWithColumns(20)); 120 // Don't break the first line of a single line jsdoc comment if it just fits 121 // the column limit. 122 verifyFormat("/** jsdoc line 12 */", getGoogleJSStyleWithColumns(20)); 123 // Don't break after '/**' and before '*/' if there is no space between 124 // '/**' and the content. 125 EXPECT_EQ( 126 "/*** nonjsdoc long\n" 127 " * line */", 128 format("/*** nonjsdoc long line */", getGoogleJSStyleWithColumns(20))); 129 EXPECT_EQ( 130 "/**strange long long\n" 131 " * line */", 132 format("/**strange long long line */", getGoogleJSStyleWithColumns(20))); 133 // Break the first line of a single line jsdoc comment if it just exceeds the 134 // column limit. 135 EXPECT_EQ("/**\n" 136 " * jsdoc line 123\n" 137 " */", 138 format("/** jsdoc line 123 */", getGoogleJSStyleWithColumns(20))); 139 // Break also if the leading indent of the first line is more than 1 column. 140 EXPECT_EQ("/**\n" 141 " * jsdoc line 123\n" 142 " */", 143 format("/** jsdoc line 123 */", getGoogleJSStyleWithColumns(20))); 144 // Break also if the leading indent of the first line is more than 1 column. 145 EXPECT_EQ("/**\n" 146 " * jsdoc line 123\n" 147 " */", 148 format("/** jsdoc line 123 */", getGoogleJSStyleWithColumns(20))); 149 // Break after the content of the last line. 150 EXPECT_EQ("/**\n" 151 " * line 1\n" 152 " * line 2\n" 153 " */", 154 format("/**\n" 155 " * line 1\n" 156 " * line 2 */", 157 getGoogleJSStyleWithColumns(20))); 158 // Break both the content and after the content of the last line. 159 EXPECT_EQ("/**\n" 160 " * line 1\n" 161 " * line long long\n" 162 " * long\n" 163 " */", 164 format("/**\n" 165 " * line 1\n" 166 " * line long long long */", 167 getGoogleJSStyleWithColumns(20))); 168 169 // The comment block gets indented. 170 EXPECT_EQ("function f() {\n" 171 " /**\n" 172 " * comment about\n" 173 " * x\n" 174 " */\n" 175 " var x = 1;\n" 176 "}", 177 format("function f() {\n" 178 "/** comment about x */\n" 179 "var x = 1;\n" 180 "}", 181 getGoogleJSStyleWithColumns(20))); 182 183 // Don't break the first line of a single line short jsdoc comment pragma. 184 verifyFormat("/** @returns j */", getGoogleJSStyleWithColumns(20)); 185 186 // Break a single line long jsdoc comment pragma. 187 EXPECT_EQ("/**\n" 188 " * @returns {string}\n" 189 " * jsdoc line 12\n" 190 " */", 191 format("/** @returns {string} jsdoc line 12 */", 192 getGoogleJSStyleWithColumns(20))); 193 194 // FIXME: this overcounts the */ as a continuation of the 12 when breaking. 195 // Cf. BreakableBlockComment::getRemainingLength. 196 EXPECT_EQ("/**\n" 197 " * @returns {string}\n" 198 " * jsdoc line line\n" 199 " * 12\n" 200 " */", 201 format("/** @returns {string} jsdoc line line 12*/", 202 getGoogleJSStyleWithColumns(25))); 203 204 // Fix a multiline jsdoc comment ending in a comment pragma. 205 EXPECT_EQ("/**\n" 206 " * line 1\n" 207 " * line 2\n" 208 " * @returns {string}\n" 209 " * jsdoc line 12\n" 210 " */", 211 format("/** line 1\n" 212 " * line 2\n" 213 " * @returns {string} jsdoc line 12 */", 214 getGoogleJSStyleWithColumns(20))); 215 216 EXPECT_EQ("/**\n" 217 " * line 1\n" 218 " * line 2\n" 219 " *\n" 220 " * @returns j\n" 221 " */", 222 format("/** line 1\n" 223 " * line 2\n" 224 " *\n" 225 " * @returns j */", 226 getGoogleJSStyleWithColumns(20))); 227 } 228 229 TEST_F(FormatTestJS, UnderstandsJavaScriptOperators) { 230 verifyFormat("a == = b;"); 231 verifyFormat("a != = b;"); 232 233 verifyFormat("a === b;"); 234 verifyFormat("aaaaaaa ===\n b;", getGoogleJSStyleWithColumns(10)); 235 verifyFormat("a !== b;"); 236 verifyFormat("aaaaaaa !==\n b;", getGoogleJSStyleWithColumns(10)); 237 verifyFormat("if (a + b + c +\n" 238 " d !==\n" 239 " e + f + g)\n" 240 " q();", 241 getGoogleJSStyleWithColumns(20)); 242 243 verifyFormat("a >> >= b;"); 244 245 verifyFormat("a >>> b;"); 246 verifyFormat("aaaaaaa >>>\n b;", getGoogleJSStyleWithColumns(10)); 247 verifyFormat("a >>>= b;"); 248 verifyFormat("aaaaaaa >>>=\n b;", getGoogleJSStyleWithColumns(10)); 249 verifyFormat("if (a + b + c +\n" 250 " d >>>\n" 251 " e + f + g)\n" 252 " q();", 253 getGoogleJSStyleWithColumns(20)); 254 verifyFormat("var x = aaaaaaaaaa ?\n" 255 " bbbbbb :\n" 256 " ccc;", 257 getGoogleJSStyleWithColumns(20)); 258 259 verifyFormat("var b = a.map((x) => x + 1);"); 260 verifyFormat("return ('aaa') in bbbb;"); 261 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n" 262 " aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 263 FormatStyle Style = getGoogleJSStyleWithColumns(80); 264 Style.AlignOperands = FormatStyle::OAS_Align; 265 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n" 266 " aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 267 Style); 268 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All; 269 verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa()\n" 270 " in aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 271 Style); 272 273 // ES6 spread operator. 274 verifyFormat("someFunction(...a);"); 275 verifyFormat("var x = [1, ...a, 2];"); 276 277 // "- -1" is legal JS syntax, but must not collapse into "--". 278 verifyFormat("- -1;", " - -1;"); 279 verifyFormat("-- -1;", " -- -1;"); 280 verifyFormat("+ +1;", " + +1;"); 281 verifyFormat("++ +1;", " ++ +1;"); 282 } 283 284 TEST_F(FormatTestJS, UnderstandsAmpAmp) { 285 verifyFormat("e && e.SomeFunction();"); 286 } 287 288 TEST_F(FormatTestJS, LiteralOperatorsCanBeKeywords) { 289 verifyFormat("not.and.or.not_eq = 1;"); 290 } 291 292 TEST_F(FormatTestJS, ReservedWords) { 293 // JavaScript reserved words (aka keywords) are only illegal when used as 294 // Identifiers, but are legal as IdentifierNames. 295 verifyFormat("x.class.struct = 1;"); 296 verifyFormat("x.case = 1;"); 297 verifyFormat("x.interface = 1;"); 298 verifyFormat("x.for = 1;"); 299 verifyFormat("x.of();"); 300 verifyFormat("of(null);"); 301 verifyFormat("return of(null);"); 302 verifyFormat("import {of} from 'x';"); 303 verifyFormat("x.in();"); 304 verifyFormat("x.let();"); 305 verifyFormat("x.var();"); 306 verifyFormat("x.for();"); 307 verifyFormat("x.as();"); 308 verifyFormat("x.instanceof();"); 309 verifyFormat("x.switch();"); 310 verifyFormat("x.case();"); 311 verifyFormat("x.delete();"); 312 verifyFormat("x.throw();"); 313 verifyFormat("x.throws();"); 314 verifyFormat("x.if();"); 315 verifyFormat("x = {\n" 316 " a: 12,\n" 317 " interface: 1,\n" 318 " switch: 1,\n" 319 "};"); 320 verifyFormat("var struct = 2;"); 321 verifyFormat("var union = 2;"); 322 verifyFormat("var interface = 2;"); 323 verifyFormat("var requires = {};"); 324 verifyFormat("interface = 2;"); 325 verifyFormat("x = interface instanceof y;"); 326 verifyFormat("interface Test {\n" 327 " x: string;\n" 328 " switch: string;\n" 329 " case: string;\n" 330 " default: string;\n" 331 "}\n"); 332 verifyFormat("const Axis = {\n" 333 " for: 'for',\n" 334 " x: 'x'\n" 335 "};", 336 "const Axis = {for: 'for', x: 'x'};"); 337 verifyFormat("export class Foo extends Bar {\n" 338 " get case(): Case {\n" 339 " return (\n" 340 " (this.Bar$has('case')) ? (this.Bar$get('case')) :\n" 341 " (this.case = new Case()));\n" 342 " }\n" 343 "}"); 344 } 345 346 TEST_F(FormatTestJS, ReservedWordsMethods) { 347 verifyFormat("class X {\n" 348 " delete() {\n" 349 " x();\n" 350 " }\n" 351 " interface() {\n" 352 " x();\n" 353 " }\n" 354 " let() {\n" 355 " x();\n" 356 " }\n" 357 "}\n"); 358 verifyFormat("class KeywordNamedMethods {\n" 359 " do() {\n" 360 " }\n" 361 " for() {\n" 362 " }\n" 363 " while() {\n" 364 " }\n" 365 " if() {\n" 366 " }\n" 367 " else() {\n" 368 " }\n" 369 " try() {\n" 370 " }\n" 371 " catch() {\n" 372 " }\n" 373 "}\n"); 374 } 375 376 TEST_F(FormatTestJS, ReservedWordsParenthesized) { 377 // All of these are statements using the keyword, not function calls. 378 verifyFormat("throw (x + y);\n" 379 "await (await x).y;\n" 380 "typeof (x) === 'string';\n" 381 "void (0);\n" 382 "delete (x.y);\n" 383 "return (x);\n"); 384 } 385 386 TEST_F(FormatTestJS, ES6DestructuringAssignment) { 387 verifyFormat("var [a, b, c] = [1, 2, 3];"); 388 verifyFormat("const [a, b, c] = [1, 2, 3];"); 389 verifyFormat("let [a, b, c] = [1, 2, 3];"); 390 verifyFormat("var {a, b} = {a: 1, b: 2};"); 391 verifyFormat("let {a, b} = {a: 1, b: 2};"); 392 } 393 394 TEST_F(FormatTestJS, ContainerLiterals) { 395 verifyFormat("var x = {\n" 396 " y: function(a) {\n" 397 " return a;\n" 398 " }\n" 399 "};"); 400 verifyFormat("return {\n" 401 " link: function() {\n" 402 " f(); //\n" 403 " }\n" 404 "};"); 405 verifyFormat("return {\n" 406 " a: a,\n" 407 " link: function() {\n" 408 " f(); //\n" 409 " }\n" 410 "};"); 411 verifyFormat("return {\n" 412 " a: a,\n" 413 " link: function() {\n" 414 " f(); //\n" 415 " },\n" 416 " link: function() {\n" 417 " f(); //\n" 418 " }\n" 419 "};"); 420 verifyFormat("var stuff = {\n" 421 " // comment for update\n" 422 " update: false,\n" 423 " // comment for modules\n" 424 " modules: false,\n" 425 " // comment for tasks\n" 426 " tasks: false\n" 427 "};"); 428 verifyFormat("return {\n" 429 " 'finish':\n" 430 " //\n" 431 " a\n" 432 "};"); 433 verifyFormat("var obj = {\n" 434 " fooooooooo: function(x) {\n" 435 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n" 436 " }\n" 437 "};"); 438 // Simple object literal, as opposed to enum style below. 439 verifyFormat("var obj = {a: 123};"); 440 // Enum style top level assignment. 441 verifyFormat("X = {\n a: 123\n};"); 442 verifyFormat("X.Y = {\n a: 123\n};"); 443 // But only on the top level, otherwise its a plain object literal assignment. 444 verifyFormat("function x() {\n" 445 " y = {z: 1};\n" 446 "}"); 447 verifyFormat("x = foo && {a: 123};"); 448 449 // Arrow functions in object literals. 450 verifyFormat("var x = {\n" 451 " y: (a) => {\n" 452 " x();\n" 453 " return a;\n" 454 " },\n" 455 "};"); 456 verifyFormat("var x = {y: (a) => a};"); 457 458 // Methods in object literals. 459 verifyFormat("var x = {\n" 460 " y(a: string): number {\n" 461 " return a;\n" 462 " }\n" 463 "};"); 464 verifyFormat("var x = {\n" 465 " y(a: string) {\n" 466 " return a;\n" 467 " }\n" 468 "};"); 469 470 // Computed keys. 471 verifyFormat("var x = {[a]: 1, b: 2, [c]: 3};"); 472 verifyFormat("var x = {\n" 473 " [a]: 1,\n" 474 " b: 2,\n" 475 " [c]: 3,\n" 476 "};"); 477 478 // Object literals can leave out labels. 479 verifyFormat("f({a}, () => {\n" 480 " x;\n" 481 " g();\n" 482 "});"); 483 484 // Keys can be quoted. 485 verifyFormat("var x = {\n" 486 " a: a,\n" 487 " b: b,\n" 488 " 'c': c,\n" 489 "};"); 490 491 // Dict literals can skip the label names. 492 verifyFormat("var x = {\n" 493 " aaa,\n" 494 " aaa,\n" 495 " aaa,\n" 496 "};"); 497 verifyFormat("return {\n" 498 " a,\n" 499 " b: 'b',\n" 500 " c,\n" 501 "};"); 502 } 503 504 TEST_F(FormatTestJS, MethodsInObjectLiterals) { 505 verifyFormat("var o = {\n" 506 " value: 'test',\n" 507 " get value() { // getter\n" 508 " return this.value;\n" 509 " }\n" 510 "};"); 511 verifyFormat("var o = {\n" 512 " value: 'test',\n" 513 " set value(val) { // setter\n" 514 " this.value = val;\n" 515 " }\n" 516 "};"); 517 verifyFormat("var o = {\n" 518 " value: 'test',\n" 519 " someMethod(val) { // method\n" 520 " doSomething(this.value + val);\n" 521 " }\n" 522 "};"); 523 verifyFormat("var o = {\n" 524 " someMethod(val) { // method\n" 525 " doSomething(this.value + val);\n" 526 " },\n" 527 " someOtherMethod(val) { // method\n" 528 " doSomething(this.value + val);\n" 529 " }\n" 530 "};"); 531 } 532 533 TEST_F(FormatTestJS, GettersSettersVisibilityKeywords) { 534 // Don't break after "protected" 535 verifyFormat("class X {\n" 536 " protected get getter():\n" 537 " number {\n" 538 " return 1;\n" 539 " }\n" 540 "}", 541 getGoogleJSStyleWithColumns(12)); 542 // Don't break after "get" 543 verifyFormat("class X {\n" 544 " protected get someReallyLongGetterName():\n" 545 " number {\n" 546 " return 1;\n" 547 " }\n" 548 "}", 549 getGoogleJSStyleWithColumns(40)); 550 } 551 552 TEST_F(FormatTestJS, SpacesInContainerLiterals) { 553 verifyFormat("var arr = [1, 2, 3];"); 554 verifyFormat("f({a: 1, b: 2, c: 3});"); 555 556 verifyFormat("var object_literal_with_long_name = {\n" 557 " a: 'aaaaaaaaaaaaaaaaaa',\n" 558 " b: 'bbbbbbbbbbbbbbbbbb'\n" 559 "};"); 560 561 verifyFormat("f({a: 1, b: 2, c: 3});", 562 getChromiumStyle(FormatStyle::LK_JavaScript)); 563 verifyFormat("f({'a': [{}]});"); 564 } 565 566 TEST_F(FormatTestJS, SingleQuotedStrings) { 567 verifyFormat("this.function('', true);"); 568 } 569 570 TEST_F(FormatTestJS, GoogScopes) { 571 verifyFormat("goog.scope(function() {\n" 572 "var x = a.b;\n" 573 "var y = c.d;\n" 574 "}); // goog.scope"); 575 verifyFormat("goog.scope(function() {\n" 576 "// test\n" 577 "var x = 0;\n" 578 "// test\n" 579 "});"); 580 } 581 582 TEST_F(FormatTestJS, IIFEs) { 583 // Internal calling parens; no semi. 584 verifyFormat("(function() {\n" 585 "var a = 1;\n" 586 "}())"); 587 // External calling parens; no semi. 588 verifyFormat("(function() {\n" 589 "var b = 2;\n" 590 "})()"); 591 // Internal calling parens; with semi. 592 verifyFormat("(function() {\n" 593 "var c = 3;\n" 594 "}());"); 595 // External calling parens; with semi. 596 verifyFormat("(function() {\n" 597 "var d = 4;\n" 598 "})();"); 599 } 600 601 TEST_F(FormatTestJS, GoogModules) { 602 verifyFormat("goog.module('this.is.really.absurdly.long');", 603 getGoogleJSStyleWithColumns(40)); 604 verifyFormat("goog.require('this.is.really.absurdly.long');", 605 getGoogleJSStyleWithColumns(40)); 606 verifyFormat("goog.provide('this.is.really.absurdly.long');", 607 getGoogleJSStyleWithColumns(40)); 608 verifyFormat("var long = goog.require('this.is.really.absurdly.long');", 609 getGoogleJSStyleWithColumns(40)); 610 verifyFormat("const X = goog.requireType('this.is.really.absurdly.long');", 611 getGoogleJSStyleWithColumns(40)); 612 verifyFormat("goog.forwardDeclare('this.is.really.absurdly.long');", 613 getGoogleJSStyleWithColumns(40)); 614 615 // These should be wrapped normally. 616 verifyFormat( 617 "var MyLongClassName =\n" 618 " goog.module.get('my.long.module.name.followedBy.MyLongClassName');"); 619 verifyFormat("function a() {\n" 620 " goog.setTestOnly();\n" 621 "}\n", 622 "function a() {\n" 623 "goog.setTestOnly();\n" 624 "}\n"); 625 } 626 627 TEST_F(FormatTestJS, FormatsNamespaces) { 628 verifyFormat("namespace Foo {\n" 629 " export let x = 1;\n" 630 "}\n"); 631 verifyFormat("declare namespace Foo {\n" 632 " export let x: number;\n" 633 "}\n"); 634 } 635 636 TEST_F(FormatTestJS, NamespacesMayNotWrap) { 637 verifyFormat("declare namespace foobarbaz {\n" 638 "}\n", 639 getGoogleJSStyleWithColumns(18)); 640 verifyFormat("declare module foobarbaz {\n" 641 "}\n", 642 getGoogleJSStyleWithColumns(15)); 643 verifyFormat("namespace foobarbaz {\n" 644 "}\n", 645 getGoogleJSStyleWithColumns(10)); 646 verifyFormat("module foobarbaz {\n" 647 "}\n", 648 getGoogleJSStyleWithColumns(7)); 649 } 650 651 TEST_F(FormatTestJS, AmbientDeclarations) { 652 FormatStyle NineCols = getGoogleJSStyleWithColumns(9); 653 verifyFormat("declare class\n" 654 " X {}", 655 NineCols); 656 verifyFormat("declare function\n" 657 "x();", // TODO(martinprobst): should ideally be indented. 658 NineCols); 659 verifyFormat("declare function foo();\n" 660 "let x = 1;\n"); 661 verifyFormat("declare function foo(): string;\n" 662 "let x = 1;\n"); 663 verifyFormat("declare function foo(): {x: number};\n" 664 "let x = 1;\n"); 665 verifyFormat("declare class X {}\n" 666 "let x = 1;\n"); 667 verifyFormat("declare interface Y {}\n" 668 "let x = 1;\n"); 669 verifyFormat("declare enum X {\n" 670 "}", 671 NineCols); 672 verifyFormat("declare let\n" 673 " x: number;", 674 NineCols); 675 } 676 677 TEST_F(FormatTestJS, FormatsFreestandingFunctions) { 678 verifyFormat("function outer1(a, b) {\n" 679 " function inner1(a, b) {\n" 680 " return a;\n" 681 " }\n" 682 " inner1(a, b);\n" 683 "}\n" 684 "function outer2(a, b) {\n" 685 " function inner2(a, b) {\n" 686 " return a;\n" 687 " }\n" 688 " inner2(a, b);\n" 689 "}"); 690 verifyFormat("function f() {}"); 691 verifyFormat("function aFunction() {}\n" 692 "(function f() {\n" 693 " var x = 1;\n" 694 "}());\n"); 695 verifyFormat("function aFunction() {}\n" 696 "{\n" 697 " let x = 1;\n" 698 " console.log(x);\n" 699 "}\n"); 700 EXPECT_EQ("a = function(x) {}\n" 701 "\n" 702 "function f(x) {}", 703 format("a = function(x) {}\n" 704 "\n" 705 "function f(x) {}", 706 getGoogleJSStyleWithColumns(20))); 707 } 708 709 TEST_F(FormatTestJS, FormatsDecorators) { 710 // No line break after argument decorators. 711 verifyFormat("class A {\n" 712 " constructor(@arg(DECOR) private arg: Type) {}\n" 713 "}"); 714 // Ensure that there is a break before functions, getters and setters. 715 EXPECT_EQ("class A {\n" 716 " private p = () => {}\n" 717 "\n" 718 " @decorated('a')\n" 719 " get f() {\n" 720 " return result;\n" 721 " }\n" 722 "}\n" 723 "\n" 724 "class B {\n" 725 " private p = () => {}\n" 726 "\n" 727 " @decorated('a')\n" 728 " set f() {\n" 729 " return result;\n" 730 " }\n" 731 "}\n" 732 "\n" 733 "class C {\n" 734 " private p = () => {}\n" 735 "\n" 736 " @decorated('a')\n" 737 " function f() {\n" 738 " return result;\n" 739 " }\n" 740 "}", 741 format("class A {\n" 742 " private p = () => {}\n" 743 "\n" 744 " @decorated('a')\n" 745 " get f() {\n" 746 " return result;\n" 747 " }\n" 748 "}\n" 749 "\n" 750 "class B {\n" 751 " private p = () => {}\n" 752 "\n" 753 " @decorated('a')\n" 754 " set f() {\n" 755 " return result;\n" 756 " }\n" 757 "}\n" 758 "\n" 759 "class C {\n" 760 " private p = () => {}\n" 761 "\n" 762 " @decorated('a')\n" 763 " function f() {\n" 764 " return result;\n" 765 " }\n" 766 "}", 767 getGoogleJSStyleWithColumns(50))); 768 } 769 770 TEST_F(FormatTestJS, GeneratorFunctions) { 771 verifyFormat("function* f() {\n" 772 " let x = 1;\n" 773 " yield x;\n" 774 " yield* something();\n" 775 " yield [1, 2];\n" 776 " yield {a: 1};\n" 777 "}"); 778 verifyFormat("function*\n" 779 " f() {\n" 780 "}", 781 getGoogleJSStyleWithColumns(8)); 782 verifyFormat("export function* f() {\n" 783 " yield 1;\n" 784 "}\n"); 785 verifyFormat("class X {\n" 786 " * generatorMethod() {\n" 787 " yield x;\n" 788 " }\n" 789 "}"); 790 verifyFormat("var x = {\n" 791 " a: function*() {\n" 792 " //\n" 793 " }\n" 794 "}\n"); 795 } 796 797 TEST_F(FormatTestJS, AsyncFunctions) { 798 verifyFormat("async function f() {\n" 799 " let x = 1;\n" 800 " return fetch(x);\n" 801 "}"); 802 verifyFormat("async function f() {\n" 803 " return 1;\n" 804 "}\n" 805 "\n" 806 "function a() {\n" 807 " return 1;\n" 808 "}\n", 809 " async function f() {\n" 810 " return 1;\n" 811 "}\n" 812 "\n" 813 " function a() {\n" 814 " return 1;\n" 815 "} \n"); 816 // clang-format must not insert breaks between async and function, otherwise 817 // automatic semicolon insertion may trigger (in particular in a class body). 818 verifyFormat("async function\n" 819 "hello(\n" 820 " myparamnameiswaytooloooong) {\n" 821 "}", 822 "async function hello(myparamnameiswaytooloooong) {}", 823 getGoogleJSStyleWithColumns(10)); 824 verifyFormat("class C {\n" 825 " async hello(\n" 826 " myparamnameiswaytooloooong) {\n" 827 " }\n" 828 "}", 829 "class C {\n" 830 " async hello(myparamnameiswaytooloooong) {} }", 831 getGoogleJSStyleWithColumns(10)); 832 verifyFormat("async function* f() {\n" 833 " yield fetch(x);\n" 834 "}"); 835 verifyFormat("export async function f() {\n" 836 " return fetch(x);\n" 837 "}"); 838 verifyFormat("let x = async () => f();"); 839 verifyFormat("let x = async function() {\n" 840 " f();\n" 841 "};"); 842 verifyFormat("let x = async();"); 843 verifyFormat("class X {\n" 844 " async asyncMethod() {\n" 845 " return fetch(1);\n" 846 " }\n" 847 "}"); 848 verifyFormat("function initialize() {\n" 849 " // Comment.\n" 850 " return async.then();\n" 851 "}\n"); 852 verifyFormat("for await (const x of y) {\n" 853 " console.log(x);\n" 854 "}\n"); 855 verifyFormat("function asyncLoop() {\n" 856 " for await (const x of y) {\n" 857 " console.log(x);\n" 858 " }\n" 859 "}\n"); 860 } 861 862 TEST_F(FormatTestJS, OverriddenMembers) { 863 verifyFormat( 864 "class C extends P {\n" 865 " protected override " 866 "anOverlyLongPropertyNameSoLongItHasToGoInASeparateLineWhenOverriden:\n" 867 " undefined;\n" 868 "}\n"); 869 verifyFormat( 870 "class C extends P {\n" 871 " protected override " 872 "anOverlyLongMethodNameSoLongItHasToGoInASeparateLineWhenOverriden() {\n" 873 " }\n" 874 "}\n"); 875 verifyFormat("class C extends P {\n" 876 " protected override aMethodName<ATypeParam extends {},\n" 877 " BTypeParam " 878 "extends {}>() {}\n" 879 "}\n"); 880 } 881 882 TEST_F(FormatTestJS, FunctionParametersTrailingComma) { 883 verifyFormat("function trailingComma(\n" 884 " p1,\n" 885 " p2,\n" 886 " p3,\n" 887 ") {\n" 888 " a; //\n" 889 "}\n", 890 "function trailingComma(p1, p2, p3,) {\n" 891 " a; //\n" 892 "}\n"); 893 verifyFormat("trailingComma(\n" 894 " p1,\n" 895 " p2,\n" 896 " p3,\n" 897 ");\n", 898 "trailingComma(p1, p2, p3,);\n"); 899 verifyFormat("trailingComma(\n" 900 " p1 // hello\n" 901 ");\n", 902 "trailingComma(p1 // hello\n" 903 ");\n"); 904 } 905 906 TEST_F(FormatTestJS, ArrayLiterals) { 907 verifyFormat("var aaaaa: List<SomeThing> =\n" 908 " [new SomeThingAAAAAAAAAAAA(), new SomeThingBBBBBBBBB()];"); 909 verifyFormat("return [\n" 910 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 911 " ccccccccccccccccccccccccccc\n" 912 "];"); 913 verifyFormat("return [\n" 914 " aaaa().bbbbbbbb('A'),\n" 915 " aaaa().bbbbbbbb('B'),\n" 916 " aaaa().bbbbbbbb('C'),\n" 917 "];"); 918 verifyFormat("var someVariable = SomeFunction([\n" 919 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 920 " ccccccccccccccccccccccccccc\n" 921 "]);"); 922 verifyFormat("var someVariable = SomeFunction([\n" 923 " [aaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbb],\n" 924 "]);", 925 getGoogleJSStyleWithColumns(51)); 926 verifyFormat("var someVariable = SomeFunction(aaaa, [\n" 927 " aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 928 " ccccccccccccccccccccccccccc\n" 929 "]);"); 930 verifyFormat("var someVariable = SomeFunction(\n" 931 " aaaa,\n" 932 " [\n" 933 " aaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 934 " cccccccccccccccccccccccccc\n" 935 " ],\n" 936 " aaaa);"); 937 verifyFormat("var aaaa = aaaaa || // wrap\n" 938 " [];"); 939 940 verifyFormat("someFunction([], {a: a});"); 941 942 verifyFormat("var string = [\n" 943 " 'aaaaaa',\n" 944 " 'bbbbbb',\n" 945 "].join('+');"); 946 } 947 948 TEST_F(FormatTestJS, ColumnLayoutForArrayLiterals) { 949 verifyFormat("var array = [\n" 950 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 951 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 952 "];"); 953 verifyFormat("var array = someFunction([\n" 954 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 955 " a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n" 956 "]);"); 957 } 958 959 TEST_F(FormatTestJS, TrailingCommaInsertion) { 960 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 961 Style.InsertTrailingCommas = FormatStyle::TCS_Wrapped; 962 // Insert comma in wrapped array. 963 verifyFormat("const x = [\n" 964 " 1, //\n" 965 " 2,\n" 966 "];", 967 "const x = [\n" 968 " 1, //\n" 969 " 2];", 970 Style); 971 // Insert comma in newly wrapped array. 972 Style.ColumnLimit = 30; 973 verifyFormat("const x = [\n" 974 " aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 975 "];", 976 "const x = [aaaaaaaaaaaaaaaaaaaaaaaaa];", Style); 977 // Do not insert trailing commas if they'd exceed the colum limit 978 verifyFormat("const x = [\n" 979 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 980 "];", 981 "const x = [aaaaaaaaaaaaaaaaaaaaaaaaaaaa];", Style); 982 // Object literals. 983 verifyFormat("const x = {\n" 984 " a: aaaaaaaaaaaaaaaaa,\n" 985 "};", 986 "const x = {a: aaaaaaaaaaaaaaaaa};", Style); 987 verifyFormat("const x = {\n" 988 " a: aaaaaaaaaaaaaaaaaaaaaaaaa\n" 989 "};", 990 "const x = {a: aaaaaaaaaaaaaaaaaaaaaaaaa};", Style); 991 // Object literal types. 992 verifyFormat("let x: {\n" 993 " a: aaaaaaaaaaaaaaaaaaaaa,\n" 994 "};", 995 "let x: {a: aaaaaaaaaaaaaaaaaaaaa};", Style); 996 } 997 998 TEST_F(FormatTestJS, FunctionLiterals) { 999 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 1000 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline; 1001 verifyFormat("doFoo(function() {});"); 1002 verifyFormat("doFoo(function() { return 1; });", Style); 1003 verifyFormat("var func = function() {\n" 1004 " return 1;\n" 1005 "};"); 1006 verifyFormat("var func = //\n" 1007 " function() {\n" 1008 " return 1;\n" 1009 "};"); 1010 verifyFormat("return {\n" 1011 " body: {\n" 1012 " setAttribute: function(key, val) { this[key] = val; },\n" 1013 " getAttribute: function(key) { return this[key]; },\n" 1014 " style: {direction: ''}\n" 1015 " }\n" 1016 "};", 1017 Style); 1018 verifyFormat("abc = xyz ? function() {\n" 1019 " return 1;\n" 1020 "} : function() {\n" 1021 " return -1;\n" 1022 "};"); 1023 1024 verifyFormat("var closure = goog.bind(\n" 1025 " function() { // comment\n" 1026 " foo();\n" 1027 " bar();\n" 1028 " },\n" 1029 " this, arg1IsReallyLongAndNeedsLineBreaks,\n" 1030 " arg3IsReallyLongAndNeedsLineBreaks);"); 1031 verifyFormat("var closure = goog.bind(function() { // comment\n" 1032 " foo();\n" 1033 " bar();\n" 1034 "}, this);"); 1035 verifyFormat("return {\n" 1036 " a: 'E',\n" 1037 " b: function() {\n" 1038 " return function() {\n" 1039 " f(); //\n" 1040 " };\n" 1041 " }\n" 1042 "};"); 1043 verifyFormat("{\n" 1044 " var someVariable = function(x) {\n" 1045 " return x.zIsTooLongForOneLineWithTheDeclarationLine();\n" 1046 " };\n" 1047 "}"); 1048 verifyFormat("someLooooooooongFunction(\n" 1049 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1050 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1051 " function(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" 1052 " // code\n" 1053 " });"); 1054 1055 verifyFormat("return {\n" 1056 " a: function SomeFunction() {\n" 1057 " // ...\n" 1058 " return 1;\n" 1059 " }\n" 1060 "};"); 1061 verifyFormat("this.someObject.doSomething(aaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 1062 " .then(goog.bind(function(aaaaaaaaaaa) {\n" 1063 " someFunction();\n" 1064 " someFunction();\n" 1065 " }, this), aaaaaaaaaaaaaaaaa);"); 1066 1067 verifyFormat("someFunction(goog.bind(function() {\n" 1068 " doSomething();\n" 1069 " doSomething();\n" 1070 "}, this), goog.bind(function() {\n" 1071 " doSomething();\n" 1072 " doSomething();\n" 1073 "}, this));"); 1074 1075 verifyFormat("SomeFunction(function() {\n" 1076 " foo();\n" 1077 " bar();\n" 1078 "}.bind(this));"); 1079 1080 verifyFormat("SomeFunction((function() {\n" 1081 " foo();\n" 1082 " bar();\n" 1083 " }).bind(this));"); 1084 1085 // FIXME: This is bad, we should be wrapping before "function() {". 1086 verifyFormat("someFunction(function() {\n" 1087 " doSomething(); // break\n" 1088 "})\n" 1089 " .doSomethingElse(\n" 1090 " // break\n" 1091 " );"); 1092 1093 Style.ColumnLimit = 33; 1094 verifyFormat("f({a: function() { return 1; }});", Style); 1095 Style.ColumnLimit = 32; 1096 verifyFormat("f({\n" 1097 " a: function() { return 1; }\n" 1098 "});", 1099 Style); 1100 } 1101 1102 TEST_F(FormatTestJS, DontWrapEmptyLiterals) { 1103 verifyFormat("(aaaaaaaaaaaaaaaaaaaaa.getData as jasmine.Spy)\n" 1104 " .and.returnValue(Observable.of([]));"); 1105 verifyFormat("(aaaaaaaaaaaaaaaaaaaaa.getData as jasmine.Spy)\n" 1106 " .and.returnValue(Observable.of({}));"); 1107 verifyFormat("(aaaaaaaaaaaaaaaaaaaaa.getData as jasmine.Spy)\n" 1108 " .and.returnValue(Observable.of(()));"); 1109 } 1110 1111 TEST_F(FormatTestJS, InliningFunctionLiterals) { 1112 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 1113 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline; 1114 verifyFormat("var func = function() {\n" 1115 " return 1;\n" 1116 "};", 1117 Style); 1118 verifyFormat("var func = doSomething(function() { return 1; });", Style); 1119 verifyFormat("var outer = function() {\n" 1120 " var inner = function() { return 1; }\n" 1121 "};", 1122 Style); 1123 verifyFormat("function outer1(a, b) {\n" 1124 " function inner1(a, b) { return a; }\n" 1125 "}", 1126 Style); 1127 1128 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All; 1129 verifyFormat("var func = function() { return 1; };", Style); 1130 verifyFormat("var func = doSomething(function() { return 1; });", Style); 1131 verifyFormat( 1132 "var outer = function() { var inner = function() { return 1; } };", 1133 Style); 1134 verifyFormat("function outer1(a, b) {\n" 1135 " function inner1(a, b) { return a; }\n" 1136 "}", 1137 Style); 1138 1139 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None; 1140 verifyFormat("var func = function() {\n" 1141 " return 1;\n" 1142 "};", 1143 Style); 1144 verifyFormat("var func = doSomething(function() {\n" 1145 " return 1;\n" 1146 "});", 1147 Style); 1148 verifyFormat("var outer = function() {\n" 1149 " var inner = function() {\n" 1150 " return 1;\n" 1151 " }\n" 1152 "};", 1153 Style); 1154 verifyFormat("function outer1(a, b) {\n" 1155 " function inner1(a, b) {\n" 1156 " return a;\n" 1157 " }\n" 1158 "}", 1159 Style); 1160 1161 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty; 1162 verifyFormat("var func = function() {\n" 1163 " return 1;\n" 1164 "};", 1165 Style); 1166 } 1167 1168 TEST_F(FormatTestJS, MultipleFunctionLiterals) { 1169 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 1170 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All; 1171 verifyFormat("promise.then(\n" 1172 " function success() {\n" 1173 " doFoo();\n" 1174 " doBar();\n" 1175 " },\n" 1176 " function error() {\n" 1177 " doFoo();\n" 1178 " doBaz();\n" 1179 " },\n" 1180 " []);\n"); 1181 verifyFormat("promise.then(\n" 1182 " function success() {\n" 1183 " doFoo();\n" 1184 " doBar();\n" 1185 " },\n" 1186 " [],\n" 1187 " function error() {\n" 1188 " doFoo();\n" 1189 " doBaz();\n" 1190 " });\n"); 1191 verifyFormat("promise.then(\n" 1192 " [],\n" 1193 " function success() {\n" 1194 " doFoo();\n" 1195 " doBar();\n" 1196 " },\n" 1197 " function error() {\n" 1198 " doFoo();\n" 1199 " doBaz();\n" 1200 " });\n"); 1201 1202 verifyFormat("getSomeLongPromise()\n" 1203 " .then(function(value) { body(); })\n" 1204 " .thenCatch(function(error) {\n" 1205 " body();\n" 1206 " body();\n" 1207 " });", 1208 Style); 1209 verifyFormat("getSomeLongPromise()\n" 1210 " .then(function(value) {\n" 1211 " body();\n" 1212 " body();\n" 1213 " })\n" 1214 " .thenCatch(function(error) {\n" 1215 " body();\n" 1216 " body();\n" 1217 " });"); 1218 1219 verifyFormat("getSomeLongPromise()\n" 1220 " .then(function(value) { body(); })\n" 1221 " .thenCatch(function(error) { body(); });", 1222 Style); 1223 1224 verifyFormat("return [aaaaaaaaaaaaaaaaaaaaaa]\n" 1225 " .aaaaaaa(function() {\n" 1226 " //\n" 1227 " })\n" 1228 " .bbbbbb();"); 1229 } 1230 1231 TEST_F(FormatTestJS, ArrowFunctions) { 1232 verifyFormat("var x = (a) => {\n" 1233 " x;\n" 1234 " return a;\n" 1235 "};\n"); 1236 verifyFormat("var x = (a) => {\n" 1237 " function y() {\n" 1238 " return 42;\n" 1239 " }\n" 1240 " return a;\n" 1241 "};"); 1242 verifyFormat("var x = (a: type): {some: type} => {\n" 1243 " y;\n" 1244 " return a;\n" 1245 "};"); 1246 verifyFormat("var x = (a) => a;"); 1247 verifyFormat("return () => [];"); 1248 verifyFormat("var aaaaaaaaaaaaaaaaaaaa = {\n" 1249 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa:\n" 1250 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1251 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) =>\n" 1252 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1253 "};"); 1254 verifyFormat("var a = a.aaaaaaa(\n" 1255 " (a: a) => aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) &&\n" 1256 " aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbb));"); 1257 verifyFormat("var a = a.aaaaaaa(\n" 1258 " (a: a) => aaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) ?\n" 1259 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb) :\n" 1260 " aaaaaaaaaaaaaaaaaaaaa(bbbbbbb));"); 1261 1262 // FIXME: This is bad, we should be wrapping before "() => {". 1263 verifyFormat("someFunction(() => {\n" 1264 " doSomething(); // break\n" 1265 "})\n" 1266 " .doSomethingElse(\n" 1267 " // break\n" 1268 " );"); 1269 verifyFormat("const f = (x: string|null): string|null => {\n" 1270 " y;\n" 1271 " return x;\n" 1272 "}\n"); 1273 } 1274 1275 TEST_F(FormatTestJS, ArrowFunctionStyle) { 1276 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 1277 Style.AllowShortLambdasOnASingleLine = FormatStyle::SLS_All; 1278 verifyFormat("const arr = () => { x; };", Style); 1279 verifyFormat("const arrInlineAll = () => {};", Style); 1280 Style.AllowShortLambdasOnASingleLine = FormatStyle::SLS_None; 1281 verifyFormat("const arr = () => {\n" 1282 " x;\n" 1283 "};", 1284 Style); 1285 verifyFormat("const arrInlineNone = () => {\n" 1286 "};", 1287 Style); 1288 Style.AllowShortLambdasOnASingleLine = FormatStyle::SLS_Empty; 1289 verifyFormat("const arr = () => {\n" 1290 " x;\n" 1291 "};", 1292 Style); 1293 verifyFormat("const arrInlineEmpty = () => {};", Style); 1294 Style.AllowShortLambdasOnASingleLine = FormatStyle::SLS_Inline; 1295 verifyFormat("const arr = () => {\n" 1296 " x;\n" 1297 "};", 1298 Style); 1299 verifyFormat("foo(() => {});", Style); 1300 verifyFormat("const arrInlineInline = () => {};", Style); 1301 } 1302 1303 TEST_F(FormatTestJS, ReturnStatements) { 1304 verifyFormat("function() {\n" 1305 " return [hello, world];\n" 1306 "}"); 1307 } 1308 1309 TEST_F(FormatTestJS, ForLoops) { 1310 verifyFormat("for (var i in [2, 3]) {\n" 1311 "}"); 1312 verifyFormat("for (var i of [2, 3]) {\n" 1313 "}"); 1314 verifyFormat("for (let {a, b} of x) {\n" 1315 "}"); 1316 verifyFormat("for (let {a, b} of [x]) {\n" 1317 "}"); 1318 verifyFormat("for (let [a, b] of [x]) {\n" 1319 "}"); 1320 verifyFormat("for (let {a, b} in x) {\n" 1321 "}"); 1322 } 1323 1324 TEST_F(FormatTestJS, WrapRespectsAutomaticSemicolonInsertion) { 1325 // The following statements must not wrap, as otherwise the program meaning 1326 // would change due to automatic semicolon insertion. 1327 // See http://www.ecma-international.org/ecma-262/5.1/#sec-7.9.1. 1328 verifyFormat("return aaaaa;", getGoogleJSStyleWithColumns(10)); 1329 verifyFormat("yield aaaaa;", getGoogleJSStyleWithColumns(10)); 1330 verifyFormat("return /* hello! */ aaaaa;", getGoogleJSStyleWithColumns(10)); 1331 verifyFormat("continue aaaaa;", getGoogleJSStyleWithColumns(10)); 1332 verifyFormat("continue /* hello! */ aaaaa;", getGoogleJSStyleWithColumns(10)); 1333 verifyFormat("break aaaaa;", getGoogleJSStyleWithColumns(10)); 1334 verifyFormat("throw aaaaa;", getGoogleJSStyleWithColumns(10)); 1335 verifyFormat("aaaaaaaaa++;", getGoogleJSStyleWithColumns(10)); 1336 verifyFormat("aaaaaaaaa--;", getGoogleJSStyleWithColumns(10)); 1337 verifyFormat("return [\n" 1338 " aaa\n" 1339 "];", 1340 getGoogleJSStyleWithColumns(12)); 1341 verifyFormat("class X {\n" 1342 " readonly ratherLongField =\n" 1343 " 1;\n" 1344 "}", 1345 "class X {\n" 1346 " readonly ratherLongField = 1;\n" 1347 "}", 1348 getGoogleJSStyleWithColumns(20)); 1349 verifyFormat("const x = (5 + 9)\n" 1350 "const y = 3\n", 1351 "const x = ( 5 + 9)\n" 1352 "const y = 3\n"); 1353 // Ideally the foo() bit should be indented relative to the async function(). 1354 verifyFormat("async function\n" 1355 "foo() {}", 1356 getGoogleJSStyleWithColumns(10)); 1357 verifyFormat("await theReckoning;", getGoogleJSStyleWithColumns(10)); 1358 verifyFormat("some['a']['b']", getGoogleJSStyleWithColumns(10)); 1359 verifyFormat("x = (a['a']\n" 1360 " ['b']);", 1361 getGoogleJSStyleWithColumns(10)); 1362 verifyFormat("function f() {\n" 1363 " return foo.bar(\n" 1364 " (param): param is {\n" 1365 " a: SomeType\n" 1366 " }&ABC => 1)\n" 1367 "}", 1368 getGoogleJSStyleWithColumns(25)); 1369 } 1370 1371 TEST_F(FormatTestJS, AddsIsTheDictKeyOnNewline) { 1372 // Do not confuse is, the dict key with is, the type matcher. Put is, the dict 1373 // key, on a newline. 1374 verifyFormat("Polymer({\n" 1375 " is: '', //\n" 1376 " rest: 1\n" 1377 "});", 1378 getGoogleJSStyleWithColumns(20)); 1379 } 1380 1381 TEST_F(FormatTestJS, AutomaticSemicolonInsertionHeuristic) { 1382 verifyFormat("a\n" 1383 "b;", 1384 " a \n" 1385 " b ;"); 1386 verifyFormat("a()\n" 1387 "b;", 1388 " a ()\n" 1389 " b ;"); 1390 verifyFormat("a[b]\n" 1391 "c;", 1392 "a [b]\n" 1393 "c ;"); 1394 verifyFormat("1\n" 1395 "a;", 1396 "1 \n" 1397 "a ;"); 1398 verifyFormat("a\n" 1399 "1;", 1400 "a \n" 1401 "1 ;"); 1402 verifyFormat("a\n" 1403 "'x';", 1404 "a \n" 1405 " 'x';"); 1406 verifyFormat("a++\n" 1407 "b;", 1408 "a ++\n" 1409 "b ;"); 1410 verifyFormat("a\n" 1411 "!b && c;", 1412 "a \n" 1413 " ! b && c;"); 1414 verifyFormat("a\n" 1415 "if (1) f();", 1416 " a\n" 1417 " if (1) f();"); 1418 verifyFormat("a\n" 1419 "class X {}", 1420 " a\n" 1421 " class X {}"); 1422 verifyFormat("var a", "var\n" 1423 "a"); 1424 verifyFormat("x instanceof String", "x\n" 1425 "instanceof\n" 1426 "String"); 1427 verifyFormat("function f(@Foo bar) {}", "function f(@Foo\n" 1428 " bar) {}"); 1429 verifyFormat("function f(@Foo(Param) bar) {}", "function f(@Foo(Param)\n" 1430 " bar) {}"); 1431 verifyFormat("a = true\n" 1432 "return 1", 1433 "a = true\n" 1434 " return 1"); 1435 verifyFormat("a = 's'\n" 1436 "return 1", 1437 "a = 's'\n" 1438 " return 1"); 1439 verifyFormat("a = null\n" 1440 "return 1", 1441 "a = null\n" 1442 " return 1"); 1443 // Below "class Y {}" should ideally be on its own line. 1444 verifyFormat("x = {\n" 1445 " a: 1\n" 1446 "} class Y {}", 1447 " x = {a : 1}\n" 1448 " class Y { }"); 1449 verifyFormat("if (x) {\n" 1450 "}\n" 1451 "return 1", 1452 "if (x) {}\n" 1453 " return 1"); 1454 verifyFormat("if (x) {\n" 1455 "}\n" 1456 "class X {}", 1457 "if (x) {}\n" 1458 " class X {}"); 1459 } 1460 1461 TEST_F(FormatTestJS, ImportExportASI) { 1462 verifyFormat("import {x} from 'y'\n" 1463 "export function z() {}", 1464 "import {x} from 'y'\n" 1465 " export function z() {}"); 1466 // Below "class Y {}" should ideally be on its own line. 1467 verifyFormat("export {x} class Y {}", " export {x}\n" 1468 " class Y {\n}"); 1469 verifyFormat("if (x) {\n" 1470 "}\n" 1471 "export class Y {}", 1472 "if ( x ) { }\n" 1473 " export class Y {}"); 1474 } 1475 1476 TEST_F(FormatTestJS, ImportExportType) { 1477 verifyFormat("import type {x, y} from 'y';\n" 1478 "import type * as x from 'y';\n" 1479 "import type x from 'y';\n" 1480 "import {x, type yu, z} from 'y';\n"); 1481 verifyFormat("export type {x, y} from 'y';\n" 1482 "export {x, type yu, z} from 'y';\n" 1483 "export type {x, y};\n" 1484 "export {x, type yu, z};\n"); 1485 } 1486 1487 TEST_F(FormatTestJS, ClosureStyleCasts) { 1488 verifyFormat("var x = /** @type {foo} */ (bar);"); 1489 } 1490 1491 TEST_F(FormatTestJS, TryCatch) { 1492 verifyFormat("try {\n" 1493 " f();\n" 1494 "} catch (e) {\n" 1495 " g();\n" 1496 "} finally {\n" 1497 " h();\n" 1498 "}"); 1499 1500 // But, of course, "catch" is a perfectly fine function name in JavaScript. 1501 verifyFormat("someObject.catch();"); 1502 verifyFormat("someObject.new();"); 1503 } 1504 1505 TEST_F(FormatTestJS, StringLiteralConcatenation) { 1506 verifyFormat("var literal = 'hello ' +\n" 1507 " 'world';"); 1508 } 1509 1510 TEST_F(FormatTestJS, RegexLiteralClassification) { 1511 // Regex literals. 1512 verifyFormat("var regex = /abc/;"); 1513 verifyFormat("f(/abc/);"); 1514 verifyFormat("f(abc, /abc/);"); 1515 verifyFormat("some_map[/abc/];"); 1516 verifyFormat("var x = a ? /abc/ : /abc/;"); 1517 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}"); 1518 verifyFormat("var x = !/abc/.test(y);"); 1519 verifyFormat("var x = foo()! / 10;"); 1520 verifyFormat("var x = a && /abc/.test(y);"); 1521 verifyFormat("var x = a || /abc/.test(y);"); 1522 verifyFormat("var x = a + /abc/.search(y);"); 1523 verifyFormat("/abc/.search(y);"); 1524 verifyFormat("var regexs = {/abc/, /abc/};"); 1525 verifyFormat("return /abc/;"); 1526 1527 // Not regex literals. 1528 verifyFormat("var a = a / 2 + b / 3;"); 1529 verifyFormat("var a = a++ / 2;"); 1530 // Prefix unary can operate on regex literals, not that it makes sense. 1531 verifyFormat("var a = ++/a/;"); 1532 1533 // This is a known issue, regular expressions are incorrectly detected if 1534 // directly following a closing parenthesis. 1535 verifyFormat("if (foo) / bar /.exec(baz);"); 1536 } 1537 1538 TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) { 1539 verifyFormat("var regex = /=/;"); 1540 verifyFormat("var regex = /a*/;"); 1541 verifyFormat("var regex = /a+/;"); 1542 verifyFormat("var regex = /a?/;"); 1543 verifyFormat("var regex = /.a./;"); 1544 verifyFormat("var regex = /a\\*/;"); 1545 verifyFormat("var regex = /^a$/;"); 1546 verifyFormat("var regex = /\\/a/;"); 1547 verifyFormat("var regex = /(?:x)/;"); 1548 verifyFormat("var regex = /x(?=y)/;"); 1549 verifyFormat("var regex = /x(?!y)/;"); 1550 verifyFormat("var regex = /x|y/;"); 1551 verifyFormat("var regex = /a{2}/;"); 1552 verifyFormat("var regex = /a{1,3}/;"); 1553 1554 verifyFormat("var regex = /[abc]/;"); 1555 verifyFormat("var regex = /[^abc]/;"); 1556 verifyFormat("var regex = /[\\b]/;"); 1557 verifyFormat("var regex = /[/]/;"); 1558 verifyFormat("var regex = /[\\/]/;"); 1559 verifyFormat("var regex = /\\[/;"); 1560 verifyFormat("var regex = /\\\\[/]/;"); 1561 verifyFormat("var regex = /}[\"]/;"); 1562 verifyFormat("var regex = /}[/\"]/;"); 1563 verifyFormat("var regex = /}[\"/]/;"); 1564 1565 verifyFormat("var regex = /\\b/;"); 1566 verifyFormat("var regex = /\\B/;"); 1567 verifyFormat("var regex = /\\d/;"); 1568 verifyFormat("var regex = /\\D/;"); 1569 verifyFormat("var regex = /\\f/;"); 1570 verifyFormat("var regex = /\\n/;"); 1571 verifyFormat("var regex = /\\r/;"); 1572 verifyFormat("var regex = /\\s/;"); 1573 verifyFormat("var regex = /\\S/;"); 1574 verifyFormat("var regex = /\\t/;"); 1575 verifyFormat("var regex = /\\v/;"); 1576 verifyFormat("var regex = /\\w/;"); 1577 verifyFormat("var regex = /\\W/;"); 1578 verifyFormat("var regex = /a(a)\\1/;"); 1579 verifyFormat("var regex = /\\0/;"); 1580 verifyFormat("var regex = /\\\\/g;"); 1581 verifyFormat("var regex = /\\a\\\\/g;"); 1582 verifyFormat("var regex = /\a\\//g;"); 1583 verifyFormat("var regex = /a\\//;\n" 1584 "var x = 0;"); 1585 verifyFormat("var regex = /'/g;", "var regex = /'/g ;"); 1586 verifyFormat("var regex = /'/g; //'", "var regex = /'/g ; //'"); 1587 verifyFormat("var regex = /\\/*/;\n" 1588 "var x = 0;", 1589 "var regex = /\\/*/;\n" 1590 "var x=0;"); 1591 verifyFormat("var x = /a\\//;", "var x = /a\\// \n;"); 1592 verifyFormat("var regex = /\"/;", getGoogleJSStyleWithColumns(16)); 1593 verifyFormat("var regex =\n" 1594 " /\"/;", 1595 getGoogleJSStyleWithColumns(15)); 1596 verifyFormat("var regex = //\n" 1597 " /a/;"); 1598 verifyFormat("var regexs = [\n" 1599 " /d/, //\n" 1600 " /aa/, //\n" 1601 "];"); 1602 } 1603 1604 TEST_F(FormatTestJS, RegexLiteralModifiers) { 1605 verifyFormat("var regex = /abc/g;"); 1606 verifyFormat("var regex = /abc/i;"); 1607 verifyFormat("var regex = /abc/m;"); 1608 verifyFormat("var regex = /abc/y;"); 1609 } 1610 1611 TEST_F(FormatTestJS, RegexLiteralLength) { 1612 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 1613 getGoogleJSStyleWithColumns(60)); 1614 verifyFormat("var regex =\n" 1615 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 1616 getGoogleJSStyleWithColumns(60)); 1617 verifyFormat("var regex = /\\xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 1618 getGoogleJSStyleWithColumns(50)); 1619 } 1620 1621 TEST_F(FormatTestJS, RegexLiteralExamples) { 1622 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);"); 1623 } 1624 1625 TEST_F(FormatTestJS, IgnoresMpegTS) { 1626 std::string MpegTS(200, ' '); 1627 MpegTS.replace(0, strlen("nearlyLooks + like + ts + code; "), 1628 "nearlyLooks + like + ts + code; "); 1629 MpegTS[0] = 0x47; 1630 MpegTS[188] = 0x47; 1631 verifyFormat(MpegTS, MpegTS); 1632 } 1633 1634 TEST_F(FormatTestJS, TypeAnnotations) { 1635 verifyFormat("var x: string;"); 1636 verifyFormat("var x: {a: string; b: number;} = {};"); 1637 verifyFormat("function x(): string {\n return 'x';\n}"); 1638 verifyFormat("function x(): {x: string} {\n return {x: 'x'};\n}"); 1639 verifyFormat("function x(y: string): string {\n return 'x';\n}"); 1640 verifyFormat("for (var y: string in x) {\n x();\n}"); 1641 verifyFormat("for (var y: string of x) {\n x();\n}"); 1642 verifyFormat("function x(y: {a?: number;} = {}): number {\n" 1643 " return 12;\n" 1644 "}"); 1645 verifyFormat("const x: Array<{a: number; b: string;}> = [];"); 1646 verifyFormat("((a: string, b: number): string => a + b);"); 1647 verifyFormat("var x: (y: number) => string;"); 1648 verifyFormat("var x: P<string, (a: number) => string>;"); 1649 verifyFormat("var x = {\n" 1650 " y: function(): z {\n" 1651 " return 1;\n" 1652 " }\n" 1653 "};"); 1654 verifyFormat("var x = {\n" 1655 " y: function(): {a: number} {\n" 1656 " return 1;\n" 1657 " }\n" 1658 "};"); 1659 verifyFormat("function someFunc(args: string[]):\n" 1660 " {longReturnValue: string[]} {}", 1661 getGoogleJSStyleWithColumns(60)); 1662 verifyFormat( 1663 "var someValue = (v as aaaaaaaaaaaaaaaaaaaa<T>[])\n" 1664 " .someFunction(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 1665 verifyFormat("const xIsALongIdent:\n" 1666 " YJustBarelyFitsLinex[];", 1667 getGoogleJSStyleWithColumns(20)); 1668 verifyFormat("const x = {\n" 1669 " y: 1\n" 1670 "} as const;"); 1671 } 1672 1673 TEST_F(FormatTestJS, UnionIntersectionTypes) { 1674 verifyFormat("let x: A|B = A | B;"); 1675 verifyFormat("let x: A&B|C = A & B;"); 1676 verifyFormat("let x: Foo<A|B> = new Foo<A|B>();"); 1677 verifyFormat("function(x: A|B): C&D {}"); 1678 verifyFormat("function(x: A|B = A | B): C&D {}"); 1679 verifyFormat("function x(path: number|string) {}"); 1680 verifyFormat("function x(): string|number {}"); 1681 verifyFormat("type Foo = Bar|Baz;"); 1682 verifyFormat("type Foo = Bar<X>|Baz;"); 1683 verifyFormat("type Foo = (Bar<X>|Baz);"); 1684 verifyFormat("let x: Bar|Baz;"); 1685 verifyFormat("let x: Bar<X>|Baz;"); 1686 verifyFormat("let x: (Foo|Bar)[];"); 1687 verifyFormat("type X = {\n" 1688 " a: Foo|Bar;\n" 1689 "};"); 1690 verifyFormat("export type X = {\n" 1691 " a: Foo|Bar;\n" 1692 "};"); 1693 } 1694 1695 TEST_F(FormatTestJS, UnionIntersectionTypesInObjectType) { 1696 verifyFormat("let x: {x: number|null} = {x: number | null};"); 1697 verifyFormat("let nested: {x: {y: number|null}};"); 1698 verifyFormat("let mixed: {x: [number|null, {w: number}]};"); 1699 verifyFormat("class X {\n" 1700 " contructor(x: {\n" 1701 " a: a|null,\n" 1702 " b: b|null,\n" 1703 " }) {}\n" 1704 "}"); 1705 } 1706 1707 TEST_F(FormatTestJS, ClassDeclarations) { 1708 verifyFormat("class C {\n x: string = 12;\n}"); 1709 verifyFormat("class C {\n x(): string => 12;\n}"); 1710 verifyFormat("class C {\n ['x' + 2]: string = 12;\n}"); 1711 verifyFormat("class C {\n" 1712 " foo() {}\n" 1713 " [bar]() {}\n" 1714 "}\n"); 1715 verifyFormat("class C {\n private x: string = 12;\n}"); 1716 verifyFormat("class C {\n private static x: string = 12;\n}"); 1717 verifyFormat("class C {\n static x(): string {\n return 'asd';\n }\n}"); 1718 verifyFormat("class C extends P implements I {}"); 1719 verifyFormat("class C extends p.P implements i.I {}"); 1720 verifyFormat("x(class {\n" 1721 " a(): A {}\n" 1722 "});"); 1723 verifyFormat("class Test {\n" 1724 " aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaaa):\n" 1725 " aaaaaaaaaaaaaaaaaaaaaa {}\n" 1726 "}"); 1727 verifyFormat("foo = class Name {\n" 1728 " constructor() {}\n" 1729 "};"); 1730 verifyFormat("foo = class {\n" 1731 " constructor() {}\n" 1732 "};"); 1733 verifyFormat("class C {\n" 1734 " x: {y: Z;} = {};\n" 1735 " private y: {y: Z;} = {};\n" 1736 "}"); 1737 1738 // ':' is not a type declaration here. 1739 verifyFormat("class X {\n" 1740 " subs = {\n" 1741 " 'b': {\n" 1742 " 'c': 1,\n" 1743 " },\n" 1744 " };\n" 1745 "}"); 1746 verifyFormat("@Component({\n" 1747 " moduleId: module.id,\n" 1748 "})\n" 1749 "class SessionListComponent implements OnDestroy, OnInit {\n" 1750 "}"); 1751 } 1752 1753 TEST_F(FormatTestJS, StrictPropInitWrap) { 1754 const FormatStyle &Style = getGoogleJSStyleWithColumns(22); 1755 verifyFormat("class X {\n" 1756 " strictPropInitField!:\n" 1757 " string;\n" 1758 "}", 1759 Style); 1760 } 1761 1762 TEST_F(FormatTestJS, InterfaceDeclarations) { 1763 verifyFormat("interface I {\n" 1764 " x: string;\n" 1765 " enum: string[];\n" 1766 " enum?: string[];\n" 1767 "}\n" 1768 "var y;"); 1769 // Ensure that state is reset after parsing the interface. 1770 verifyFormat("interface a {}\n" 1771 "export function b() {}\n" 1772 "var x;"); 1773 1774 // Arrays of object type literals. 1775 verifyFormat("interface I {\n" 1776 " o: {}[];\n" 1777 "}"); 1778 } 1779 1780 TEST_F(FormatTestJS, ObjectTypesInExtendsImplements) { 1781 verifyFormat("class C extends {} {}"); 1782 verifyFormat("class C implements {bar: number} {}"); 1783 // Somewhat odd, but probably closest to reasonable formatting? 1784 verifyFormat("class C implements {\n" 1785 " bar: number,\n" 1786 " baz: string,\n" 1787 "} {}"); 1788 verifyFormat("class C<P extends {}> {}"); 1789 } 1790 1791 TEST_F(FormatTestJS, EnumDeclarations) { 1792 verifyFormat("enum Foo {\n" 1793 " A = 1,\n" 1794 " B\n" 1795 "}"); 1796 verifyFormat("export /* somecomment*/ enum Foo {\n" 1797 " A = 1,\n" 1798 " B\n" 1799 "}"); 1800 verifyFormat("enum Foo {\n" 1801 " A = 1, // comment\n" 1802 " B\n" 1803 "}\n" 1804 "var x = 1;"); 1805 verifyFormat("const enum Foo {\n" 1806 " A = 1,\n" 1807 " B\n" 1808 "}"); 1809 verifyFormat("export const enum Foo {\n" 1810 " A = 1,\n" 1811 " B\n" 1812 "}"); 1813 } 1814 1815 TEST_F(FormatTestJS, Decorators) { 1816 verifyFormat("@A\nclass C {\n}"); 1817 verifyFormat("@A({arg: 'value'})\nclass C {\n}"); 1818 verifyFormat("@A\n@B\nclass C {\n}"); 1819 verifyFormat("class C {\n @A x: string;\n}"); 1820 verifyFormat("class C {\n" 1821 " @A\n" 1822 " private x(): string {\n" 1823 " return 'y';\n" 1824 " }\n" 1825 "}"); 1826 verifyFormat("class C {\n" 1827 " private x(@A x: string) {}\n" 1828 "}"); 1829 verifyFormat("class X {}\n" 1830 "class Y {}"); 1831 verifyFormat("class X {\n" 1832 " @property() private isReply = false;\n" 1833 "}\n"); 1834 } 1835 1836 TEST_F(FormatTestJS, TypeAliases) { 1837 verifyFormat("type X = number;\n" 1838 "class C {}"); 1839 verifyFormat("type X<Y> = Z<Y>;"); 1840 verifyFormat("type X = {\n" 1841 " y: number\n" 1842 "};\n" 1843 "class C {}"); 1844 verifyFormat("export type X = {\n" 1845 " a: string,\n" 1846 " b?: string,\n" 1847 "};\n"); 1848 } 1849 1850 TEST_F(FormatTestJS, TypeInterfaceLineWrapping) { 1851 const FormatStyle &Style = getGoogleJSStyleWithColumns(20); 1852 verifyFormat("type LongTypeIsReallyUnreasonablyLong =\n" 1853 " string;\n", 1854 "type LongTypeIsReallyUnreasonablyLong = string;\n", Style); 1855 verifyFormat("interface AbstractStrategyFactoryProvider {\n" 1856 " a: number\n" 1857 "}\n", 1858 "interface AbstractStrategyFactoryProvider { a: number }\n", 1859 Style); 1860 } 1861 1862 TEST_F(FormatTestJS, RemoveEmptyLinesInArrowFunctions) { 1863 verifyFormat("x = () => {\n" 1864 " foo();\n" 1865 " bar();\n" 1866 "};\n", 1867 "x = () => {\n" 1868 "\n" 1869 " foo();\n" 1870 " bar();\n" 1871 "\n" 1872 "};\n"); 1873 } 1874 1875 TEST_F(FormatTestJS, Modules) { 1876 verifyFormat("import SomeThing from 'some/module.js';"); 1877 verifyFormat("import {X, Y} from 'some/module.js';"); 1878 verifyFormat("import a, {X, Y} from 'some/module.js';"); 1879 verifyFormat("import {X, Y,} from 'some/module.js';"); 1880 verifyFormat("import {X as myLocalX, Y as myLocalY} from 'some/module.js';"); 1881 // Ensure Automatic Semicolon Insertion does not break on "as\n". 1882 verifyFormat("import {X as myX} from 'm';", "import {X as\n" 1883 " myX} from 'm';"); 1884 verifyFormat("import * as lib from 'some/module.js';"); 1885 verifyFormat("var x = {import: 1};\nx.import = 2;"); 1886 // Ensure an import statement inside a block is at the correct level. 1887 verifyFormat("function() {\n" 1888 " var x;\n" 1889 " import 'some/module.js';\n" 1890 "}"); 1891 1892 verifyFormat("export function fn() {\n" 1893 " return 'fn';\n" 1894 "}"); 1895 verifyFormat("export function A() {}\n" 1896 "export default function B() {}\n" 1897 "export function C() {}"); 1898 verifyFormat("export default () => {\n" 1899 " let x = 1;\n" 1900 " return x;\n" 1901 "}"); 1902 verifyFormat("export const x = 12;"); 1903 verifyFormat("export default class X {}"); 1904 verifyFormat("export {X, Y} from 'some/module.js';"); 1905 verifyFormat("export {X, Y,} from 'some/module.js';"); 1906 verifyFormat("export {SomeVeryLongExport as X, " 1907 "SomeOtherVeryLongExport as Y} from 'some/module.js';"); 1908 // export without 'from' is wrapped. 1909 verifyFormat("export let someRatherLongVariableName =\n" 1910 " someSurprisinglyLongVariable + someOtherRatherLongVar;"); 1911 // ... but not if from is just an identifier. 1912 verifyFormat("export {\n" 1913 " from as from,\n" 1914 " someSurprisinglyLongVariable as\n" 1915 " from\n" 1916 "};", 1917 getGoogleJSStyleWithColumns(20)); 1918 verifyFormat("export class C {\n" 1919 " x: number;\n" 1920 " y: string;\n" 1921 "}"); 1922 verifyFormat("export class X {\n" 1923 " y: number;\n" 1924 "}"); 1925 verifyFormat("export abstract class X {\n" 1926 " y: number;\n" 1927 "}"); 1928 verifyFormat("export default class X {\n" 1929 " y: number\n" 1930 "}"); 1931 verifyFormat("export default function() {\n return 1;\n}"); 1932 verifyFormat("export var x = 12;"); 1933 verifyFormat("class C {}\n" 1934 "export function f() {}\n" 1935 "var v;"); 1936 verifyFormat("export var x: number = 12;"); 1937 verifyFormat("export const y = {\n" 1938 " a: 1,\n" 1939 " b: 2\n" 1940 "};"); 1941 verifyFormat("export enum Foo {\n" 1942 " BAR,\n" 1943 " // adsdasd\n" 1944 " BAZ\n" 1945 "}"); 1946 verifyFormat("export default [\n" 1947 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1948 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n" 1949 "];"); 1950 verifyFormat("export default [];"); 1951 verifyFormat("export default () => {};"); 1952 verifyFormat("export default () => {\n" 1953 " x;\n" 1954 " x;\n" 1955 "};"); 1956 verifyFormat("export interface Foo {\n" 1957 " foo: number;\n" 1958 "}\n" 1959 "export class Bar {\n" 1960 " blah(): string {\n" 1961 " return this.blah;\n" 1962 " };\n" 1963 "}"); 1964 } 1965 1966 TEST_F(FormatTestJS, ImportWrapping) { 1967 verifyFormat("import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying," 1968 " VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying" 1969 "} from 'some/module.js';"); 1970 FormatStyle Style = getGoogleJSStyleWithColumns(80); 1971 Style.JavaScriptWrapImports = true; 1972 verifyFormat("import {\n" 1973 " VeryLongImportsAreAnnoying,\n" 1974 " VeryLongImportsAreAnnoying,\n" 1975 " VeryLongImportsAreAnnoying,\n" 1976 "} from 'some/module.js';", 1977 Style); 1978 verifyFormat("import {\n" 1979 " A,\n" 1980 " A,\n" 1981 "} from 'some/module.js';", 1982 Style); 1983 verifyFormat("export {\n" 1984 " A,\n" 1985 " A,\n" 1986 "} from 'some/module.js';", 1987 Style); 1988 Style.ColumnLimit = 40; 1989 // Using this version of verifyFormat because test::messUp hides the issue. 1990 verifyFormat("import {\n" 1991 " A,\n" 1992 "} from\n" 1993 " 'some/path/longer/than/column/limit/module.js';", 1994 " import { \n" 1995 " A, \n" 1996 " } from\n" 1997 " 'some/path/longer/than/column/limit/module.js' ; ", 1998 Style); 1999 } 2000 2001 TEST_F(FormatTestJS, TemplateStrings) { 2002 // Keeps any whitespace/indentation within the template string. 2003 verifyFormat("var x = `hello\n" 2004 " ${name}\n" 2005 " !`;", 2006 "var x = `hello\n" 2007 " ${ name }\n" 2008 " !`;"); 2009 2010 verifyFormat("var x =\n" 2011 " `hello ${world}` >= some();", 2012 getGoogleJSStyleWithColumns(34)); // Barely doesn't fit. 2013 verifyFormat("var x = `hello ${world}` >= some();", 2014 getGoogleJSStyleWithColumns(35)); // Barely fits. 2015 verifyFormat("var x = `hellö ${wörld}` >= söme();", 2016 getGoogleJSStyleWithColumns(35)); // Fits due to UTF-8. 2017 verifyFormat("var x = `hello\n" 2018 " ${world}` >=\n" 2019 " some();", 2020 "var x =\n" 2021 " `hello\n" 2022 " ${world}` >= some();", 2023 getGoogleJSStyleWithColumns(21)); // Barely doesn't fit. 2024 verifyFormat("var x = `hello\n" 2025 " ${world}` >= some();", 2026 "var x =\n" 2027 " `hello\n" 2028 " ${world}` >= some();", 2029 getGoogleJSStyleWithColumns(22)); // Barely fits. 2030 2031 verifyFormat("var x =\n" 2032 " `h`;", 2033 getGoogleJSStyleWithColumns(11)); 2034 verifyFormat("var x =\n `multi\n line`;", "var x = `multi\n line`;", 2035 getGoogleJSStyleWithColumns(13)); 2036 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2037 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`);"); 2038 // Repro for an obscure width-miscounting issue with template strings. 2039 verifyFormat( 2040 "someLongVariable =\n" 2041 " " 2042 "`${logPrefix[11]}/${logPrefix[12]}/${logPrefix[13]}${logPrefix[14]}`;", 2043 "someLongVariable = " 2044 "`${logPrefix[11]}/${logPrefix[12]}/${logPrefix[13]}${logPrefix[14]}`;"); 2045 2046 // Make sure template strings get a proper ColumnWidth assigned, even if they 2047 // are first token in line. 2048 verifyFormat("var a = aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 2049 " `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`;"); 2050 2051 // Two template strings. 2052 verifyFormat("var x = `hello` == `hello`;"); 2053 2054 // Comments in template strings. 2055 verifyFormat("var x = `//a`;\n" 2056 "var y;", 2057 "var x =\n `//a`;\n" 2058 "var y ;"); 2059 verifyFormat("var x = `/*a`;\n" 2060 "var y;", 2061 "var x =\n `/*a`;\n" 2062 "var y;"); 2063 // Unterminated string literals in a template string. 2064 verifyFormat("var x = `'`; // comment with matching quote '\n" 2065 "var y;"); 2066 verifyFormat("var x = `\"`; // comment with matching quote \"\n" 2067 "var y;"); 2068 verifyFormat("it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa);", 2069 "it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa) ;", 2070 getGoogleJSStyleWithColumns(40)); 2071 // Backticks in a comment - not a template string. 2072 verifyFormat("var x = 1 // `/*a`;\n" 2073 " ;", 2074 "var x =\n 1 // `/*a`;\n" 2075 " ;"); 2076 verifyFormat("/* ` */ var x = 1; /* ` */", "/* ` */ var x\n= 1; /* ` */"); 2077 // Comment spans multiple template strings. 2078 verifyFormat("var x = `/*a`;\n" 2079 "var y = ` */ `;", 2080 "var x =\n `/*a`;\n" 2081 "var y =\n ` */ `;"); 2082 // Escaped backtick. 2083 verifyFormat("var x = ` \\` a`;\n" 2084 "var y;", 2085 "var x = ` \\` a`;\n" 2086 "var y;"); 2087 // Escaped dollar. 2088 verifyFormat("var x = ` \\${foo}`;\n"); 2089 2090 // The token stream can contain two string_literals in sequence, but that 2091 // doesn't mean that they are implicitly concatenated in JavaScript. 2092 verifyFormat("var f = `aaaa ${a ? 'a' : 'b'}`;"); 2093 2094 // Ensure that scopes are appropriately set around evaluated expressions in 2095 // template strings. 2096 verifyFormat("var f = `aaaaaaaaaaaaa:${aaaaaaa.aaaaa} aaaaaaaa\n" 2097 " aaaaaaaaaaaaa:${aaaaaaa.aaaaa} aaaaaaaa`;", 2098 "var f = `aaaaaaaaaaaaa:${aaaaaaa. aaaaa} aaaaaaaa\n" 2099 " aaaaaaaaaaaaa:${ aaaaaaa. aaaaa} aaaaaaaa`;"); 2100 verifyFormat("var x = someFunction(`${})`) //\n" 2101 " .oooooooooooooooooon();"); 2102 verifyFormat("var x = someFunction(`${aaaa}${\n" 2103 " aaaaa( //\n" 2104 " aaaaa)})`);"); 2105 } 2106 2107 TEST_F(FormatTestJS, TemplateStringMultiLineExpression) { 2108 verifyFormat("var f = `aaaaaaaaaaaaaaaaaa: ${\n" 2109 " aaaaa + //\n" 2110 " bbbb}`;", 2111 "var f = `aaaaaaaaaaaaaaaaaa: ${aaaaa + //\n" 2112 " bbbb}`;"); 2113 verifyFormat("var f = `\n" 2114 " aaaaaaaaaaaaaaaaaa: ${\n" 2115 " aaaaa + //\n" 2116 " bbbb}`;", 2117 "var f = `\n" 2118 " aaaaaaaaaaaaaaaaaa: ${ aaaaa + //\n" 2119 " bbbb }`;"); 2120 verifyFormat("var f = `\n" 2121 " aaaaaaaaaaaaaaaaaa: ${\n" 2122 " someFunction(\n" 2123 " aaaaa + //\n" 2124 " bbbb)}`;", 2125 "var f = `\n" 2126 " aaaaaaaaaaaaaaaaaa: ${someFunction (\n" 2127 " aaaaa + //\n" 2128 " bbbb)}`;"); 2129 2130 // It might be preferable to wrap before "someFunction". 2131 verifyFormat("var f = `\n" 2132 " aaaaaaaaaaaaaaaaaa: ${someFunction({\n" 2133 " aaaa: aaaaa,\n" 2134 " bbbb: bbbbb,\n" 2135 "})}`;", 2136 "var f = `\n" 2137 " aaaaaaaaaaaaaaaaaa: ${someFunction ({\n" 2138 " aaaa: aaaaa,\n" 2139 " bbbb: bbbbb,\n" 2140 " })}`;"); 2141 } 2142 2143 TEST_F(FormatTestJS, TemplateStringASI) { 2144 verifyFormat("var x = `hello${world}`;", "var x = `hello${\n" 2145 " world\n" 2146 "}`;"); 2147 } 2148 2149 TEST_F(FormatTestJS, NestedTemplateStrings) { 2150 verifyFormat( 2151 "var x = `<ul>${xs.map(x => `<li>${x}</li>`).join('\\n')}</ul>`;"); 2152 verifyFormat("var x = `he${({text: 'll'}.text)}o`;"); 2153 2154 // Crashed at some point. 2155 verifyFormat("}"); 2156 verifyFormat("`"); 2157 // FIXME: still crashing? 2158 // verifyFormat("`\\"); 2159 } 2160 2161 TEST_F(FormatTestJS, TaggedTemplateStrings) { 2162 verifyFormat("var x = html`<ul>`;"); 2163 verifyFormat("yield `hello`;"); 2164 verifyFormat("var f = {\n" 2165 " param: longTagName`This is a ${\n" 2166 " 'really'} long line`\n" 2167 "};", 2168 "var f = {param: longTagName`This is a ${'really'} long line`};", 2169 getGoogleJSStyleWithColumns(40)); 2170 } 2171 2172 TEST_F(FormatTestJS, CastSyntax) { 2173 verifyFormat("var x = <type>foo;"); 2174 verifyFormat("var x = foo as type;"); 2175 verifyFormat("let x = (a + b) as\n" 2176 " LongTypeIsLong;", 2177 getGoogleJSStyleWithColumns(20)); 2178 verifyFormat("foo = <Bar[]>[\n" 2179 " 1, //\n" 2180 " 2\n" 2181 "];"); 2182 verifyFormat("var x = [{x: 1} as type];"); 2183 verifyFormat("x = x as [a, b];"); 2184 verifyFormat("x = x as {a: string};"); 2185 verifyFormat("x = x as (string);"); 2186 verifyFormat("x = x! as (string);"); 2187 verifyFormat("x = y! in z;"); 2188 verifyFormat("var x = something.someFunction() as\n" 2189 " something;", 2190 getGoogleJSStyleWithColumns(40)); 2191 } 2192 2193 TEST_F(FormatTestJS, TypeArguments) { 2194 verifyFormat("class X<Y> {}"); 2195 verifyFormat("new X<Y>();"); 2196 verifyFormat("foo<Y>(a);"); 2197 verifyFormat("var x: X<Y>[];"); 2198 verifyFormat("class C extends D<E> implements F<G>, H<I> {}"); 2199 verifyFormat("function f(a: List<any> = null) {}"); 2200 verifyFormat("function f(): List<any> {}"); 2201 verifyFormat("function aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa():\n" 2202 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb {}"); 2203 verifyFormat("function aaaaaaaaaa(\n" 2204 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa,\n" 2205 " aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa):\n" 2206 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa {}"); 2207 } 2208 2209 TEST_F(FormatTestJS, UserDefinedTypeGuards) { 2210 verifyFormat( 2211 "function foo(check: Object):\n" 2212 " check is {foo: string, bar: string, baz: string, foobar: string} {\n" 2213 " return 'bar' in check;\n" 2214 "}\n"); 2215 } 2216 2217 TEST_F(FormatTestJS, OptionalTypes) { 2218 verifyFormat("function x(a?: b, c?, d?) {}"); 2219 verifyFormat("class X {\n" 2220 " y?: z;\n" 2221 " z?;\n" 2222 "}"); 2223 verifyFormat("interface X {\n" 2224 " y?(): z;\n" 2225 "}"); 2226 verifyFormat("constructor({aa}: {\n" 2227 " aa?: string,\n" 2228 " aaaaaaaa?: string,\n" 2229 " aaaaaaaaaaaaaaa?: boolean,\n" 2230 " aaaaaa?: List<string>\n" 2231 "}) {}"); 2232 verifyFormat("type X = [y?];"); 2233 } 2234 2235 TEST_F(FormatTestJS, IndexSignature) { 2236 verifyFormat("var x: {[k: string]: v};"); 2237 } 2238 2239 TEST_F(FormatTestJS, WrapAfterParen) { 2240 verifyFormat("xxxxxxxxxxx(\n" 2241 " aaa, aaa);", 2242 getGoogleJSStyleWithColumns(20)); 2243 verifyFormat("xxxxxxxxxxx(\n" 2244 " aaa, aaa, aaa,\n" 2245 " aaa, aaa, aaa);", 2246 getGoogleJSStyleWithColumns(20)); 2247 verifyFormat("xxxxxxxxxxx(\n" 2248 " aaaaaaaaaaaaaaaaaaaaaaaa,\n" 2249 " function(x) {\n" 2250 " y(); //\n" 2251 " });", 2252 getGoogleJSStyleWithColumns(40)); 2253 verifyFormat("while (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n" 2254 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 2255 } 2256 2257 TEST_F(FormatTestJS, JSDocAnnotations) { 2258 verifyFormat("/**\n" 2259 " * @exports {this.is.a.long.path.to.a.Type}\n" 2260 " */", 2261 "/**\n" 2262 " * @exports {this.is.a.long.path.to.a.Type}\n" 2263 " */", 2264 getGoogleJSStyleWithColumns(20)); 2265 verifyFormat("/**\n" 2266 " * @mods {this.is.a.long.path.to.a.Type}\n" 2267 " */", 2268 "/**\n" 2269 " * @mods {this.is.a.long.path.to.a.Type}\n" 2270 " */", 2271 getGoogleJSStyleWithColumns(20)); 2272 verifyFormat("/**\n" 2273 " * @mods {this.is.a.long.path.to.a.Type}\n" 2274 " */", 2275 "/**\n" 2276 " * @mods {this.is.a.long.path.to.a.Type}\n" 2277 " */", 2278 getGoogleJSStyleWithColumns(20)); 2279 verifyFormat("/**\n" 2280 " * @param {canWrap\n" 2281 " * onSpace}\n" 2282 " */", 2283 "/**\n" 2284 " * @param {canWrap onSpace}\n" 2285 " */", 2286 getGoogleJSStyleWithColumns(20)); 2287 // make sure clang-format doesn't break before *any* '{' 2288 verifyFormat("/**\n" 2289 " * @lala {lala {lalala\n" 2290 " */\n", 2291 "/**\n" 2292 " * @lala {lala {lalala\n" 2293 " */\n", 2294 getGoogleJSStyleWithColumns(20)); 2295 // cases where '{' is around the column limit 2296 for (int ColumnLimit = 6; ColumnLimit < 13; ++ColumnLimit) { 2297 verifyFormat("/**\n" 2298 " * @param {type}\n" 2299 " */", 2300 "/**\n" 2301 " * @param {type}\n" 2302 " */", 2303 getGoogleJSStyleWithColumns(ColumnLimit)); 2304 } 2305 // don't break before @tags 2306 verifyFormat("/**\n" 2307 " * This\n" 2308 " * tag @param\n" 2309 " * stays.\n" 2310 " */", 2311 "/**\n" 2312 " * This tag @param stays.\n" 2313 " */", 2314 getGoogleJSStyleWithColumns(13)); 2315 verifyFormat("/**\n" 2316 " * @see http://very/very/long/url/is/long\n" 2317 " */", 2318 "/**\n" 2319 " * @see http://very/very/long/url/is/long\n" 2320 " */", 2321 getGoogleJSStyleWithColumns(20)); 2322 verifyFormat("/**\n" 2323 " * @param This is a\n" 2324 " * long comment\n" 2325 " * but no type\n" 2326 " */", 2327 "/**\n" 2328 " * @param This is a long comment but no type\n" 2329 " */", 2330 getGoogleJSStyleWithColumns(20)); 2331 // Break and reindent @param line and reflow unrelated lines. 2332 EXPECT_EQ("{\n" 2333 " /**\n" 2334 " * long long long\n" 2335 " * long\n" 2336 " * @param {this.is.a.long.path.to.a.Type}\n" 2337 " * a\n" 2338 " * long long long\n" 2339 " * long long\n" 2340 " */\n" 2341 " function f(a) {}\n" 2342 "}", 2343 format("{\n" 2344 "/**\n" 2345 " * long long long long\n" 2346 " * @param {this.is.a.long.path.to.a.Type} a\n" 2347 " * long long long long\n" 2348 " * long\n" 2349 " */\n" 2350 " function f(a) {}\n" 2351 "}", 2352 getGoogleJSStyleWithColumns(20))); 2353 } 2354 2355 TEST_F(FormatTestJS, TslintComments) { 2356 // tslint uses pragma comments that must be on their own line. 2357 verifyFormat("// Comment that needs wrapping. Comment that needs wrapping. " 2358 "Comment that needs\n" 2359 "// wrapping. Trailing line.\n" 2360 "// tslint:disable-next-line:must-be-on-own-line", 2361 "// Comment that needs wrapping. Comment that needs wrapping. " 2362 "Comment that needs wrapping.\n" 2363 "// Trailing line.\n" 2364 "// tslint:disable-next-line:must-be-on-own-line"); 2365 } 2366 2367 TEST_F(FormatTestJS, TscComments) { 2368 // As above, @ts-ignore and @ts-check comments must be on their own line. 2369 verifyFormat("// Comment that needs wrapping. Comment that needs wrapping. " 2370 "Comment that needs\n" 2371 "// wrapping. Trailing line.\n" 2372 "// @ts-ignore", 2373 "// Comment that needs wrapping. Comment that needs wrapping. " 2374 "Comment that needs wrapping.\n" 2375 "// Trailing line.\n" 2376 "// @ts-ignore"); 2377 verifyFormat("// Comment that needs wrapping. Comment that needs wrapping. " 2378 "Comment that needs\n" 2379 "// wrapping. Trailing line.\n" 2380 "// @ts-check", 2381 "// Comment that needs wrapping. Comment that needs wrapping. " 2382 "Comment that needs wrapping.\n" 2383 "// Trailing line.\n" 2384 "// @ts-check"); 2385 } 2386 2387 TEST_F(FormatTestJS, RequoteStringsSingle) { 2388 verifyFormat("var x = 'foo';", "var x = \"foo\";"); 2389 verifyFormat("var x = 'fo\\'o\\'';", "var x = \"fo'o'\";"); 2390 verifyFormat("var x = 'fo\\'o\\'';", "var x = \"fo\\'o'\";"); 2391 verifyFormat("var x =\n" 2392 " 'foo\\'';", 2393 // Code below is 15 chars wide, doesn't fit into the line with 2394 // the \ escape added. 2395 "var x = \"foo'\";", getGoogleJSStyleWithColumns(15)); 2396 // Removes no-longer needed \ escape from ". 2397 verifyFormat("var x = 'fo\"o';", "var x = \"fo\\\"o\";"); 2398 // Code below fits into 15 chars *after* removing the \ escape. 2399 verifyFormat("var x = 'fo\"o';", "var x = \"fo\\\"o\";", 2400 getGoogleJSStyleWithColumns(15)); 2401 verifyFormat("// clang-format off\n" 2402 "let x = \"double\";\n" 2403 "// clang-format on\n" 2404 "let x = 'single';\n", 2405 "// clang-format off\n" 2406 "let x = \"double\";\n" 2407 "// clang-format on\n" 2408 "let x = \"single\";\n"); 2409 } 2410 2411 TEST_F(FormatTestJS, RequoteAndIndent) { 2412 verifyFormat("let x = someVeryLongFunctionThatGoesOnAndOn(\n" 2413 " 'double quoted string that needs wrapping');", 2414 "let x = someVeryLongFunctionThatGoesOnAndOn(" 2415 "\"double quoted string that needs wrapping\");"); 2416 2417 verifyFormat("let x =\n" 2418 " 'foo\\'oo';\n" 2419 "let x =\n" 2420 " 'foo\\'oo';", 2421 "let x=\"foo'oo\";\n" 2422 "let x=\"foo'oo\";", 2423 getGoogleJSStyleWithColumns(15)); 2424 } 2425 2426 TEST_F(FormatTestJS, RequoteStringsDouble) { 2427 FormatStyle DoubleQuotes = getGoogleStyle(FormatStyle::LK_JavaScript); 2428 DoubleQuotes.JavaScriptQuotes = FormatStyle::JSQS_Double; 2429 verifyFormat("var x = \"foo\";", DoubleQuotes); 2430 verifyFormat("var x = \"foo\";", "var x = 'foo';", DoubleQuotes); 2431 verifyFormat("var x = \"fo'o\";", "var x = 'fo\\'o';", DoubleQuotes); 2432 } 2433 2434 TEST_F(FormatTestJS, RequoteStringsLeave) { 2435 FormatStyle LeaveQuotes = getGoogleStyle(FormatStyle::LK_JavaScript); 2436 LeaveQuotes.JavaScriptQuotes = FormatStyle::JSQS_Leave; 2437 verifyFormat("var x = \"foo\";", LeaveQuotes); 2438 verifyFormat("var x = 'foo';", LeaveQuotes); 2439 } 2440 2441 TEST_F(FormatTestJS, SupportShebangLines) { 2442 verifyFormat("#!/usr/bin/env node\n" 2443 "var x = hello();", 2444 "#!/usr/bin/env node\n" 2445 "var x = hello();"); 2446 } 2447 2448 TEST_F(FormatTestJS, NonNullAssertionOperator) { 2449 verifyFormat("let x = foo!.bar();\n"); 2450 verifyFormat("let x = foo ? bar! : baz;\n"); 2451 verifyFormat("let x = !foo;\n"); 2452 verifyFormat("if (!+a) {\n}"); 2453 verifyFormat("let x = foo[0]!;\n"); 2454 verifyFormat("let x = (foo)!;\n"); 2455 verifyFormat("let x = x(foo!);\n"); 2456 verifyFormat("a.aaaaaa(a.a!).then(\n" 2457 " x => x(x));\n", 2458 getGoogleJSStyleWithColumns(20)); 2459 verifyFormat("let x = foo! - 1;\n"); 2460 verifyFormat("let x = {foo: 1}!;\n"); 2461 verifyFormat("let x = hello.foo()!\n" 2462 " .foo()!\n" 2463 " .foo()!\n" 2464 " .foo()!;\n", 2465 getGoogleJSStyleWithColumns(20)); 2466 verifyFormat("let x = namespace!;\n"); 2467 verifyFormat("return !!x;\n"); 2468 } 2469 2470 TEST_F(FormatTestJS, CppKeywords) { 2471 // Make sure we don't mess stuff up because of C++ keywords. 2472 verifyFormat("return operator && (aa);"); 2473 // .. or QT ones. 2474 verifyFormat("const slots: Slot[];"); 2475 // use the "!" assertion operator to validate that clang-format understands 2476 // these C++ keywords aren't keywords in JS/TS. 2477 verifyFormat("auto!;"); 2478 verifyFormat("char!;"); 2479 verifyFormat("concept!;"); 2480 verifyFormat("double!;"); 2481 verifyFormat("extern!;"); 2482 verifyFormat("float!;"); 2483 verifyFormat("inline!;"); 2484 verifyFormat("int!;"); 2485 verifyFormat("long!;"); 2486 verifyFormat("register!;"); 2487 verifyFormat("restrict!;"); 2488 verifyFormat("sizeof!;"); 2489 verifyFormat("struct!;"); 2490 verifyFormat("typedef!;"); 2491 verifyFormat("union!;"); 2492 verifyFormat("unsigned!;"); 2493 verifyFormat("volatile!;"); 2494 verifyFormat("_Alignas!;"); 2495 verifyFormat("_Alignof!;"); 2496 verifyFormat("_Atomic!;"); 2497 verifyFormat("_Bool!;"); 2498 verifyFormat("_Complex!;"); 2499 verifyFormat("_Generic!;"); 2500 verifyFormat("_Imaginary!;"); 2501 verifyFormat("_Noreturn!;"); 2502 verifyFormat("_Static_assert!;"); 2503 verifyFormat("_Thread_local!;"); 2504 verifyFormat("__func__!;"); 2505 verifyFormat("__objc_yes!;"); 2506 verifyFormat("__objc_no!;"); 2507 verifyFormat("asm!;"); 2508 verifyFormat("bool!;"); 2509 verifyFormat("const_cast!;"); 2510 verifyFormat("dynamic_cast!;"); 2511 verifyFormat("explicit!;"); 2512 verifyFormat("friend!;"); 2513 verifyFormat("mutable!;"); 2514 verifyFormat("operator!;"); 2515 verifyFormat("reinterpret_cast!;"); 2516 verifyFormat("static_cast!;"); 2517 verifyFormat("template!;"); 2518 verifyFormat("typename!;"); 2519 verifyFormat("typeid!;"); 2520 verifyFormat("using!;"); 2521 verifyFormat("virtual!;"); 2522 verifyFormat("wchar_t!;"); 2523 2524 // Positive tests: 2525 verifyFormat("x.type!;"); 2526 verifyFormat("x.get!;"); 2527 verifyFormat("x.set!;"); 2528 } 2529 2530 TEST_F(FormatTestJS, NullPropagatingOperator) { 2531 verifyFormat("let x = foo?.bar?.baz();\n"); 2532 verifyFormat("let x = foo?.(foo);\n"); 2533 verifyFormat("let x = foo?.['arr'];\n"); 2534 } 2535 2536 TEST_F(FormatTestJS, NullishCoalescingOperator) { 2537 verifyFormat("const val = something ?? 'some other default';\n"); 2538 verifyFormat( 2539 "const val = something ?? otherDefault ??\n" 2540 " evenMore ?? evenMore;\n", 2541 "const val = something ?? otherDefault ?? evenMore ?? evenMore;\n", 2542 getGoogleJSStyleWithColumns(40)); 2543 } 2544 2545 TEST_F(FormatTestJS, AssignmentOperators) { 2546 verifyFormat("a &&= b;\n"); 2547 verifyFormat("a ||= b;\n"); 2548 // NB: need to split ? ?= to avoid it being interpreted by C++ as a trigraph 2549 // for #. 2550 verifyFormat("a ?" 2551 "?= b;\n"); 2552 } 2553 2554 TEST_F(FormatTestJS, Conditional) { 2555 verifyFormat("y = x ? 1 : 2;"); 2556 verifyFormat("x ? 1 : 2;"); 2557 verifyFormat("class Foo {\n" 2558 " field = true ? 1 : 2;\n" 2559 " method(a = true ? 1 : 2) {}\n" 2560 "}"); 2561 } 2562 2563 TEST_F(FormatTestJS, ImportComments) { 2564 verifyFormat("import {x} from 'x'; // from some location", 2565 getGoogleJSStyleWithColumns(25)); 2566 verifyFormat("// taze: x from 'location'", getGoogleJSStyleWithColumns(10)); 2567 verifyFormat("/// <reference path=\"some/location\" />", 2568 getGoogleJSStyleWithColumns(10)); 2569 } 2570 2571 TEST_F(FormatTestJS, Exponentiation) { 2572 verifyFormat("squared = x ** 2;"); 2573 verifyFormat("squared **= 2;"); 2574 } 2575 2576 TEST_F(FormatTestJS, NestedLiterals) { 2577 FormatStyle FourSpaces = getGoogleJSStyleWithColumns(15); 2578 FourSpaces.IndentWidth = 4; 2579 verifyFormat("var l = [\n" 2580 " [\n" 2581 " 1,\n" 2582 " ],\n" 2583 "];", 2584 FourSpaces); 2585 verifyFormat("var l = [\n" 2586 " {\n" 2587 " 1: 1,\n" 2588 " },\n" 2589 "];", 2590 FourSpaces); 2591 verifyFormat("someFunction(\n" 2592 " p1,\n" 2593 " [\n" 2594 " 1,\n" 2595 " ],\n" 2596 ");", 2597 FourSpaces); 2598 verifyFormat("someFunction(\n" 2599 " p1,\n" 2600 " {\n" 2601 " 1: 1,\n" 2602 " },\n" 2603 ");", 2604 FourSpaces); 2605 verifyFormat("var o = {\n" 2606 " 1: 1,\n" 2607 " 2: {\n" 2608 " 3: 3,\n" 2609 " },\n" 2610 "};", 2611 FourSpaces); 2612 verifyFormat("var o = {\n" 2613 " 1: 1,\n" 2614 " 2: [\n" 2615 " 3,\n" 2616 " ],\n" 2617 "};", 2618 FourSpaces); 2619 } 2620 2621 TEST_F(FormatTestJS, BackslashesInComments) { 2622 verifyFormat("// hello \\\n" 2623 "if (x) foo();\n", 2624 "// hello \\\n" 2625 " if ( x) \n" 2626 " foo();\n"); 2627 verifyFormat("/* ignore \\\n" 2628 " */\n" 2629 "if (x) foo();\n", 2630 "/* ignore \\\n" 2631 " */\n" 2632 " if ( x) foo();\n"); 2633 verifyFormat("// st \\ art\\\n" 2634 "// comment" 2635 "// continue \\\n" 2636 "formatMe();\n", 2637 "// st \\ art\\\n" 2638 "// comment" 2639 "// continue \\\n" 2640 "formatMe( );\n"); 2641 } 2642 2643 TEST_F(FormatTestJS, AddsLastLinePenaltyIfEndingIsBroken) { 2644 EXPECT_EQ( 2645 "a = function() {\n" 2646 " b = function() {\n" 2647 " this.aaaaaaaaaaaaaaaaaaa[aaaaaaaaaaa] = aaaa.aaaaaa ?\n" 2648 " aaaa.aaaaaa : /** @type " 2649 "{aaaa.aaaa.aaaaaaaaa.aaaaaaaaaaaaaaaaaaa} */\n" 2650 " (aaaa.aaaa.aaaaaaaaa.aaaaaaaaaaaaa.aaaaaaaaaaaaaaaaa);\n" 2651 " };\n" 2652 "};", 2653 format("a = function() {\n" 2654 " b = function() {\n" 2655 " this.aaaaaaaaaaaaaaaaaaa[aaaaaaaaaaa] = aaaa.aaaaaa ? " 2656 "aaaa.aaaaaa : /** @type " 2657 "{aaaa.aaaa.aaaaaaaaa.aaaaaaaaaaaaaaaaaaa} */\n" 2658 " (aaaa.aaaa.aaaaaaaaa.aaaaaaaaaaaaa.aaaaaaaaaaaaaaaaa);\n" 2659 " };\n" 2660 "};")); 2661 } 2662 2663 TEST_F(FormatTestJS, ParameterNamingComment) { 2664 verifyFormat("callFoo(/*spaceAfterParameterNamingComment=*/ 1);"); 2665 } 2666 2667 TEST_F(FormatTestJS, ConditionalTypes) { 2668 // Formatting below is not necessarily intentional, this just ensures that 2669 // clang-format does not break the code. 2670 verifyFormat( // wrap 2671 "type UnionToIntersection<U> =\n" 2672 " (U extends any ? (k: U) => void :\n" 2673 " never) extends((k: infer I) => void) ? I : never;"); 2674 } 2675 2676 TEST_F(FormatTestJS, SupportPrivateFieldsAndMethods) { 2677 verifyFormat("class Example {\n" 2678 " pub = 1;\n" 2679 " #priv = 2;\n" 2680 " static pub2 = 'foo';\n" 2681 " static #priv2 = 'bar';\n" 2682 " method() {\n" 2683 " this.#priv = 5;\n" 2684 " }\n" 2685 " static staticMethod() {\n" 2686 " switch (this.#priv) {\n" 2687 " case '1':\n" 2688 " #priv = 3;\n" 2689 " break;\n" 2690 " }\n" 2691 " }\n" 2692 " #privateMethod() {\n" 2693 " this.#privateMethod(); // infinite loop\n" 2694 " }\n" 2695 " static #staticPrivateMethod() {}\n"); 2696 } 2697 2698 TEST_F(FormatTestJS, DeclaredFields) { 2699 verifyFormat("class Example {\n" 2700 " declare pub: string;\n" 2701 " declare private priv: string;\n" 2702 "}\n"); 2703 } 2704 2705 TEST_F(FormatTestJS, NoBreakAfterAsserts) { 2706 verifyFormat( 2707 "interface Assertable<State extends {}> {\n" 2708 " assert<ExportedState extends {}, DependencyState extends State = " 2709 "State>(\n" 2710 " callback: Callback<ExportedState, DependencyState>):\n" 2711 " asserts this is ExtendedState<DependencyState&ExportedState>;\n" 2712 "}\n", 2713 "interface Assertable<State extends {}> {\n" 2714 " assert<ExportedState extends {}, DependencyState extends State = " 2715 "State>(callback: Callback<ExportedState, DependencyState>): asserts " 2716 "this is ExtendedState<DependencyState&ExportedState>;\n" 2717 "}\n"); 2718 } 2719 2720 TEST_F(FormatTestJS, NumericSeparators) { 2721 verifyFormat("x = 1_000_000 + 12;", "x = 1_000_000 + 12;"); 2722 } 2723 2724 TEST_F(FormatTestJS, AlignConsecutiveDeclarations) { 2725 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 2726 Style.AlignConsecutiveDeclarations.Enabled = true; 2727 verifyFormat("let letVariable = 5;\n" 2728 "double constVariable = 10;", 2729 Style); 2730 2731 verifyFormat("let letVariable = 5;\n" 2732 "const constVariable = 10;", 2733 Style); 2734 2735 verifyFormat("let letVariable = 5;\n" 2736 "static const constVariable = 10;", 2737 Style); 2738 2739 verifyFormat("let letVariable = 5;\n" 2740 "static var constVariable = 10;", 2741 Style); 2742 2743 verifyFormat("let letVariable = 5;\n" 2744 "var constVariable = 10;", 2745 Style); 2746 2747 verifyFormat("double letVariable = 5;\n" 2748 "var constVariable = 10;", 2749 Style); 2750 2751 verifyFormat("const letVariable = 5;\n" 2752 "var constVariable = 10;", 2753 Style); 2754 2755 verifyFormat("int letVariable = 5;\n" 2756 "int constVariable = 10;", 2757 Style); 2758 } 2759 2760 TEST_F(FormatTestJS, AlignConsecutiveAssignments) { 2761 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 2762 2763 Style.AlignConsecutiveAssignments.Enabled = true; 2764 verifyFormat("let letVariable = 5;\n" 2765 "double constVariable = 10;", 2766 Style); 2767 2768 verifyFormat("let letVariable = 5;\n" 2769 "const constVariable = 10;", 2770 Style); 2771 2772 verifyFormat("let letVariable = 5;\n" 2773 "static const constVariable = 10;", 2774 Style); 2775 2776 verifyFormat("let letVariable = 5;\n" 2777 "static var constVariable = 10;", 2778 Style); 2779 2780 verifyFormat("let letVariable = 5;\n" 2781 "var constVariable = 10;", 2782 Style); 2783 2784 verifyFormat("double letVariable = 5;\n" 2785 "var constVariable = 10;", 2786 Style); 2787 2788 verifyFormat("const letVariable = 5;\n" 2789 "var constVariable = 10;", 2790 Style); 2791 2792 verifyFormat("int letVariable = 5;\n" 2793 "int constVariable = 10;", 2794 Style); 2795 } 2796 2797 TEST_F(FormatTestJS, AlignConsecutiveAssignmentsAndDeclarations) { 2798 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 2799 Style.AlignConsecutiveDeclarations.Enabled = true; 2800 Style.AlignConsecutiveAssignments.Enabled = true; 2801 verifyFormat("let letVariable = 5;\n" 2802 "double constVariable = 10;", 2803 Style); 2804 2805 verifyFormat("let letVariable = 5;\n" 2806 "const constVariable = 10;", 2807 Style); 2808 2809 verifyFormat("let letVariable = 5;\n" 2810 "static const constVariable = 10;", 2811 Style); 2812 2813 verifyFormat("let letVariable = 5;\n" 2814 "static var constVariable = 10;", 2815 Style); 2816 2817 verifyFormat("let letVariable = 5;\n" 2818 "var constVariable = 10;", 2819 Style); 2820 2821 verifyFormat("double letVariable = 5;\n" 2822 "var constVariable = 10;", 2823 Style); 2824 2825 verifyFormat("const letVariable = 5;\n" 2826 "var constVariable = 10;", 2827 Style); 2828 2829 verifyFormat("int letVariable = 5;\n" 2830 "int constVariable = 10;", 2831 Style); 2832 } 2833 2834 } // namespace format 2835 } // end namespace clang 2836