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 } 141 142 TEST_F(FormatTestJS, ReturnStatements) { 143 verifyFormat("function() { return [hello, world]; }"); 144 } 145 146 TEST_F(FormatTestJS, ClosureStyleComments) { 147 verifyFormat("var x = /** @type {foo} */ (bar);"); 148 } 149 150 TEST_F(FormatTestJS, TryCatch) { 151 verifyFormat("try {\n" 152 " f();\n" 153 "} catch (e) {\n" 154 " g();\n" 155 "} finally {\n" 156 " h();\n" 157 "}"); 158 } 159 160 TEST_F(FormatTestJS, RegexLiteralClassification) { 161 // Regex literals. 162 verifyFormat("var regex = /abc/;"); 163 verifyFormat("f(/abc/);"); 164 verifyFormat("f(abc, /abc/);"); 165 verifyFormat("some_map[/abc/];"); 166 verifyFormat("var x = a ? /abc/ : /abc/;"); 167 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}"); 168 verifyFormat("var x = !/abc/.test(y);"); 169 verifyFormat("var x = a && /abc/.test(y);"); 170 verifyFormat("var x = a || /abc/.test(y);"); 171 verifyFormat("var x = a + /abc/.search(y);"); 172 verifyFormat("var regexs = {/abc/, /abc/};"); 173 verifyFormat("return /abc/;"); 174 175 // Not regex literals. 176 verifyFormat("var a = a / 2 + b / 3;"); 177 } 178 179 TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) { 180 verifyFormat("var regex = /a*/;"); 181 verifyFormat("var regex = /a+/;"); 182 verifyFormat("var regex = /a?/;"); 183 verifyFormat("var regex = /.a./;"); 184 verifyFormat("var regex = /a\\*/;"); 185 verifyFormat("var regex = /^a$/;"); 186 verifyFormat("var regex = /\\/a/;"); 187 verifyFormat("var regex = /(?:x)/;"); 188 verifyFormat("var regex = /x(?=y)/;"); 189 verifyFormat("var regex = /x(?!y)/;"); 190 verifyFormat("var regex = /x|y/;"); 191 verifyFormat("var regex = /a{2}/;"); 192 verifyFormat("var regex = /a{1,3}/;"); 193 verifyFormat("var regex = /[abc]/;"); 194 verifyFormat("var regex = /[^abc]/;"); 195 verifyFormat("var regex = /[\\b]/;"); 196 verifyFormat("var regex = /\\b/;"); 197 verifyFormat("var regex = /\\B/;"); 198 verifyFormat("var regex = /\\d/;"); 199 verifyFormat("var regex = /\\D/;"); 200 verifyFormat("var regex = /\\f/;"); 201 verifyFormat("var regex = /\\n/;"); 202 verifyFormat("var regex = /\\r/;"); 203 verifyFormat("var regex = /\\s/;"); 204 verifyFormat("var regex = /\\S/;"); 205 verifyFormat("var regex = /\\t/;"); 206 verifyFormat("var regex = /\\v/;"); 207 verifyFormat("var regex = /\\w/;"); 208 verifyFormat("var regex = /\\W/;"); 209 verifyFormat("var regex = /a(a)\\1/;"); 210 verifyFormat("var regex = /\\0/;"); 211 verifyFormat("var regex = /\\\\/g;"); 212 verifyFormat("var regex = /\\a\\\\/g;"); 213 verifyFormat("var regex = /\a\\//g;"); 214 } 215 216 TEST_F(FormatTestJS, RegexLiteralModifiers) { 217 verifyFormat("var regex = /abc/g;"); 218 verifyFormat("var regex = /abc/i;"); 219 verifyFormat("var regex = /abc/m;"); 220 verifyFormat("var regex = /abc/y;"); 221 } 222 223 TEST_F(FormatTestJS, RegexLiteralLength) { 224 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 225 getGoogleJSStyleWithColumns(60)); 226 verifyFormat("var regex =\n" 227 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 228 getGoogleJSStyleWithColumns(60)); 229 } 230 231 TEST_F(FormatTestJS, RegexLiteralExamples) { 232 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);"); 233 } 234 235 } // end namespace tooling 236 } // end namespace clang 237