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(llvm::StringRef Code, const FormatStyle &Style) { 35 return format(Code, 0, Code.size(), Style); 36 } 37 38 static FormatStyle getGoogleJSStyleWithColumns(unsigned ColumnLimit) { 39 FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript); 40 Style.ColumnLimit = ColumnLimit; 41 return Style; 42 } 43 44 static void verifyFormat( 45 llvm::StringRef Code, 46 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) { 47 EXPECT_EQ(Code.str(), format(test::messUp(Code), Style)); 48 } 49 }; 50 51 TEST_F(FormatTestJS, UnderstandsJavaScriptOperators) { 52 verifyFormat("a == = b;"); 53 verifyFormat("a != = b;"); 54 55 verifyFormat("a === b;"); 56 verifyFormat("aaaaaaa ===\n b;", getGoogleJSStyleWithColumns(10)); 57 verifyFormat("a !== b;"); 58 verifyFormat("aaaaaaa !==\n b;", getGoogleJSStyleWithColumns(10)); 59 verifyFormat("if (a + b + c +\n" 60 " d !==\n" 61 " e + f + g)\n" 62 " q();", 63 getGoogleJSStyleWithColumns(20)); 64 65 verifyFormat("a >> >= b;"); 66 67 verifyFormat("a >>> b;"); 68 verifyFormat("aaaaaaa >>>\n b;", getGoogleJSStyleWithColumns(10)); 69 verifyFormat("a >>>= b;"); 70 verifyFormat("aaaaaaa >>>=\n b;", getGoogleJSStyleWithColumns(10)); 71 verifyFormat("if (a + b + c +\n" 72 " d >>>\n" 73 " e + f + g)\n" 74 " q();", 75 getGoogleJSStyleWithColumns(20)); 76 verifyFormat("var x = aaaaaaaaaa ?\n" 77 " bbbbbb :\n" 78 " ccc;", 79 getGoogleJSStyleWithColumns(20)); 80 81 verifyFormat("var b = a.map((x) => x + 1);"); 82 } 83 84 TEST_F(FormatTestJS, SpacesInContainerLiterals) { 85 verifyFormat("var arr = [1, 2, 3];"); 86 verifyFormat("var obj = {a: 1, b: 2, c: 3};"); 87 88 verifyFormat("var obj = {a: 1, b: 2, c: 3};", 89 getChromiumStyle(FormatStyle::LK_JavaScript)); 90 verifyFormat("someVariable = {'a': [{}]};"); 91 } 92 93 TEST_F(FormatTestJS, SingleQuoteStrings) { 94 verifyFormat("this.function('', true);"); 95 } 96 97 TEST_F(FormatTestJS, GoogScopes) { 98 verifyFormat("goog.scope(function() {\n" 99 "var x = a.b;\n" 100 "var y = c.d;\n" 101 "}); // goog.scope"); 102 } 103 104 TEST_F(FormatTestJS, Closures) { 105 verifyFormat("doFoo(function() { return 1; });"); 106 verifyFormat("var func = function() { return 1; };"); 107 verifyFormat("return {\n" 108 " body: {\n" 109 " setAttribute: function(key, val) { this[key] = val; },\n" 110 " getAttribute: function(key) { return this[key]; },\n" 111 " style: {direction: ''}\n" 112 " }\n" 113 "};"); 114 } 115 116 TEST_F(FormatTestJS, ReturnStatements) { 117 verifyFormat("function() { return [hello, world]; }"); 118 } 119 120 TEST_F(FormatTestJS, ClosureStyleComments) { 121 verifyFormat("var x = /** @type {foo} */ (bar);"); 122 } 123 124 TEST_F(FormatTestJS, TryCatch) { 125 verifyFormat("try {\n" 126 " f();\n" 127 "} catch (e) {\n" 128 " g();\n" 129 "} finally {\n" 130 " h();\n" 131 "}"); 132 } 133 134 TEST_F(FormatTestJS, RegexLiteralClassification) { 135 // Regex literals. 136 verifyFormat("var regex = /abc/;"); 137 verifyFormat("f(/abc/);"); 138 verifyFormat("f(abc, /abc/);"); 139 verifyFormat("some_map[/abc/];"); 140 verifyFormat("var x = a ? /abc/ : /abc/;"); 141 verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}"); 142 verifyFormat("var x = !/abc/.test(y);"); 143 verifyFormat("var x = a && /abc/.test(y);"); 144 verifyFormat("var x = a || /abc/.test(y);"); 145 verifyFormat("var x = a + /abc/.search(y);"); 146 verifyFormat("var regexs = {/abc/, /abc/};"); 147 verifyFormat("return /abc/;"); 148 149 // Not regex literals. 150 verifyFormat("var a = a / 2 + b / 3;"); 151 } 152 153 TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) { 154 verifyFormat("var regex = /a*/;"); 155 verifyFormat("var regex = /a+/;"); 156 verifyFormat("var regex = /a?/;"); 157 verifyFormat("var regex = /.a./;"); 158 verifyFormat("var regex = /a\\*/;"); 159 verifyFormat("var regex = /^a$/;"); 160 verifyFormat("var regex = /\\/a/;"); 161 verifyFormat("var regex = /(?:x)/;"); 162 verifyFormat("var regex = /x(?=y)/;"); 163 verifyFormat("var regex = /x(?!y)/;"); 164 verifyFormat("var regex = /x|y/;"); 165 verifyFormat("var regex = /a{2}/;"); 166 verifyFormat("var regex = /a{1,3}/;"); 167 verifyFormat("var regex = /[abc]/;"); 168 verifyFormat("var regex = /[^abc]/;"); 169 verifyFormat("var regex = /[\\b]/;"); 170 verifyFormat("var regex = /\\b/;"); 171 verifyFormat("var regex = /\\B/;"); 172 verifyFormat("var regex = /\\d/;"); 173 verifyFormat("var regex = /\\D/;"); 174 verifyFormat("var regex = /\\f/;"); 175 verifyFormat("var regex = /\\n/;"); 176 verifyFormat("var regex = /\\r/;"); 177 verifyFormat("var regex = /\\s/;"); 178 verifyFormat("var regex = /\\S/;"); 179 verifyFormat("var regex = /\\t/;"); 180 verifyFormat("var regex = /\\v/;"); 181 verifyFormat("var regex = /\\w/;"); 182 verifyFormat("var regex = /\\W/;"); 183 verifyFormat("var regex = /a(a)\\1/;"); 184 verifyFormat("var regex = /\\0/;"); 185 verifyFormat("var regex = /\\\\/g;"); 186 verifyFormat("var regex = /\\a\\\\/g;"); 187 verifyFormat("var regex = /\a\\//g;"); 188 } 189 190 TEST_F(FormatTestJS, RegexLiteralModifiers) { 191 verifyFormat("var regex = /abc/g;"); 192 verifyFormat("var regex = /abc/i;"); 193 verifyFormat("var regex = /abc/m;"); 194 verifyFormat("var regex = /abc/y;"); 195 } 196 197 TEST_F(FormatTestJS, RegexLiteralLength) { 198 verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 199 getGoogleJSStyleWithColumns(60)); 200 verifyFormat("var regex =\n" 201 " /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;", 202 getGoogleJSStyleWithColumns(60)); 203 } 204 205 TEST_F(FormatTestJS, RegexLiteralExamples) { 206 verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);"); 207 } 208 209 } // end namespace tooling 210 } // end namespace clang 211