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, ES6DestructuringAssignment) { 87 verifyFormat("var [a, b, c] = [1, 2, 3];"); 88 verifyFormat("var {a, b} = {a: 1, b: 2};"); 89 } 90 91 TEST_F(FormatTestJS, SpacesInContainerLiterals) { 92 verifyFormat("var arr = [1, 2, 3];"); 93 verifyFormat("var obj = {a: 1, b: 2, c: 3};"); 94 95 verifyFormat("var object_literal_with_long_name = {\n" 96 " a: 'aaaaaaaaaaaaaaaaaa',\n" 97 " b: 'bbbbbbbbbbbbbbbbbb'\n" 98 "};"); 99 100 verifyFormat("var obj = {a: 1, b: 2, c: 3};", 101 getChromiumStyle(FormatStyle::LK_JavaScript)); 102 verifyFormat("someVariable = {'a': [{}]};"); 103 } 104 105 TEST_F(FormatTestJS, SingleQuoteStrings) { 106 verifyFormat("this.function('', true);"); 107 } 108 109 TEST_F(FormatTestJS, GoogScopes) { 110 verifyFormat("goog.scope(function() {\n" 111 "var x = a.b;\n" 112 "var y = c.d;\n" 113 "}); // goog.scope"); 114 } 115 116 TEST_F(FormatTestJS, Closures) { 117 verifyFormat("doFoo(function() { return 1; });"); 118 verifyFormat("var func = function() { return 1; };"); 119 verifyFormat("return {\n" 120 " body: {\n" 121 " setAttribute: function(key, val) { this[key] = val; },\n" 122 " getAttribute: function(key) { return this[key]; },\n" 123 " style: {direction: ''}\n" 124 " }\n" 125 "};"); 126 EXPECT_EQ("abc = xyz ? function() { return 1; } : function() { return -1; };", 127 format("abc=xyz?function(){return 1;}:function(){return -1;};")); 128 129 verifyFormat("var closure = goog.bind(\n" 130 " function() { // comment\n" 131 " foo();\n" 132 " bar();\n" 133 " },\n" 134 " this, arg1IsReallyLongAndNeeedsLineBreaks,\n" 135 " arg3IsReallyLongAndNeeedsLineBreaks);"); 136 verifyFormat("var closure = goog.bind(function() { // comment\n" 137 " foo();\n" 138 " bar();\n" 139 "}, this);"); 140 verifyFormat("return {\n" 141 " a: 'E',\n" 142 " b: function() {\n" 143 " return function() {\n" 144 " f(); //\n" 145 " };\n" 146 " }\n" 147 "};"); 148 149 verifyFormat("var x = {a: function() { return 1; }};", 150 getGoogleJSStyleWithColumns(38)); 151 verifyFormat("var x = {\n" 152 " a: function() { return 1; }\n" 153 "};", 154 getGoogleJSStyleWithColumns(37)); 155 } 156 157 TEST_F(FormatTestJS, MultipleFunctionLiterals) { 158 verifyFormat("promise.then(\n" 159 " function success() {\n" 160 " doFoo();\n" 161 " doBar();\n" 162 " },\n" 163 " function error() {\n" 164 " doFoo();\n" 165 " doBaz();\n" 166 " },\n" 167 " []);\n"); 168 verifyFormat("promise.then(\n" 169 " function success() {\n" 170 " doFoo();\n" 171 " doBar();\n" 172 " },\n" 173 " [],\n" 174 " function error() {\n" 175 " doFoo();\n" 176 " doBaz();\n" 177 " });\n"); 178 // FIXME: Here, we should probably break right after the "(" for consistency. 179 verifyFormat("promise.then([],\n" 180 " function success() {\n" 181 " doFoo();\n" 182 " doBar();\n" 183 " },\n" 184 " function error() {\n" 185 " doFoo();\n" 186 " doBaz();\n" 187 " });\n"); 188 } 189 190 TEST_F(FormatTestJS, ReturnStatements) { 191 verifyFormat("function() { return [hello, world]; }"); 192 } 193 194 TEST_F(FormatTestJS, ClosureStyleComments) { 195 verifyFormat("var x = /** @type {foo} */ (bar);"); 196 } 197 198 TEST_F(FormatTestJS, TryCatch) { 199 verifyFormat("try {\n" 200 " f();\n" 201 "} catch (e) {\n" 202 " g();\n" 203 "} finally {\n" 204 " h();\n" 205 "}"); 206 } 207 208 TEST_F(FormatTestJS, StringLiteralConcatenation) { 209 verifyFormat("var literal = 'hello ' +\n" 210 " 'world';"); 211 } 212 213 TEST_F(FormatTestJS, RegexLiteralClassification) { 214 // Regex literals. 215 verifyFormat("var regex = /abc/;"); 216 verifyFormat("f(/abc/);"); 217 verifyFormat("f(abc, /abc/);"); 218 verifyFormat("some_map[/abc/];"); 219 verifyFormat("var x = a ? /abc/ : /abc/;"); 220 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}"); 221 verifyFormat("var x = !/abc/.test(y);"); 222 verifyFormat("var x = a && /abc/.test(y);"); 223 verifyFormat("var x = a || /abc/.test(y);"); 224 verifyFormat("var x = a + /abc/.search(y);"); 225 verifyFormat("var regexs = {/abc/, /abc/};"); 226 verifyFormat("return /abc/;"); 227 228 // Not regex literals. 229 verifyFormat("var a = a / 2 + b / 3;"); 230 } 231 232 TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) { 233 verifyFormat("var regex = /a*/;"); 234 verifyFormat("var regex = /a+/;"); 235 verifyFormat("var regex = /a?/;"); 236 verifyFormat("var regex = /.a./;"); 237 verifyFormat("var regex = /a\\*/;"); 238 verifyFormat("var regex = /^a$/;"); 239 verifyFormat("var regex = /\\/a/;"); 240 verifyFormat("var regex = /(?:x)/;"); 241 verifyFormat("var regex = /x(?=y)/;"); 242 verifyFormat("var regex = /x(?!y)/;"); 243 verifyFormat("var regex = /x|y/;"); 244 verifyFormat("var regex = /a{2}/;"); 245 verifyFormat("var regex = /a{1,3}/;"); 246 verifyFormat("var regex = /[abc]/;"); 247 verifyFormat("var regex = /[^abc]/;"); 248 verifyFormat("var regex = /[\\b]/;"); 249 verifyFormat("var regex = /\\b/;"); 250 verifyFormat("var regex = /\\B/;"); 251 verifyFormat("var regex = /\\d/;"); 252 verifyFormat("var regex = /\\D/;"); 253 verifyFormat("var regex = /\\f/;"); 254 verifyFormat("var regex = /\\n/;"); 255 verifyFormat("var regex = /\\r/;"); 256 verifyFormat("var regex = /\\s/;"); 257 verifyFormat("var regex = /\\S/;"); 258 verifyFormat("var regex = /\\t/;"); 259 verifyFormat("var regex = /\\v/;"); 260 verifyFormat("var regex = /\\w/;"); 261 verifyFormat("var regex = /\\W/;"); 262 verifyFormat("var regex = /a(a)\\1/;"); 263 verifyFormat("var regex = /\\0/;"); 264 verifyFormat("var regex = /\\\\/g;"); 265 verifyFormat("var regex = /\\a\\\\/g;"); 266 verifyFormat("var regex = /\a\\//g;"); 267 } 268 269 TEST_F(FormatTestJS, RegexLiteralModifiers) { 270 verifyFormat("var regex = /abc/g;"); 271 verifyFormat("var regex = /abc/i;"); 272 verifyFormat("var regex = /abc/m;"); 273 verifyFormat("var regex = /abc/y;"); 274 } 275 276 TEST_F(FormatTestJS, RegexLiteralLength) { 277 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 278 getGoogleJSStyleWithColumns(60)); 279 verifyFormat("var regex =\n" 280 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 281 getGoogleJSStyleWithColumns(60)); 282 } 283 284 TEST_F(FormatTestJS, RegexLiteralExamples) { 285 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);"); 286 } 287 288 } // end namespace tooling 289 } // end namespace clang 290