Summary: If this option is set, clang-format will always insert a line wrap, e.g. before the first parameter of a function call unless all parameters fit on the same line. This obviates the need to make a decision on the alignment itself. Use this style for Google's JavaScript style and add some minor tweaks to correctly handle nested blocks etc. with it. Don't use this option for for/while loops. Reviewers: klimek Subscribers: klimek, cfe-commits Differential Revision: http://reviews.llvm.org/D14104 llvm-svn: 251405
970 lines
34 KiB
C++
970 lines
34 KiB
C++
//===- unittest/Format/FormatTestJS.cpp - Formatting unit tests for JS ----===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "FormatTestUtils.h"
|
|
#include "clang/Format/Format.h"
|
|
#include "llvm/Support/Debug.h"
|
|
#include "gtest/gtest.h"
|
|
|
|
#define DEBUG_TYPE "format-test"
|
|
|
|
namespace clang {
|
|
namespace format {
|
|
|
|
class FormatTestJS : public ::testing::Test {
|
|
protected:
|
|
static std::string format(llvm::StringRef Code, unsigned Offset,
|
|
unsigned Length, const FormatStyle &Style) {
|
|
DEBUG(llvm::errs() << "---\n");
|
|
DEBUG(llvm::errs() << Code << "\n\n");
|
|
std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length));
|
|
bool IncompleteFormat = false;
|
|
tooling::Replacements Replaces =
|
|
reformat(Style, Code, Ranges, "<stdin>", &IncompleteFormat);
|
|
EXPECT_FALSE(IncompleteFormat);
|
|
std::string Result = applyAllReplacements(Code, Replaces);
|
|
EXPECT_NE("", Result);
|
|
DEBUG(llvm::errs() << "\n" << Result << "\n\n");
|
|
return Result;
|
|
}
|
|
|
|
static std::string format(
|
|
llvm::StringRef Code,
|
|
const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) {
|
|
return format(Code, 0, Code.size(), Style);
|
|
}
|
|
|
|
static FormatStyle getGoogleJSStyleWithColumns(unsigned ColumnLimit) {
|
|
FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
|
|
Style.ColumnLimit = ColumnLimit;
|
|
return Style;
|
|
}
|
|
|
|
static void verifyFormat(
|
|
llvm::StringRef Code,
|
|
const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) {
|
|
std::string result = format(test::messUp(Code), Style);
|
|
EXPECT_EQ(Code.str(), result) << "Formatted:\n" << result;
|
|
}
|
|
};
|
|
|
|
TEST_F(FormatTestJS, UnderstandsJavaScriptOperators) {
|
|
verifyFormat("a == = b;");
|
|
verifyFormat("a != = b;");
|
|
|
|
verifyFormat("a === b;");
|
|
verifyFormat("aaaaaaa ===\n b;", getGoogleJSStyleWithColumns(10));
|
|
verifyFormat("a !== b;");
|
|
verifyFormat("aaaaaaa !==\n b;", getGoogleJSStyleWithColumns(10));
|
|
verifyFormat("if (a + b + c +\n"
|
|
" d !==\n"
|
|
" e + f + g)\n"
|
|
" q();",
|
|
getGoogleJSStyleWithColumns(20));
|
|
|
|
verifyFormat("a >> >= b;");
|
|
|
|
verifyFormat("a >>> b;");
|
|
verifyFormat("aaaaaaa >>>\n b;", getGoogleJSStyleWithColumns(10));
|
|
verifyFormat("a >>>= b;");
|
|
verifyFormat("aaaaaaa >>>=\n b;", getGoogleJSStyleWithColumns(10));
|
|
verifyFormat("if (a + b + c +\n"
|
|
" d >>>\n"
|
|
" e + f + g)\n"
|
|
" q();",
|
|
getGoogleJSStyleWithColumns(20));
|
|
verifyFormat("var x = aaaaaaaaaa ?\n"
|
|
" bbbbbb :\n"
|
|
" ccc;",
|
|
getGoogleJSStyleWithColumns(20));
|
|
|
|
verifyFormat("var b = a.map((x) => x + 1);");
|
|
verifyFormat("return ('aaa') in bbbb;");
|
|
|
|
// ES6 spread operator.
|
|
verifyFormat("someFunction(...a);");
|
|
verifyFormat("var x = [1, ...a, 2];");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, UnderstandsAmpAmp) {
|
|
verifyFormat("e && e.SomeFunction();");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, LiteralOperatorsCanBeKeywords) {
|
|
verifyFormat("not.and.or.not_eq = 1;");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, ReservedWords) {
|
|
// JavaScript reserved words (aka keywords) are only illegal when used as
|
|
// Identifiers, but are legal as IdentifierNames.
|
|
verifyFormat("x.class.struct = 1;");
|
|
verifyFormat("x.case = 1;");
|
|
verifyFormat("x.interface = 1;");
|
|
verifyFormat("x = {\n"
|
|
" a: 12,\n"
|
|
" interface: 1,\n"
|
|
" switch: 1,\n"
|
|
"};");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, ES6DestructuringAssignment) {
|
|
verifyFormat("var [a, b, c] = [1, 2, 3];");
|
|
verifyFormat("let [a, b, c] = [1, 2, 3];");
|
|
verifyFormat("var {a, b} = {a: 1, b: 2};");
|
|
verifyFormat("let {a, b} = {a: 1, b: 2};");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, ContainerLiterals) {
|
|
verifyFormat("var x = {y: function(a) { return a; }};");
|
|
verifyFormat("return {\n"
|
|
" link: function() {\n"
|
|
" f(); //\n"
|
|
" }\n"
|
|
"};");
|
|
verifyFormat("return {\n"
|
|
" a: a,\n"
|
|
" link: function() {\n"
|
|
" f(); //\n"
|
|
" }\n"
|
|
"};");
|
|
verifyFormat("return {\n"
|
|
" a: a,\n"
|
|
" link: function() {\n"
|
|
" f(); //\n"
|
|
" },\n"
|
|
" link: function() {\n"
|
|
" f(); //\n"
|
|
" }\n"
|
|
"};");
|
|
verifyFormat("var stuff = {\n"
|
|
" // comment for update\n"
|
|
" update: false,\n"
|
|
" // comment for modules\n"
|
|
" modules: false,\n"
|
|
" // comment for tasks\n"
|
|
" tasks: false\n"
|
|
"};");
|
|
verifyFormat("return {\n"
|
|
" 'finish':\n"
|
|
" //\n"
|
|
" a\n"
|
|
"};");
|
|
verifyFormat("var obj = {\n"
|
|
" fooooooooo: function(x) {\n"
|
|
" return x.zIsTooLongForOneLineWithTheDeclarationLine();\n"
|
|
" }\n"
|
|
"};");
|
|
// Simple object literal, as opposed to enum style below.
|
|
verifyFormat("var obj = {a: 123};");
|
|
// Enum style top level assignment.
|
|
verifyFormat("X = {\n a: 123\n};");
|
|
verifyFormat("X.Y = {\n a: 123\n};");
|
|
// But only on the top level, otherwise its a plain object literal assignment.
|
|
verifyFormat("function x() {\n"
|
|
" y = {z: 1};\n"
|
|
"}");
|
|
verifyFormat("x = foo && {a: 123};");
|
|
|
|
// Arrow functions in object literals.
|
|
verifyFormat("var x = {y: (a) => { return a; }};");
|
|
verifyFormat("var x = {y: (a) => a};");
|
|
|
|
// Computed keys.
|
|
verifyFormat("var x = {[a]: 1, b: 2, [c]: 3};");
|
|
verifyFormat("var x = {\n"
|
|
" [a]: 1,\n"
|
|
" b: 2,\n"
|
|
" [c]: 3,\n"
|
|
"};");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, MethodsInObjectLiterals) {
|
|
verifyFormat("var o = {\n"
|
|
" value: 'test',\n"
|
|
" get value() { // getter\n"
|
|
" return this.value;\n"
|
|
" }\n"
|
|
"};");
|
|
verifyFormat("var o = {\n"
|
|
" value: 'test',\n"
|
|
" set value(val) { // setter\n"
|
|
" this.value = val;\n"
|
|
" }\n"
|
|
"};");
|
|
verifyFormat("var o = {\n"
|
|
" value: 'test',\n"
|
|
" someMethod(val) { // method\n"
|
|
" doSomething(this.value + val);\n"
|
|
" }\n"
|
|
"};");
|
|
verifyFormat("var o = {\n"
|
|
" someMethod(val) { // method\n"
|
|
" doSomething(this.value + val);\n"
|
|
" },\n"
|
|
" someOtherMethod(val) { // method\n"
|
|
" doSomething(this.value + val);\n"
|
|
" }\n"
|
|
"};");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, SpacesInContainerLiterals) {
|
|
verifyFormat("var arr = [1, 2, 3];");
|
|
verifyFormat("f({a: 1, b: 2, c: 3});");
|
|
|
|
verifyFormat("var object_literal_with_long_name = {\n"
|
|
" a: 'aaaaaaaaaaaaaaaaaa',\n"
|
|
" b: 'bbbbbbbbbbbbbbbbbb'\n"
|
|
"};");
|
|
|
|
verifyFormat("f({a: 1, b: 2, c: 3});",
|
|
getChromiumStyle(FormatStyle::LK_JavaScript));
|
|
verifyFormat("f({'a': [{}]});");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, SingleQuoteStrings) {
|
|
verifyFormat("this.function('', true);");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, GoogScopes) {
|
|
verifyFormat("goog.scope(function() {\n"
|
|
"var x = a.b;\n"
|
|
"var y = c.d;\n"
|
|
"}); // goog.scope");
|
|
verifyFormat("goog.scope(function() {\n"
|
|
"// test\n"
|
|
"var x = 0;\n"
|
|
"// test\n"
|
|
"});");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, GoogModules) {
|
|
verifyFormat("goog.module('this.is.really.absurdly.long');",
|
|
getGoogleJSStyleWithColumns(40));
|
|
verifyFormat("goog.require('this.is.really.absurdly.long');",
|
|
getGoogleJSStyleWithColumns(40));
|
|
verifyFormat("goog.provide('this.is.really.absurdly.long');",
|
|
getGoogleJSStyleWithColumns(40));
|
|
verifyFormat("var long = goog.require('this.is.really.absurdly.long');",
|
|
getGoogleJSStyleWithColumns(40));
|
|
|
|
// These should be wrapped normally.
|
|
verifyFormat(
|
|
"var MyLongClassName =\n"
|
|
" goog.module.get('my.long.module.name.followedBy.MyLongClassName');");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, FormatsFreestandingFunctions) {
|
|
verifyFormat("function outer1(a, b) {\n"
|
|
" function inner1(a, b) { return a; }\n"
|
|
" inner1(a, b);\n"
|
|
"}\n"
|
|
"function outer2(a, b) {\n"
|
|
" function inner2(a, b) { return a; }\n"
|
|
" inner2(a, b);\n"
|
|
"}");
|
|
verifyFormat("function f() {}");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, ArrayLiterals) {
|
|
verifyFormat("var aaaaa: List<SomeThing> =\n"
|
|
" [new SomeThingAAAAAAAAAAAA(), new SomeThingBBBBBBBBB()];");
|
|
verifyFormat("return [\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
|
|
" bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
|
|
" ccccccccccccccccccccccccccc\n"
|
|
"];");
|
|
verifyFormat("var someVariable = SomeFunction([\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
|
|
" bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
|
|
" ccccccccccccccccccccccccccc\n"
|
|
"]);");
|
|
verifyFormat("var someVariable = SomeFunction([\n"
|
|
" [aaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbb],\n"
|
|
"]);",
|
|
getGoogleJSStyleWithColumns(51));
|
|
verifyFormat("var someVariable = SomeFunction(aaaa, [\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
|
|
" bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
|
|
" ccccccccccccccccccccccccccc\n"
|
|
"]);");
|
|
verifyFormat("var someVariable = SomeFunction(\n"
|
|
" aaaa,\n"
|
|
" [\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
|
|
" bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
|
|
" ccccccccccccccccccccccccccc\n"
|
|
" ],\n"
|
|
" aaaa);");
|
|
|
|
verifyFormat("someFunction([], {a: a});");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, FunctionLiterals) {
|
|
verifyFormat("doFoo(function() {});");
|
|
verifyFormat("doFoo(function() { return 1; });");
|
|
verifyFormat("var func = function() {\n"
|
|
" return 1;\n"
|
|
"};");
|
|
verifyFormat("var func = //\n"
|
|
" function() {\n"
|
|
" return 1;\n"
|
|
"};");
|
|
verifyFormat("return {\n"
|
|
" body: {\n"
|
|
" setAttribute: function(key, val) { this[key] = val; },\n"
|
|
" getAttribute: function(key) { return this[key]; },\n"
|
|
" style: {direction: ''}\n"
|
|
" }\n"
|
|
"};");
|
|
verifyFormat("abc = xyz ? function() {\n"
|
|
" return 1;\n"
|
|
"} : function() {\n"
|
|
" return -1;\n"
|
|
"};");
|
|
|
|
verifyFormat("var closure = goog.bind(\n"
|
|
" function() { // comment\n"
|
|
" foo();\n"
|
|
" bar();\n"
|
|
" },\n"
|
|
" this, arg1IsReallyLongAndNeeedsLineBreaks,\n"
|
|
" arg3IsReallyLongAndNeeedsLineBreaks);");
|
|
verifyFormat("var closure = goog.bind(function() { // comment\n"
|
|
" foo();\n"
|
|
" bar();\n"
|
|
"}, this);");
|
|
verifyFormat("return {\n"
|
|
" a: 'E',\n"
|
|
" b: function() {\n"
|
|
" return function() {\n"
|
|
" f(); //\n"
|
|
" };\n"
|
|
" }\n"
|
|
"};");
|
|
verifyFormat("{\n"
|
|
" var someVariable = function(x) {\n"
|
|
" return x.zIsTooLongForOneLineWithTheDeclarationLine();\n"
|
|
" };\n"
|
|
"}");
|
|
verifyFormat("someLooooooooongFunction(\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
|
|
" function(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
|
|
" // code\n"
|
|
" });");
|
|
|
|
verifyFormat("f({a: function() { return 1; }});",
|
|
getGoogleJSStyleWithColumns(33));
|
|
verifyFormat("f({\n"
|
|
" a: function() { return 1; }\n"
|
|
"});",
|
|
getGoogleJSStyleWithColumns(32));
|
|
|
|
verifyFormat("return {\n"
|
|
" a: function SomeFunction() {\n"
|
|
" // ...\n"
|
|
" return 1;\n"
|
|
" }\n"
|
|
"};");
|
|
verifyFormat("this.someObject.doSomething(aaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
|
|
" .then(goog.bind(function(aaaaaaaaaaa) {\n"
|
|
" someFunction();\n"
|
|
" someFunction();\n"
|
|
" }, this), aaaaaaaaaaaaaaaaa);");
|
|
|
|
verifyFormat("someFunction(goog.bind(function() {\n"
|
|
" doSomething();\n"
|
|
" doSomething();\n"
|
|
"}, this), goog.bind(function() {\n"
|
|
" doSomething();\n"
|
|
" doSomething();\n"
|
|
"}, this));");
|
|
|
|
// FIXME: This is bad, we should be wrapping before "function() {".
|
|
verifyFormat("someFunction(function() {\n"
|
|
" doSomething(); // break\n"
|
|
"})\n"
|
|
" .doSomethingElse(\n"
|
|
" // break\n"
|
|
" );");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, InliningFunctionLiterals) {
|
|
FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
|
|
Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
|
|
verifyFormat("var func = function() {\n"
|
|
" return 1;\n"
|
|
"};",
|
|
Style);
|
|
verifyFormat("var func = doSomething(function() { return 1; });", Style);
|
|
verifyFormat("var outer = function() {\n"
|
|
" var inner = function() { return 1; }\n"
|
|
"};",
|
|
Style);
|
|
verifyFormat("function outer1(a, b) {\n"
|
|
" function inner1(a, b) { return a; }\n"
|
|
"}",
|
|
Style);
|
|
|
|
Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
|
|
verifyFormat("var func = function() { return 1; };", Style);
|
|
verifyFormat("var func = doSomething(function() { return 1; });", Style);
|
|
verifyFormat(
|
|
"var outer = function() { var inner = function() { return 1; } };",
|
|
Style);
|
|
verifyFormat("function outer1(a, b) {\n"
|
|
" function inner1(a, b) { return a; }\n"
|
|
"}",
|
|
Style);
|
|
|
|
Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
|
|
verifyFormat("var func = function() {\n"
|
|
" return 1;\n"
|
|
"};",
|
|
Style);
|
|
verifyFormat("var func = doSomething(function() {\n"
|
|
" return 1;\n"
|
|
"});",
|
|
Style);
|
|
verifyFormat("var outer = function() {\n"
|
|
" var inner = function() {\n"
|
|
" return 1;\n"
|
|
" }\n"
|
|
"};",
|
|
Style);
|
|
verifyFormat("function outer1(a, b) {\n"
|
|
" function inner1(a, b) {\n"
|
|
" return a;\n"
|
|
" }\n"
|
|
"}",
|
|
Style);
|
|
}
|
|
|
|
TEST_F(FormatTestJS, MultipleFunctionLiterals) {
|
|
verifyFormat("promise.then(\n"
|
|
" function success() {\n"
|
|
" doFoo();\n"
|
|
" doBar();\n"
|
|
" },\n"
|
|
" function error() {\n"
|
|
" doFoo();\n"
|
|
" doBaz();\n"
|
|
" },\n"
|
|
" []);\n");
|
|
verifyFormat("promise.then(\n"
|
|
" function success() {\n"
|
|
" doFoo();\n"
|
|
" doBar();\n"
|
|
" },\n"
|
|
" [],\n"
|
|
" function error() {\n"
|
|
" doFoo();\n"
|
|
" doBaz();\n"
|
|
" });\n");
|
|
verifyFormat("promise.then(\n"
|
|
" [],\n"
|
|
" function success() {\n"
|
|
" doFoo();\n"
|
|
" doBar();\n"
|
|
" },\n"
|
|
" function error() {\n"
|
|
" doFoo();\n"
|
|
" doBaz();\n"
|
|
" });\n");
|
|
|
|
verifyFormat("getSomeLongPromise()\n"
|
|
" .then(function(value) { body(); })\n"
|
|
" .thenCatch(function(error) {\n"
|
|
" body();\n"
|
|
" body();\n"
|
|
" });");
|
|
verifyFormat("getSomeLongPromise()\n"
|
|
" .then(function(value) {\n"
|
|
" body();\n"
|
|
" body();\n"
|
|
" })\n"
|
|
" .thenCatch(function(error) {\n"
|
|
" body();\n"
|
|
" body();\n"
|
|
" });");
|
|
|
|
verifyFormat("getSomeLongPromise()\n"
|
|
" .then(function(value) { body(); })\n"
|
|
" .thenCatch(function(error) { body(); });");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, ArrowFunctions) {
|
|
verifyFormat("var x = (a) => {\n"
|
|
" return a;\n"
|
|
"};");
|
|
verifyFormat("var x = (a) => {\n"
|
|
" function y() { return 42; }\n"
|
|
" return a;\n"
|
|
"};");
|
|
verifyFormat("var x = (a: type): {some: type} => {\n"
|
|
" return a;\n"
|
|
"};");
|
|
verifyFormat("var x = (a) => a;");
|
|
verifyFormat("return () => [];");
|
|
verifyFormat("var aaaaaaaaaaaaaaaaaaaa = {\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaaa:\n"
|
|
" (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) =>\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
|
|
"};");
|
|
verifyFormat("var a = a.aaaaaaa(\n"
|
|
" (a: a) => aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) &&\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbb));");
|
|
verifyFormat("var a = a.aaaaaaa(\n"
|
|
" (a: a) => aaaaaaaaaaaaaaaaaaaaa(bbbbbbbbb) ?\n"
|
|
" aaaaaaaaaaaaaaaaaaaaa(bbbbbbb) :\n"
|
|
" aaaaaaaaaaaaaaaaaaaaa(bbbbbbb));");
|
|
|
|
// FIXME: This is bad, we should be wrapping before "() => {".
|
|
verifyFormat("someFunction(() => {\n"
|
|
" doSomething(); // break\n"
|
|
"})\n"
|
|
" .doSomethingElse(\n"
|
|
" // break\n"
|
|
" );");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, ReturnStatements) {
|
|
verifyFormat("function() {\n"
|
|
" return [hello, world];\n"
|
|
"}");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, AutomaticSemicolonInsertion) {
|
|
// The following statements must not wrap, as otherwise the program meaning
|
|
// would change due to automatic semicolon insertion.
|
|
// See http://www.ecma-international.org/ecma-262/5.1/#sec-7.9.1.
|
|
verifyFormat("return aaaaa;", getGoogleJSStyleWithColumns(10));
|
|
verifyFormat("continue aaaaa;", getGoogleJSStyleWithColumns(10));
|
|
verifyFormat("break aaaaa;", getGoogleJSStyleWithColumns(10));
|
|
verifyFormat("throw aaaaa;", getGoogleJSStyleWithColumns(10));
|
|
verifyFormat("aaaaaaaaa++;", getGoogleJSStyleWithColumns(10));
|
|
verifyFormat("aaaaaaaaa--;", getGoogleJSStyleWithColumns(10));
|
|
}
|
|
|
|
TEST_F(FormatTestJS, ClosureStyleCasts) {
|
|
verifyFormat("var x = /** @type {foo} */ (bar);");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, TryCatch) {
|
|
verifyFormat("try {\n"
|
|
" f();\n"
|
|
"} catch (e) {\n"
|
|
" g();\n"
|
|
"} finally {\n"
|
|
" h();\n"
|
|
"}");
|
|
|
|
// But, of course, "catch" is a perfectly fine function name in JavaScript.
|
|
verifyFormat("someObject.catch();");
|
|
verifyFormat("someObject.new();");
|
|
verifyFormat("someObject.delete();");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, StringLiteralConcatenation) {
|
|
verifyFormat("var literal = 'hello ' +\n"
|
|
" 'world';");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, RegexLiteralClassification) {
|
|
// Regex literals.
|
|
verifyFormat("var regex = /abc/;");
|
|
verifyFormat("f(/abc/);");
|
|
verifyFormat("f(abc, /abc/);");
|
|
verifyFormat("some_map[/abc/];");
|
|
verifyFormat("var x = a ? /abc/ : /abc/;");
|
|
verifyFormat("for (var i = 0; /abc/.test(s[i]); i++) {\n}");
|
|
verifyFormat("var x = !/abc/.test(y);");
|
|
verifyFormat("var x = a && /abc/.test(y);");
|
|
verifyFormat("var x = a || /abc/.test(y);");
|
|
verifyFormat("var x = a + /abc/.search(y);");
|
|
verifyFormat("/abc/.search(y);");
|
|
verifyFormat("var regexs = {/abc/, /abc/};");
|
|
verifyFormat("return /abc/;");
|
|
|
|
// Not regex literals.
|
|
verifyFormat("var a = a / 2 + b / 3;");
|
|
verifyFormat("var a = a++ / 2;");
|
|
// Prefix unary can operate on regex literals, not that it makes sense.
|
|
verifyFormat("var a = ++/a/;");
|
|
|
|
// This is a known issue, regular expressions are incorrectly detected if
|
|
// directly following a closing parenthesis.
|
|
verifyFormat("if (foo) / bar /.exec(baz);");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, RegexLiteralSpecialCharacters) {
|
|
verifyFormat("var regex = /=/;");
|
|
verifyFormat("var regex = /a*/;");
|
|
verifyFormat("var regex = /a+/;");
|
|
verifyFormat("var regex = /a?/;");
|
|
verifyFormat("var regex = /.a./;");
|
|
verifyFormat("var regex = /a\\*/;");
|
|
verifyFormat("var regex = /^a$/;");
|
|
verifyFormat("var regex = /\\/a/;");
|
|
verifyFormat("var regex = /(?:x)/;");
|
|
verifyFormat("var regex = /x(?=y)/;");
|
|
verifyFormat("var regex = /x(?!y)/;");
|
|
verifyFormat("var regex = /x|y/;");
|
|
verifyFormat("var regex = /a{2}/;");
|
|
verifyFormat("var regex = /a{1,3}/;");
|
|
|
|
verifyFormat("var regex = /[abc]/;");
|
|
verifyFormat("var regex = /[^abc]/;");
|
|
verifyFormat("var regex = /[\\b]/;");
|
|
verifyFormat("var regex = /[/]/;");
|
|
verifyFormat("var regex = /[\\/]/;");
|
|
verifyFormat("var regex = /\\[/;");
|
|
verifyFormat("var regex = /\\\\[/]/;");
|
|
verifyFormat("var regex = /}[\"]/;");
|
|
verifyFormat("var regex = /}[/\"]/;");
|
|
verifyFormat("var regex = /}[\"/]/;");
|
|
|
|
verifyFormat("var regex = /\\b/;");
|
|
verifyFormat("var regex = /\\B/;");
|
|
verifyFormat("var regex = /\\d/;");
|
|
verifyFormat("var regex = /\\D/;");
|
|
verifyFormat("var regex = /\\f/;");
|
|
verifyFormat("var regex = /\\n/;");
|
|
verifyFormat("var regex = /\\r/;");
|
|
verifyFormat("var regex = /\\s/;");
|
|
verifyFormat("var regex = /\\S/;");
|
|
verifyFormat("var regex = /\\t/;");
|
|
verifyFormat("var regex = /\\v/;");
|
|
verifyFormat("var regex = /\\w/;");
|
|
verifyFormat("var regex = /\\W/;");
|
|
verifyFormat("var regex = /a(a)\\1/;");
|
|
verifyFormat("var regex = /\\0/;");
|
|
verifyFormat("var regex = /\\\\/g;");
|
|
verifyFormat("var regex = /\\a\\\\/g;");
|
|
verifyFormat("var regex = /\a\\//g;");
|
|
verifyFormat("var regex = /a\\//;\n"
|
|
"var x = 0;");
|
|
EXPECT_EQ("var regex = /'/g;", format("var regex = /'/g ;"));
|
|
EXPECT_EQ("var regex = /'/g; //'", format("var regex = /'/g ; //'"));
|
|
EXPECT_EQ("var regex = /\\/*/;\n"
|
|
"var x = 0;",
|
|
format("var regex = /\\/*/;\n"
|
|
"var x=0;"));
|
|
EXPECT_EQ("var x = /a\\//;", format("var x = /a\\// \n;"));
|
|
verifyFormat("var regex = /\"/;", getGoogleJSStyleWithColumns(16));
|
|
verifyFormat("var regex =\n"
|
|
" /\"/;",
|
|
getGoogleJSStyleWithColumns(15));
|
|
verifyFormat("var regex = //\n"
|
|
" /a/;");
|
|
verifyFormat("var regexs = [\n"
|
|
" /d/, //\n"
|
|
" /aa/, //\n"
|
|
"];");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, RegexLiteralModifiers) {
|
|
verifyFormat("var regex = /abc/g;");
|
|
verifyFormat("var regex = /abc/i;");
|
|
verifyFormat("var regex = /abc/m;");
|
|
verifyFormat("var regex = /abc/y;");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, RegexLiteralLength) {
|
|
verifyFormat("var regex = /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
|
|
getGoogleJSStyleWithColumns(60));
|
|
verifyFormat("var regex =\n"
|
|
" /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
|
|
getGoogleJSStyleWithColumns(60));
|
|
verifyFormat("var regex = /\\xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/;",
|
|
getGoogleJSStyleWithColumns(50));
|
|
}
|
|
|
|
TEST_F(FormatTestJS, RegexLiteralExamples) {
|
|
verifyFormat("var regex = search.match(/(?:\?|&)times=([^?&]+)/i);");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, TypeAnnotations) {
|
|
verifyFormat("var x: string;");
|
|
verifyFormat("function x(): string {\n return 'x';\n}");
|
|
verifyFormat("function x(): {x: string} {\n return {x: 'x'};\n}");
|
|
verifyFormat("function x(y: string): string {\n return 'x';\n}");
|
|
verifyFormat("for (var y: string in x) {\n x();\n}");
|
|
verifyFormat("((a: string, b: number): string => a + b);");
|
|
verifyFormat("var x: (y: number) => string;");
|
|
verifyFormat("var x: P<string, (a: number) => string>;");
|
|
verifyFormat("var x = {y: function(): z { return 1; }};");
|
|
verifyFormat("var x = {y: function(): {a: number} { return 1; }};");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, ClassDeclarations) {
|
|
verifyFormat("class C {\n x: string = 12;\n}");
|
|
verifyFormat("class C {\n x(): string => 12;\n}");
|
|
verifyFormat("class C {\n ['x' + 2]: string = 12;\n}");
|
|
verifyFormat("class C {\n private x: string = 12;\n}");
|
|
verifyFormat("class C {\n private static x: string = 12;\n}");
|
|
verifyFormat("class C {\n static x(): string { return 'asd'; }\n}");
|
|
verifyFormat("class C extends P implements I {}");
|
|
verifyFormat("class C extends p.P implements i.I {}");
|
|
verifyFormat("class Test {\n"
|
|
" aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaaa):\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaa {}\n"
|
|
"}");
|
|
|
|
// ':' is not a type declaration here.
|
|
verifyFormat("class X {\n"
|
|
" subs = {\n"
|
|
" 'b': {\n"
|
|
" 'c': 1,\n"
|
|
" },\n"
|
|
" };\n"
|
|
"}");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, InterfaceDeclarations) {
|
|
verifyFormat("interface I {\n"
|
|
" x: string;\n"
|
|
"}\n"
|
|
"var y;");
|
|
// Ensure that state is reset after parsing the interface.
|
|
verifyFormat("interface a {}\n"
|
|
"export function b() {}\n"
|
|
"var x;");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, EnumDeclarations) {
|
|
verifyFormat("enum Foo {\n"
|
|
" A = 1,\n"
|
|
" B\n"
|
|
"}");
|
|
verifyFormat("export /* somecomment*/ enum Foo {\n"
|
|
" A = 1,\n"
|
|
" B\n"
|
|
"}");
|
|
verifyFormat("enum Foo {\n"
|
|
" A = 1, // comment\n"
|
|
" B\n"
|
|
"}\n"
|
|
"var x = 1;");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, MetadataAnnotations) {
|
|
verifyFormat("@A\nclass C {\n}");
|
|
verifyFormat("@A({arg: 'value'})\nclass C {\n}");
|
|
verifyFormat("@A\n@B\nclass C {\n}");
|
|
verifyFormat("class C {\n @A x: string;\n}");
|
|
verifyFormat("class C {\n"
|
|
" @A\n"
|
|
" private x(): string {\n"
|
|
" return 'y';\n"
|
|
" }\n"
|
|
"}");
|
|
verifyFormat("class X {}\n"
|
|
"class Y {}");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, Modules) {
|
|
verifyFormat("import SomeThing from 'some/module.js';");
|
|
verifyFormat("import {X, Y} from 'some/module.js';");
|
|
verifyFormat("import {\n"
|
|
" VeryLongImportsAreAnnoying,\n"
|
|
" VeryLongImportsAreAnnoying,\n"
|
|
" VeryLongImportsAreAnnoying,\n"
|
|
" VeryLongImportsAreAnnoying\n"
|
|
"} from 'some/module.js';");
|
|
verifyFormat("import {\n"
|
|
" X,\n"
|
|
" Y,\n"
|
|
"} from 'some/module.js';");
|
|
verifyFormat("import {\n"
|
|
" X,\n"
|
|
" Y,\n"
|
|
"} from 'some/long/module.js';",
|
|
getGoogleJSStyleWithColumns(20));
|
|
verifyFormat("import {X as myLocalX, Y as myLocalY} from 'some/module.js';");
|
|
verifyFormat("import * as lib from 'some/module.js';");
|
|
verifyFormat("var x = {import: 1};\nx.import = 2;");
|
|
|
|
verifyFormat("export function fn() {\n"
|
|
" return 'fn';\n"
|
|
"}");
|
|
verifyFormat("export function A() {}\n"
|
|
"export default function B() {}\n"
|
|
"export function C() {}");
|
|
verifyFormat("export const x = 12;");
|
|
verifyFormat("export default class X {}");
|
|
verifyFormat("export {X, Y} from 'some/module.js';");
|
|
verifyFormat("export {\n"
|
|
" X,\n"
|
|
" Y,\n"
|
|
"} from 'some/module.js';");
|
|
verifyFormat("export class C {\n"
|
|
" x: number;\n"
|
|
" y: string;\n"
|
|
"}");
|
|
verifyFormat("export class X { y: number; }");
|
|
verifyFormat("export default class X { y: number }");
|
|
verifyFormat("export default function() {\n return 1;\n}");
|
|
verifyFormat("export var x = 12;");
|
|
verifyFormat("class C {}\n"
|
|
"export function f() {}\n"
|
|
"var v;");
|
|
verifyFormat("export var x: number = 12;");
|
|
verifyFormat("export const y = {\n"
|
|
" a: 1,\n"
|
|
" b: 2\n"
|
|
"};");
|
|
verifyFormat("export enum Foo {\n"
|
|
" BAR,\n"
|
|
" // adsdasd\n"
|
|
" BAZ\n"
|
|
"}");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, TemplateStrings) {
|
|
// Keeps any whitespace/indentation within the template string.
|
|
EXPECT_EQ("var x = `hello\n"
|
|
" ${ name }\n"
|
|
" !`;",
|
|
format("var x = `hello\n"
|
|
" ${ name }\n"
|
|
" !`;"));
|
|
|
|
verifyFormat("var x =\n"
|
|
" `hello ${world}` >= some();",
|
|
getGoogleJSStyleWithColumns(34)); // Barely doesn't fit.
|
|
verifyFormat("var x = `hello ${world}` >= some();",
|
|
getGoogleJSStyleWithColumns(35)); // Barely fits.
|
|
EXPECT_EQ("var x = `hello\n"
|
|
" ${world}` >=\n"
|
|
" some();",
|
|
format("var x =\n"
|
|
" `hello\n"
|
|
" ${world}` >= some();",
|
|
getGoogleJSStyleWithColumns(21))); // Barely doesn't fit.
|
|
EXPECT_EQ("var x = `hello\n"
|
|
" ${world}` >= some();",
|
|
format("var x =\n"
|
|
" `hello\n"
|
|
" ${world}` >= some();",
|
|
getGoogleJSStyleWithColumns(22))); // Barely fits.
|
|
|
|
verifyFormat("var x =\n"
|
|
" `h`;",
|
|
getGoogleJSStyleWithColumns(11));
|
|
EXPECT_EQ(
|
|
"var x =\n `multi\n line`;",
|
|
format("var x = `multi\n line`;", getGoogleJSStyleWithColumns(13)));
|
|
verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
|
|
" `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`);");
|
|
|
|
// Make sure template strings get a proper ColumnWidth assigned, even if they
|
|
// are first token in line.
|
|
verifyFormat(
|
|
"var a = aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
|
|
" `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`;");
|
|
|
|
// Two template strings.
|
|
verifyFormat("var x = `hello` == `hello`;");
|
|
|
|
// Comments in template strings.
|
|
EXPECT_EQ("var x = `//a`;\n"
|
|
"var y;",
|
|
format("var x =\n `//a`;\n"
|
|
"var y ;"));
|
|
EXPECT_EQ("var x = `/*a`;\n"
|
|
"var y;",
|
|
format("var x =\n `/*a`;\n"
|
|
"var y;"));
|
|
// Unterminated string literals in a template string.
|
|
verifyFormat("var x = `'`; // comment with matching quote '\n"
|
|
"var y;");
|
|
verifyFormat("var x = `\"`; // comment with matching quote \"\n"
|
|
"var y;");
|
|
// Backticks in a comment - not a template string.
|
|
EXPECT_EQ("var x = 1 // `/*a`;\n"
|
|
" ;",
|
|
format("var x =\n 1 // `/*a`;\n"
|
|
" ;"));
|
|
EXPECT_EQ("/* ` */ var x = 1; /* ` */",
|
|
format("/* ` */ var x\n= 1; /* ` */"));
|
|
// Comment spans multiple template strings.
|
|
EXPECT_EQ("var x = `/*a`;\n"
|
|
"var y = ` */ `;",
|
|
format("var x =\n `/*a`;\n"
|
|
"var y =\n ` */ `;"));
|
|
// Escaped backtick.
|
|
EXPECT_EQ("var x = ` \\` a`;\n"
|
|
"var y;",
|
|
format("var x = ` \\` a`;\n"
|
|
"var y;"));
|
|
}
|
|
|
|
TEST_F(FormatTestJS, CastSyntax) { verifyFormat("var x = <type>foo;"); }
|
|
|
|
TEST_F(FormatTestJS, TypeArguments) {
|
|
verifyFormat("class X<Y> {}");
|
|
verifyFormat("new X<Y>();");
|
|
verifyFormat("foo<Y>(a);");
|
|
verifyFormat("var x: X<Y>[];");
|
|
verifyFormat("class C extends D<E> implements F<G>, H<I> {}");
|
|
verifyFormat("function f(a: List<any> = null) {}");
|
|
verifyFormat("function f(): List<any> {}");
|
|
verifyFormat("function aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa():\n"
|
|
" bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb {}");
|
|
verifyFormat("function aaaaaaaaaa(\n"
|
|
" aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa,\n"
|
|
" aaaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaa):\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa {}");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, OptionalTypes) {
|
|
verifyFormat("function x(a?: b, c?, d?) {}");
|
|
verifyFormat("class X {\n"
|
|
" y?: z;\n"
|
|
" z?;\n"
|
|
"}");
|
|
verifyFormat("interface X {\n"
|
|
" y?(): z;\n"
|
|
"}");
|
|
verifyFormat("x ? 1 : 2;");
|
|
verifyFormat("constructor({aa}: {\n"
|
|
" aa?: string,\n"
|
|
" aaaaaaaa?: string,\n"
|
|
" aaaaaaaaaaaaaaa?: boolean,\n"
|
|
" aaaaaa?: List<string>\n"
|
|
"}) {}");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, IndexSignature) {
|
|
verifyFormat("var x: {[k: string]: v};");
|
|
}
|
|
|
|
TEST_F(FormatTestJS, WrapAfterParen) {
|
|
verifyFormat("xxxxxxxxxxx(\n"
|
|
" aaa, aaa);",
|
|
getGoogleJSStyleWithColumns(20));
|
|
verifyFormat("xxxxxxxxxxx(\n"
|
|
" aaa, aaa, aaa,\n"
|
|
" aaa, aaa, aaa);",
|
|
getGoogleJSStyleWithColumns(20));
|
|
verifyFormat("xxxxxxxxxxx(\n"
|
|
" aaaaaaaaaaaaaaaaaaaaaaaa,\n"
|
|
" function(x) {\n"
|
|
" y(); //\n"
|
|
" });",
|
|
getGoogleJSStyleWithColumns(40));
|
|
verifyFormat("while (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n"
|
|
" bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}");
|
|
}
|
|
|
|
} // end namespace tooling
|
|
} // end namespace clang
|