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 tooling::Replacements Replaces = reformat(Style, Code, Ranges); 28 std::string Result = applyAllReplacements(Code, Replaces); 29 EXPECT_NE("", Result); 30 DEBUG(llvm::errs() << "\n" << Result << "\n\n"); 31 return Result; 32 } 33 34 static std::string format( 35 llvm::StringRef Code, 36 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) { 37 return format(Code, 0, Code.size(), Style); 38 } 39 40 static FormatStyle getGoogleJSStyleWithColumns(unsigned ColumnLimit) { 41 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 42 Style.ColumnLimit = ColumnLimit; 43 return Style; 44 } 45 46 static void verifyFormat( 47 llvm::StringRef Code, 48 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) { 49 EXPECT_EQ(Code.str(), format(test::messUp(Code), Style)); 50 } 51 }; 52 53 TEST_F(FormatTestJS, UnderstandsJavaScriptOperators) { 54 verifyFormat("a == = b;"); 55 verifyFormat("a != = b;"); 56 57 verifyFormat("a === b;"); 58 verifyFormat("aaaaaaa ===\n b;", getGoogleJSStyleWithColumns(10)); 59 verifyFormat("a !== b;"); 60 verifyFormat("aaaaaaa !==\n b;", getGoogleJSStyleWithColumns(10)); 61 verifyFormat("if (a + b + c +\n" 62 " d !==\n" 63 " e + f + g)\n" 64 " q();", 65 getGoogleJSStyleWithColumns(20)); 66 67 verifyFormat("a >> >= b;"); 68 69 verifyFormat("a >>> b;"); 70 verifyFormat("aaaaaaa >>>\n b;", getGoogleJSStyleWithColumns(10)); 71 verifyFormat("a >>>= b;"); 72 verifyFormat("aaaaaaa >>>=\n b;", getGoogleJSStyleWithColumns(10)); 73 verifyFormat("if (a + b + c +\n" 74 " d >>>\n" 75 " e + f + g)\n" 76 " q();", 77 getGoogleJSStyleWithColumns(20)); 78 verifyFormat("var x = aaaaaaaaaa ?\n" 79 " bbbbbb :\n" 80 " ccc;", 81 getGoogleJSStyleWithColumns(20)); 82 83 verifyFormat("var b = a.map((x) => x + 1);"); 84 } 85 86 TEST_F(FormatTestJS, LiteralOperatorsCanBeKeywords) { 87 verifyFormat("not.and.or.not_eq = 1;"); 88 } 89 90 TEST_F(FormatTestJS, ES6DestructuringAssignment) { 91 verifyFormat("var [a, b, c] = [1, 2, 3];"); 92 verifyFormat("var {a, b} = {a: 1, b: 2};"); 93 } 94 95 TEST_F(FormatTestJS, ContainerLiterals) { 96 verifyFormat("return {\n" 97 " link: function() {\n" 98 " f(); //\n" 99 " }\n" 100 "};"); 101 verifyFormat("return {\n" 102 " a: a,\n" 103 " link: function() {\n" 104 " f(); //\n" 105 " }\n" 106 "};"); 107 verifyFormat("return {\n" 108 " a: a,\n" 109 " link:\n" 110 " function() {\n" 111 " f(); //\n" 112 " },\n" 113 " link:\n" 114 " function() {\n" 115 " f(); //\n" 116 " }\n" 117 "};"); 118 verifyFormat("var stuff = {\n" 119 " // comment for update\n" 120 " update: false,\n" 121 " // comment for modules\n" 122 " modules: false,\n" 123 " // comment for tasks\n" 124 " tasks: false\n" 125 "};"); 126 verifyFormat("return {\n" 127 " 'finish':\n" 128 " //\n" 129 " a\n" 130 "};"); 131 } 132 133 TEST_F(FormatTestJS, SpacesInContainerLiterals) { 134 verifyFormat("var arr = [1, 2, 3];"); 135 verifyFormat("var obj = {a: 1, b: 2, c: 3};"); 136 137 verifyFormat("var object_literal_with_long_name = {\n" 138 " a: 'aaaaaaaaaaaaaaaaaa',\n" 139 " b: 'bbbbbbbbbbbbbbbbbb'\n" 140 "};"); 141 142 verifyFormat("var obj = {a: 1, b: 2, c: 3};", 143 getChromiumStyle(FormatStyle::LK_JavaScript)); 144 verifyFormat("someVariable = {'a': [{}]};"); 145 } 146 147 TEST_F(FormatTestJS, SingleQuoteStrings) { 148 verifyFormat("this.function('', true);"); 149 } 150 151 TEST_F(FormatTestJS, GoogScopes) { 152 verifyFormat("goog.scope(function() {\n" 153 "var x = a.b;\n" 154 "var y = c.d;\n" 155 "}); // goog.scope"); 156 } 157 158 TEST_F(FormatTestJS, FormatsFreestandingFunctions) { 159 verifyFormat("function outer1(a, b) {\n" 160 " function inner1(a, b) { return a; }\n" 161 " inner1(a, b);\n" 162 "}\n" 163 "function outer2(a, b) {\n" 164 " function inner2(a, b) { return a; }\n" 165 " inner2(a, b);\n" 166 "}"); 167 } 168 169 TEST_F(FormatTestJS, FunctionLiterals) { 170 verifyFormat("doFoo(function() { return 1; });"); 171 verifyFormat("var func = function() { return 1; };"); 172 verifyFormat("return {\n" 173 " body: {\n" 174 " setAttribute: function(key, val) { this[key] = val; },\n" 175 " getAttribute: function(key) { return this[key]; },\n" 176 " style: {direction: ''}\n" 177 " }\n" 178 "};"); 179 EXPECT_EQ("abc = xyz ? function() { return 1; } : function() { return -1; };", 180 format("abc=xyz?function(){return 1;}:function(){return -1;};")); 181 182 verifyFormat("var closure = goog.bind(\n" 183 " function() { // comment\n" 184 " foo();\n" 185 " bar();\n" 186 " },\n" 187 " this, arg1IsReallyLongAndNeeedsLineBreaks,\n" 188 " arg3IsReallyLongAndNeeedsLineBreaks);"); 189 verifyFormat("var closure = goog.bind(function() { // comment\n" 190 " foo();\n" 191 " bar();\n" 192 "}, this);"); 193 verifyFormat("return {\n" 194 " a: 'E',\n" 195 " b: function() {\n" 196 " return function() {\n" 197 " f(); //\n" 198 " };\n" 199 " }\n" 200 "};"); 201 202 verifyFormat("var x = {a: function() { return 1; }};", 203 getGoogleJSStyleWithColumns(38)); 204 verifyFormat("var x = {\n" 205 " a: function() { return 1; }\n" 206 "};", 207 getGoogleJSStyleWithColumns(37)); 208 209 verifyFormat("return {\n" 210 " a: function SomeFunction() {\n" 211 " // ...\n" 212 " return 1;\n" 213 " }\n" 214 "};"); 215 } 216 217 TEST_F(FormatTestJS, MultipleFunctionLiterals) { 218 verifyFormat("promise.then(\n" 219 " function success() {\n" 220 " doFoo();\n" 221 " doBar();\n" 222 " },\n" 223 " function error() {\n" 224 " doFoo();\n" 225 " doBaz();\n" 226 " },\n" 227 " []);\n"); 228 verifyFormat("promise.then(\n" 229 " function success() {\n" 230 " doFoo();\n" 231 " doBar();\n" 232 " },\n" 233 " [],\n" 234 " function error() {\n" 235 " doFoo();\n" 236 " doBaz();\n" 237 " });\n"); 238 // FIXME: Here, we should probably break right after the "(" for consistency. 239 verifyFormat("promise.then([],\n" 240 " function success() {\n" 241 " doFoo();\n" 242 " doBar();\n" 243 " },\n" 244 " function error() {\n" 245 " doFoo();\n" 246 " doBaz();\n" 247 " });\n"); 248 } 249 250 TEST_F(FormatTestJS, ReturnStatements) { 251 verifyFormat("function() { return [hello, world]; }"); 252 } 253 254 TEST_F(FormatTestJS, ClosureStyleComments) { 255 verifyFormat("var x = /** @type {foo} */ (bar);"); 256 } 257 258 TEST_F(FormatTestJS, TryCatch) { 259 verifyFormat("try {\n" 260 " f();\n" 261 "} catch (e) {\n" 262 " g();\n" 263 "} finally {\n" 264 " h();\n" 265 "}"); 266 267 // But, of course, "catch" is a perfectly fine function name in JavaScript. 268 verifyFormat("someObject.catch();"); 269 } 270 271 TEST_F(FormatTestJS, StringLiteralConcatenation) { 272 verifyFormat("var literal = 'hello ' +\n" 273 " 'world';"); 274 } 275 276 TEST_F(FormatTestJS, RegexLiteralClassification) { 277 // Regex literals. 278 verifyFormat("var regex = /abc/;"); 279 verifyFormat("f(/abc/);"); 280 verifyFormat("f(abc, /abc/);"); 281 verifyFormat("some_map[/abc/];"); 282 verifyFormat("var x = a ? /abc/ : /abc/;"); 283 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}"); 284 verifyFormat("var x = !/abc/.test(y);"); 285 verifyFormat("var x = a && /abc/.test(y);"); 286 verifyFormat("var x = a || /abc/.test(y);"); 287 verifyFormat("var x = a + /abc/.search(y);"); 288 verifyFormat("var regexs = {/abc/, /abc/};"); 289 verifyFormat("return /abc/;"); 290 291 // Not regex literals. 292 verifyFormat("var a = a / 2 + b / 3;"); 293 } 294 295 TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) { 296 verifyFormat("var regex = /a*/;"); 297 verifyFormat("var regex = /a+/;"); 298 verifyFormat("var regex = /a?/;"); 299 verifyFormat("var regex = /.a./;"); 300 verifyFormat("var regex = /a\\*/;"); 301 verifyFormat("var regex = /^a$/;"); 302 verifyFormat("var regex = /\\/a/;"); 303 verifyFormat("var regex = /(?:x)/;"); 304 verifyFormat("var regex = /x(?=y)/;"); 305 verifyFormat("var regex = /x(?!y)/;"); 306 verifyFormat("var regex = /x|y/;"); 307 verifyFormat("var regex = /a{2}/;"); 308 verifyFormat("var regex = /a{1,3}/;"); 309 verifyFormat("var regex = /[abc]/;"); 310 verifyFormat("var regex = /[^abc]/;"); 311 verifyFormat("var regex = /[\\b]/;"); 312 verifyFormat("var regex = /\\b/;"); 313 verifyFormat("var regex = /\\B/;"); 314 verifyFormat("var regex = /\\d/;"); 315 verifyFormat("var regex = /\\D/;"); 316 verifyFormat("var regex = /\\f/;"); 317 verifyFormat("var regex = /\\n/;"); 318 verifyFormat("var regex = /\\r/;"); 319 verifyFormat("var regex = /\\s/;"); 320 verifyFormat("var regex = /\\S/;"); 321 verifyFormat("var regex = /\\t/;"); 322 verifyFormat("var regex = /\\v/;"); 323 verifyFormat("var regex = /\\w/;"); 324 verifyFormat("var regex = /\\W/;"); 325 verifyFormat("var regex = /a(a)\\1/;"); 326 verifyFormat("var regex = /\\0/;"); 327 verifyFormat("var regex = /\\\\/g;"); 328 verifyFormat("var regex = /\\a\\\\/g;"); 329 verifyFormat("var regex = /\a\\//g;"); 330 } 331 332 TEST_F(FormatTestJS, RegexLiteralModifiers) { 333 verifyFormat("var regex = /abc/g;"); 334 verifyFormat("var regex = /abc/i;"); 335 verifyFormat("var regex = /abc/m;"); 336 verifyFormat("var regex = /abc/y;"); 337 } 338 339 TEST_F(FormatTestJS, RegexLiteralLength) { 340 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 341 getGoogleJSStyleWithColumns(60)); 342 verifyFormat("var regex =\n" 343 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 344 getGoogleJSStyleWithColumns(60)); 345 } 346 347 TEST_F(FormatTestJS, RegexLiteralExamples) { 348 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);"); 349 } 350 351 } // end namespace tooling 352 } // end namespace clang 353