llvm-capstone/clang/unittests/Format/FormatTestJS.cpp
sstwcw ddc80637cc [clang-format] Break long string literals in C#, etc.
Now strings that are too long for one line in C#, Java, JavaScript, and
Verilog get broken into several lines.  C# and JavaScript interpolated
strings are not broken.

A new subclass BreakableStringLiteralUsingOperators is used to handle
the logic for adding plus signs and commas.  The updateAfterBroken
method was added because now parentheses or braces may be required after
the parentheses or commas are added.  In order to decide whether the
added plus sign should be unindented in the BreakableToken object, the
logic for it is taken out into a separate function
shouldUnindentNextOperator.

The logic for finding the continuation indentation when the option
AlignAfterOpenBracket is set to DontAlign is not implemented yet.  So in
that case the new line may have the wrong indentation, and the parts may
have the wrong length if the string needs to be broken more than once
because finding where to break the string depends on where the string
starts.

The preambles for the C# and Java unit tests are changed to the newer
style in order to allow the 3-argument verifyFormat macro.  Some cases
are changed from verifyFormat to verifyImcompleteFormat because those
use incomplete code and the new verifyFormat function checks that the
code is complete.

The line in the doc was changed to being indented by 4 spaces, that is,
the default continuation indentation.  It has always been the case.  It
was probably a mistake that the doc showed 2 spaces previously.

This commit was fist committed as 16ccba51072b.  The tests caused
assertion failures.  Then it was reverted in 547bce36132a.

Reviewed By: MyDeveloperDay

Differential Revision: https://reviews.llvm.org/D154093
2023-09-05 03:19:49 +00:00

2927 lines
101 KiB
C++

//===- unittest/Format/FormatTestJS.cpp - Formatting unit tests for JS ----===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#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) {
LLVM_DEBUG(llvm::errs() << "---\n");
LLVM_DEBUG(llvm::errs() << Code << "\n\n");
std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length));
FormattingAttemptStatus Status;
tooling::Replacements Replaces =
reformat(Style, Code, Ranges, "<stdin>", &Status);
EXPECT_TRUE(Status.FormatComplete);
auto Result = applyAllReplacements(Code, Replaces);
EXPECT_TRUE(static_cast<bool>(Result));
LLVM_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)) {
EXPECT_EQ(Code.str(), format(Code, Style)) << "Expected code is not stable";
std::string Result = format(test::messUp(Code), Style);
EXPECT_EQ(Code.str(), Result) << "Formatted:\n" << Result;
}
static void verifyFormat(
llvm::StringRef Expected, llvm::StringRef Code,
const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_JavaScript)) {
EXPECT_EQ(Expected.str(), format(Expected, Style))
<< "Expected code is not stable";
std::string Result = format(Code, Style);
EXPECT_EQ(Expected.str(), Result) << "Formatted:\n" << Result;
}
};
TEST_F(FormatTestJS, BlockComments) {
verifyFormat("/* aaaaaaaaaaaaa */ aaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
// Breaks after a single line block comment.
EXPECT_EQ("aaaaa = bbbb.ccccccccccccccc(\n"
" /** @type_{!cccc.rrrrrrr.MMMMMMMMMMMM.LLLLLLLLLLL.lala} */\n"
" mediaMessage);",
format("aaaaa = bbbb.ccccccccccccccc(\n"
" /** "
"@type_{!cccc.rrrrrrr.MMMMMMMMMMMM.LLLLLLLLLLL.lala} */ "
"mediaMessage);",
getGoogleJSStyleWithColumns(70)));
// Breaks after a multiline block comment.
EXPECT_EQ(
"aaaaa = bbbb.ccccccccccccccc(\n"
" /**\n"
" * @type_{!cccc.rrrrrrr.MMMMMMMMMMMM.LLLLLLLLLLL.lala}\n"
" */\n"
" mediaMessage);",
format("aaaaa = bbbb.ccccccccccccccc(\n"
" /**\n"
" * @type_{!cccc.rrrrrrr.MMMMMMMMMMMM.LLLLLLLLLLL.lala}\n"
" */ mediaMessage);",
getGoogleJSStyleWithColumns(70)));
}
TEST_F(FormatTestJS, JSDocComments) {
// Break the first line of a multiline jsdoc comment.
EXPECT_EQ("/**\n"
" * jsdoc line 1\n"
" * jsdoc line 2\n"
" */",
format("/** jsdoc line 1\n"
" * jsdoc line 2\n"
" */",
getGoogleJSStyleWithColumns(20)));
// Both break after '/**' and break the line itself.
EXPECT_EQ("/**\n"
" * jsdoc line long\n"
" * long jsdoc line 2\n"
" */",
format("/** jsdoc line long long\n"
" * jsdoc line 2\n"
" */",
getGoogleJSStyleWithColumns(20)));
// Break a short first line if the ending '*/' is on a newline.
EXPECT_EQ("/**\n"
" * jsdoc line 1\n"
" */",
format("/** jsdoc line 1\n"
" */",
getGoogleJSStyleWithColumns(20)));
// Don't break the first line of a short single line jsdoc comment.
verifyFormat("/** jsdoc line 1 */", getGoogleJSStyleWithColumns(20));
// Don't break the first line of a single line jsdoc comment if it just fits
// the column limit.
verifyFormat("/** jsdoc line 12 */", getGoogleJSStyleWithColumns(20));
// Don't break after '/**' and before '*/' if there is no space between
// '/**' and the content.
EXPECT_EQ(
"/*** nonjsdoc long\n"
" * line */",
format("/*** nonjsdoc long line */", getGoogleJSStyleWithColumns(20)));
EXPECT_EQ(
"/**strange long long\n"
" * line */",
format("/**strange long long line */", getGoogleJSStyleWithColumns(20)));
// Break the first line of a single line jsdoc comment if it just exceeds the
// column limit.
EXPECT_EQ("/**\n"
" * jsdoc line 123\n"
" */",
format("/** jsdoc line 123 */", getGoogleJSStyleWithColumns(20)));
// Break also if the leading indent of the first line is more than 1 column.
EXPECT_EQ("/**\n"
" * jsdoc line 123\n"
" */",
format("/** jsdoc line 123 */", getGoogleJSStyleWithColumns(20)));
// Break also if the leading indent of the first line is more than 1 column.
EXPECT_EQ("/**\n"
" * jsdoc line 123\n"
" */",
format("/** jsdoc line 123 */", getGoogleJSStyleWithColumns(20)));
// Break after the content of the last line.
EXPECT_EQ("/**\n"
" * line 1\n"
" * line 2\n"
" */",
format("/**\n"
" * line 1\n"
" * line 2 */",
getGoogleJSStyleWithColumns(20)));
// Break both the content and after the content of the last line.
EXPECT_EQ("/**\n"
" * line 1\n"
" * line long long\n"
" * long\n"
" */",
format("/**\n"
" * line 1\n"
" * line long long long */",
getGoogleJSStyleWithColumns(20)));
// The comment block gets indented.
EXPECT_EQ("function f() {\n"
" /**\n"
" * comment about\n"
" * x\n"
" */\n"
" var x = 1;\n"
"}",
format("function f() {\n"
"/** comment about x */\n"
"var x = 1;\n"
"}",
getGoogleJSStyleWithColumns(20)));
// Don't break the first line of a single line short jsdoc comment pragma.
verifyFormat("/** @returns j */", getGoogleJSStyleWithColumns(20));
// Break a single line long jsdoc comment pragma.
EXPECT_EQ("/**\n"
" * @returns {string}\n"
" * jsdoc line 12\n"
" */",
format("/** @returns {string} jsdoc line 12 */",
getGoogleJSStyleWithColumns(20)));
// FIXME: this overcounts the */ as a continuation of the 12 when breaking.
// Cf. BreakableBlockComment::getRemainingLength.
EXPECT_EQ("/**\n"
" * @returns {string}\n"
" * jsdoc line line\n"
" * 12\n"
" */",
format("/** @returns {string} jsdoc line line 12*/",
getGoogleJSStyleWithColumns(25)));
// Fix a multiline jsdoc comment ending in a comment pragma.
EXPECT_EQ("/**\n"
" * line 1\n"
" * line 2\n"
" * @returns {string}\n"
" * jsdoc line 12\n"
" */",
format("/** line 1\n"
" * line 2\n"
" * @returns {string} jsdoc line 12 */",
getGoogleJSStyleWithColumns(20)));
EXPECT_EQ("/**\n"
" * line 1\n"
" * line 2\n"
" *\n"
" * @returns j\n"
" */",
format("/** line 1\n"
" * line 2\n"
" *\n"
" * @returns j */",
getGoogleJSStyleWithColumns(20)));
}
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;");
verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n"
" aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
FormatStyle Style = getGoogleJSStyleWithColumns(80);
Style.AlignOperands = FormatStyle::OAS_Align;
verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa() in\n"
" aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
Style);
Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
verifyFormat("var x = aaaaaaaaaaaaaaaaaaaaaaaaa()\n"
" in aaaa.aaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
Style);
// ES6 spread operator.
verifyFormat("someFunction(...a);");
verifyFormat("var x = [1, ...a, 2];");
// "- -1" is legal JS syntax, but must not collapse into "--".
verifyFormat("- -1;", " - -1;");
verifyFormat("-- -1;", " -- -1;");
verifyFormat("+ +1;", " + +1;");
verifyFormat("++ +1;", " ++ +1;");
}
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.for = 1;");
verifyFormat("x.of();");
verifyFormat("of(null);");
verifyFormat("return of(null);");
verifyFormat("import {of} from 'x';");
verifyFormat("x.in();");
verifyFormat("x.let();");
verifyFormat("x.var();");
verifyFormat("x.for();");
verifyFormat("x.as();");
verifyFormat("x.instanceof();");
verifyFormat("x.switch();");
verifyFormat("x.case();");
verifyFormat("x.delete();");
verifyFormat("x.throw();");
verifyFormat("x.throws();");
verifyFormat("x.if();");
verifyFormat("x = {\n"
" a: 12,\n"
" interface: 1,\n"
" switch: 1,\n"
"};");
verifyFormat("var struct = 2;");
verifyFormat("var union = 2;");
verifyFormat("var interface = 2;");
verifyFormat("var requires = {};");
verifyFormat("interface = 2;");
verifyFormat("x = interface instanceof y;");
verifyFormat("interface Test {\n"
" x: string;\n"
" switch: string;\n"
" case: string;\n"
" default: string;\n"
"}\n");
verifyFormat("const Axis = {\n"
" for: 'for',\n"
" x: 'x'\n"
"};",
"const Axis = {for: 'for', x: 'x'};");
verifyFormat("export class Foo extends Bar {\n"
" get case(): Case {\n"
" return (\n"
" (this.Bar$has('case')) ? (this.Bar$get('case')) :\n"
" (this.case = new Case()));\n"
" }\n"
"}");
}
TEST_F(FormatTestJS, ReservedWordsMethods) {
verifyFormat("class X {\n"
" delete() {\n"
" x();\n"
" }\n"
" interface() {\n"
" x();\n"
" }\n"
" let() {\n"
" x();\n"
" }\n"
"}\n");
verifyFormat("class KeywordNamedMethods {\n"
" do() {\n"
" }\n"
" for() {\n"
" }\n"
" while() {\n"
" }\n"
" if() {\n"
" }\n"
" else() {\n"
" }\n"
" try() {\n"
" }\n"
" catch() {\n"
" }\n"
"}\n");
}
TEST_F(FormatTestJS, ReservedWordsParenthesized) {
// All of these are statements using the keyword, not function calls.
verifyFormat("throw (x + y);\n"
"await (await x).y;\n"
"typeof (x) === 'string';\n"
"void (0);\n"
"delete (x.y);\n"
"return (x);\n");
}
TEST_F(FormatTestJS, ES6DestructuringAssignment) {
verifyFormat("var [a, b, c] = [1, 2, 3];");
verifyFormat("const [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 = {\n"
" y: function(a) {\n"
" return a;\n"
" }\n"
"};");
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 = {\n"
" y: (a) => {\n"
" x();\n"
" return a;\n"
" },\n"
"};");
verifyFormat("var x = {y: (a) => a};");
// Methods in object literals.
verifyFormat("var x = {\n"
" y(a: string): number {\n"
" return a;\n"
" }\n"
"};");
verifyFormat("var x = {\n"
" y(a: string) {\n"
" return a;\n"
" }\n"
"};");
// Computed keys.
verifyFormat("var x = {[a]: 1, b: 2, [c]: 3};");
verifyFormat("var x = {\n"
" [a]: 1,\n"
" b: 2,\n"
" [c]: 3,\n"
"};");
// Object literals can leave out labels.
verifyFormat("f({a}, () => {\n"
" x;\n"
" g();\n"
"});");
// Keys can be quoted.
verifyFormat("var x = {\n"
" a: a,\n"
" b: b,\n"
" 'c': c,\n"
"};");
// Dict literals can skip the label names.
verifyFormat("var x = {\n"
" aaa,\n"
" aaa,\n"
" aaa,\n"
"};");
verifyFormat("return {\n"
" a,\n"
" b: 'b',\n"
" c,\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, GettersSettersVisibilityKeywords) {
// Don't break after "protected"
verifyFormat("class X {\n"
" protected get getter():\n"
" number {\n"
" return 1;\n"
" }\n"
"}",
getGoogleJSStyleWithColumns(12));
// Don't break after "get"
verifyFormat("class X {\n"
" protected get someReallyLongGetterName():\n"
" number {\n"
" return 1;\n"
" }\n"
"}",
getGoogleJSStyleWithColumns(40));
}
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, SingleQuotedStrings) {
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, IIFEs) {
// Internal calling parens; no semi.
verifyFormat("(function() {\n"
"var a = 1;\n"
"}())");
// External calling parens; no semi.
verifyFormat("(function() {\n"
"var b = 2;\n"
"})()");
// Internal calling parens; with semi.
verifyFormat("(function() {\n"
"var c = 3;\n"
"}());");
// External calling parens; with semi.
verifyFormat("(function() {\n"
"var d = 4;\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));
verifyFormat("const X = goog.requireType('this.is.really.absurdly.long');",
getGoogleJSStyleWithColumns(40));
verifyFormat("goog.forwardDeclare('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');");
verifyFormat("function a() {\n"
" goog.setTestOnly();\n"
"}\n",
"function a() {\n"
"goog.setTestOnly();\n"
"}\n");
}
TEST_F(FormatTestJS, FormatsNamespaces) {
verifyFormat("namespace Foo {\n"
" export let x = 1;\n"
"}\n");
verifyFormat("declare namespace Foo {\n"
" export let x: number;\n"
"}\n");
}
TEST_F(FormatTestJS, NamespacesMayNotWrap) {
verifyFormat("declare namespace foobarbaz {\n"
"}\n",
getGoogleJSStyleWithColumns(18));
verifyFormat("declare module foobarbaz {\n"
"}\n",
getGoogleJSStyleWithColumns(15));
verifyFormat("namespace foobarbaz {\n"
"}\n",
getGoogleJSStyleWithColumns(10));
verifyFormat("module foobarbaz {\n"
"}\n",
getGoogleJSStyleWithColumns(7));
}
TEST_F(FormatTestJS, AmbientDeclarations) {
FormatStyle NineCols = getGoogleJSStyleWithColumns(9);
verifyFormat("declare class\n"
" X {}",
NineCols);
verifyFormat("declare function\n"
"x();", // TODO(martinprobst): should ideally be indented.
NineCols);
verifyFormat("declare function foo();\n"
"let x = 1;\n");
verifyFormat("declare function foo(): string;\n"
"let x = 1;\n");
verifyFormat("declare function foo(): {x: number};\n"
"let x = 1;\n");
verifyFormat("declare class X {}\n"
"let x = 1;\n");
verifyFormat("declare interface Y {}\n"
"let x = 1;\n");
verifyFormat("declare enum X {\n"
"}",
NineCols);
verifyFormat("declare let\n"
" x: number;",
NineCols);
}
TEST_F(FormatTestJS, FormatsFreestandingFunctions) {
verifyFormat("function outer1(a, b) {\n"
" function inner1(a, b) {\n"
" return a;\n"
" }\n"
" inner1(a, b);\n"
"}\n"
"function outer2(a, b) {\n"
" function inner2(a, b) {\n"
" return a;\n"
" }\n"
" inner2(a, b);\n"
"}");
verifyFormat("function f() {}");
verifyFormat("function aFunction() {}\n"
"(function f() {\n"
" var x = 1;\n"
"}());\n");
verifyFormat("function aFunction() {}\n"
"{\n"
" let x = 1;\n"
" console.log(x);\n"
"}\n");
EXPECT_EQ("a = function(x) {}\n"
"\n"
"function f(x) {}",
format("a = function(x) {}\n"
"\n"
"function f(x) {}",
getGoogleJSStyleWithColumns(20)));
}
TEST_F(FormatTestJS, FormatsDecorators) {
// No line break after argument decorators.
verifyFormat("class A {\n"
" constructor(@arg(DECOR) private arg: Type) {}\n"
"}");
// Ensure that there is a break before functions, getters and setters.
EXPECT_EQ("class A {\n"
" private p = () => {}\n"
"\n"
" @decorated('a')\n"
" get f() {\n"
" return result;\n"
" }\n"
"}\n"
"\n"
"class B {\n"
" private p = () => {}\n"
"\n"
" @decorated('a')\n"
" set f() {\n"
" return result;\n"
" }\n"
"}\n"
"\n"
"class C {\n"
" private p = () => {}\n"
"\n"
" @decorated('a')\n"
" function f() {\n"
" return result;\n"
" }\n"
"}",
format("class A {\n"
" private p = () => {}\n"
"\n"
" @decorated('a')\n"
" get f() {\n"
" return result;\n"
" }\n"
"}\n"
"\n"
"class B {\n"
" private p = () => {}\n"
"\n"
" @decorated('a')\n"
" set f() {\n"
" return result;\n"
" }\n"
"}\n"
"\n"
"class C {\n"
" private p = () => {}\n"
"\n"
" @decorated('a')\n"
" function f() {\n"
" return result;\n"
" }\n"
"}",
getGoogleJSStyleWithColumns(50)));
}
TEST_F(FormatTestJS, GeneratorFunctions) {
verifyFormat("function* f() {\n"
" let x = 1;\n"
" yield x;\n"
" yield* something();\n"
" yield [1, 2];\n"
" yield {a: 1};\n"
"}");
verifyFormat("function*\n"
" f() {\n"
"}",
getGoogleJSStyleWithColumns(8));
verifyFormat("export function* f() {\n"
" yield 1;\n"
"}\n");
verifyFormat("class X {\n"
" * generatorMethod() {\n"
" yield x;\n"
" }\n"
"}");
verifyFormat("var x = {\n"
" a: function*() {\n"
" //\n"
" }\n"
"}\n");
}
TEST_F(FormatTestJS, AsyncFunctions) {
verifyFormat("async function f() {\n"
" let x = 1;\n"
" return fetch(x);\n"
"}");
verifyFormat("async function f() {\n"
" return 1;\n"
"}\n"
"\n"
"function a() {\n"
" return 1;\n"
"}\n",
" async function f() {\n"
" return 1;\n"
"}\n"
"\n"
" function a() {\n"
" return 1;\n"
"} \n");
// clang-format must not insert breaks between async and function, otherwise
// automatic semicolon insertion may trigger (in particular in a class body).
verifyFormat("async function\n"
"hello(\n"
" myparamnameiswaytooloooong) {\n"
"}",
"async function hello(myparamnameiswaytooloooong) {}",
getGoogleJSStyleWithColumns(10));
verifyFormat("class C {\n"
" async hello(\n"
" myparamnameiswaytooloooong) {\n"
" }\n"
"}",
"class C {\n"
" async hello(myparamnameiswaytooloooong) {} }",
getGoogleJSStyleWithColumns(10));
verifyFormat("async function* f() {\n"
" yield fetch(x);\n"
"}");
verifyFormat("export async function f() {\n"
" return fetch(x);\n"
"}");
verifyFormat("let x = async () => f();");
verifyFormat("let x = async function() {\n"
" f();\n"
"};");
verifyFormat("let x = async();");
verifyFormat("class X {\n"
" async asyncMethod() {\n"
" return fetch(1);\n"
" }\n"
"}");
verifyFormat("function initialize() {\n"
" // Comment.\n"
" return async.then();\n"
"}\n");
verifyFormat("for await (const x of y) {\n"
" console.log(x);\n"
"}\n");
verifyFormat("function asyncLoop() {\n"
" for await (const x of y) {\n"
" console.log(x);\n"
" }\n"
"}\n");
}
TEST_F(FormatTestJS, OverriddenMembers) {
verifyFormat(
"class C extends P {\n"
" protected override "
"anOverlyLongPropertyNameSoLongItHasToGoInASeparateLineWhenOverriden:\n"
" undefined;\n"
"}\n");
verifyFormat(
"class C extends P {\n"
" protected override "
"anOverlyLongMethodNameSoLongItHasToGoInASeparateLineWhenOverriden() {\n"
" }\n"
"}\n");
verifyFormat("class C extends P {\n"
" protected override aMethodName<ATypeParam extends {},\n"
" BTypeParam "
"extends {}>() {}\n"
"}\n");
}
TEST_F(FormatTestJS, FunctionParametersTrailingComma) {
verifyFormat("function trailingComma(\n"
" p1,\n"
" p2,\n"
" p3,\n"
") {\n"
" a; //\n"
"}\n",
"function trailingComma(p1, p2, p3,) {\n"
" a; //\n"
"}\n");
verifyFormat("trailingComma(\n"
" p1,\n"
" p2,\n"
" p3,\n"
");\n",
"trailingComma(p1, p2, p3,);\n");
verifyFormat("trailingComma(\n"
" p1 // hello\n"
");\n",
"trailingComma(p1 // hello\n"
");\n");
}
TEST_F(FormatTestJS, ArrayLiterals) {
verifyFormat("var aaaaa: List<SomeThing> =\n"
" [new SomeThingAAAAAAAAAAAA(), new SomeThingBBBBBBBBB()];");
verifyFormat("return [\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
" ccccccccccccccccccccccccccc\n"
"];");
verifyFormat("return [\n"
" aaaa().bbbbbbbb('A'),\n"
" aaaa().bbbbbbbb('B'),\n"
" aaaa().bbbbbbbb('C'),\n"
"];");
verifyFormat("var someVariable = SomeFunction([\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
" ccccccccccccccccccccccccccc\n"
"]);");
verifyFormat("var someVariable = SomeFunction([\n"
" [aaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbb],\n"
"]);",
getGoogleJSStyleWithColumns(51));
verifyFormat("var someVariable = SomeFunction(aaaa, [\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
" ccccccccccccccccccccccccccc\n"
"]);");
verifyFormat("var someVariable = SomeFunction(\n"
" aaaa,\n"
" [\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
" cccccccccccccccccccccccccc\n"
" ],\n"
" aaaa);");
verifyFormat("var aaaa = aaaaa || // wrap\n"
" [];");
verifyFormat("someFunction([], {a: a});");
verifyFormat("var string = [\n"
" 'aaaaaa',\n"
" 'bbbbbb',\n"
"].join('+');");
}
TEST_F(FormatTestJS, ColumnLayoutForArrayLiterals) {
verifyFormat("var array = [\n"
" a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
" a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
"];");
verifyFormat("var array = someFunction([\n"
" a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
" a, a, a, a, a, a, a, a, a, a, a, a, a, a, a,\n"
"]);");
}
TEST_F(FormatTestJS, TrailingCommaInsertion) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
Style.InsertTrailingCommas = FormatStyle::TCS_Wrapped;
// Insert comma in wrapped array.
verifyFormat("const x = [\n"
" 1, //\n"
" 2,\n"
"];",
"const x = [\n"
" 1, //\n"
" 2];",
Style);
// Insert comma in newly wrapped array.
Style.ColumnLimit = 30;
verifyFormat("const x = [\n"
" aaaaaaaaaaaaaaaaaaaaaaaaa,\n"
"];",
"const x = [aaaaaaaaaaaaaaaaaaaaaaaaa];", Style);
// Do not insert trailing commas if they'd exceed the colum limit
verifyFormat("const x = [\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
"];",
"const x = [aaaaaaaaaaaaaaaaaaaaaaaaaaaa];", Style);
// Object literals.
verifyFormat("const x = {\n"
" a: aaaaaaaaaaaaaaaaa,\n"
"};",
"const x = {a: aaaaaaaaaaaaaaaaa};", Style);
verifyFormat("const x = {\n"
" a: aaaaaaaaaaaaaaaaaaaaaaaaa\n"
"};",
"const x = {a: aaaaaaaaaaaaaaaaaaaaaaaaa};", Style);
// Object literal types.
verifyFormat("let x: {\n"
" a: aaaaaaaaaaaaaaaaaaaaa,\n"
"};",
"let x: {a: aaaaaaaaaaaaaaaaaaaaa};", Style);
}
TEST_F(FormatTestJS, FunctionLiterals) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
verifyFormat("doFoo(function() {});");
verifyFormat("doFoo(function() { return 1; });", Style);
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"
"};",
Style);
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, arg1IsReallyLongAndNeedsLineBreaks,\n"
" arg3IsReallyLongAndNeedsLineBreaks);");
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("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));");
verifyFormat("SomeFunction(function() {\n"
" foo();\n"
" bar();\n"
"}.bind(this));");
verifyFormat("SomeFunction((function() {\n"
" foo();\n"
" bar();\n"
" }).bind(this));");
// FIXME: This is bad, we should be wrapping before "function() {".
verifyFormat("someFunction(function() {\n"
" doSomething(); // break\n"
"})\n"
" .doSomethingElse(\n"
" // break\n"
" );");
Style.ColumnLimit = 33;
verifyFormat("f({a: function() { return 1; }});", Style);
Style.ColumnLimit = 32;
verifyFormat("f({\n"
" a: function() { return 1; }\n"
"});",
Style);
}
TEST_F(FormatTestJS, DontWrapEmptyLiterals) {
verifyFormat("(aaaaaaaaaaaaaaaaaaaaa.getData as jasmine.Spy)\n"
" .and.returnValue(Observable.of([]));");
verifyFormat("(aaaaaaaaaaaaaaaaaaaaa.getData as jasmine.Spy)\n"
" .and.returnValue(Observable.of({}));");
verifyFormat("(aaaaaaaaaaaaaaaaaaaaa.getData as jasmine.Spy)\n"
" .and.returnValue(Observable.of(()));");
}
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);
Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
verifyFormat("var func = function() {\n"
" return 1;\n"
"};",
Style);
}
TEST_F(FormatTestJS, MultipleFunctionLiterals) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
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"
" });",
Style);
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(); });",
Style);
verifyFormat("return [aaaaaaaaaaaaaaaaaaaaaa]\n"
" .aaaaaaa(function() {\n"
" //\n"
" })\n"
" .bbbbbb();");
}
TEST_F(FormatTestJS, ArrowFunctions) {
verifyFormat("var x = (a) => {\n"
" x;\n"
" return a;\n"
"};\n");
verifyFormat("var x = (a) => {\n"
" function y() {\n"
" return 42;\n"
" }\n"
" return a;\n"
"};");
verifyFormat("var x = (a: type): {some: type} => {\n"
" y;\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"
" );");
verifyFormat("const f = (x: string|null): string|null => {\n"
" y;\n"
" return x;\n"
"}\n");
}
TEST_F(FormatTestJS, ArrowFunctionStyle) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
Style.AllowShortLambdasOnASingleLine = FormatStyle::SLS_All;
verifyFormat("const arr = () => { x; };", Style);
verifyFormat("const arrInlineAll = () => {};", Style);
Style.AllowShortLambdasOnASingleLine = FormatStyle::SLS_None;
verifyFormat("const arr = () => {\n"
" x;\n"
"};",
Style);
verifyFormat("const arrInlineNone = () => {\n"
"};",
Style);
Style.AllowShortLambdasOnASingleLine = FormatStyle::SLS_Empty;
verifyFormat("const arr = () => {\n"
" x;\n"
"};",
Style);
verifyFormat("const arrInlineEmpty = () => {};", Style);
Style.AllowShortLambdasOnASingleLine = FormatStyle::SLS_Inline;
verifyFormat("const arr = () => {\n"
" x;\n"
"};",
Style);
verifyFormat("foo(() => {});", Style);
verifyFormat("const arrInlineInline = () => {};", Style);
}
TEST_F(FormatTestJS, ReturnStatements) {
verifyFormat("function() {\n"
" return [hello, world];\n"
"}");
}
TEST_F(FormatTestJS, ForLoops) {
verifyFormat("for (var i in [2, 3]) {\n"
"}");
verifyFormat("for (var i of [2, 3]) {\n"
"}");
verifyFormat("for (let {a, b} of x) {\n"
"}");
verifyFormat("for (let {a, b} of [x]) {\n"
"}");
verifyFormat("for (let [a, b] of [x]) {\n"
"}");
verifyFormat("for (let {a, b} in x) {\n"
"}");
}
TEST_F(FormatTestJS, WrapRespectsAutomaticSemicolonInsertion) {
// 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("yield aaaaa;", getGoogleJSStyleWithColumns(10));
verifyFormat("return /* hello! */ aaaaa;", getGoogleJSStyleWithColumns(10));
verifyFormat("continue aaaaa;", getGoogleJSStyleWithColumns(10));
verifyFormat("continue /* hello! */ aaaaa;", getGoogleJSStyleWithColumns(10));
verifyFormat("break aaaaa;", getGoogleJSStyleWithColumns(10));
verifyFormat("throw aaaaa;", getGoogleJSStyleWithColumns(10));
verifyFormat("aaaaaaaaa++;", getGoogleJSStyleWithColumns(10));
verifyFormat("aaaaaaaaa--;", getGoogleJSStyleWithColumns(10));
verifyFormat("return [\n"
" aaa\n"
"];",
getGoogleJSStyleWithColumns(12));
verifyFormat("class X {\n"
" readonly ratherLongField =\n"
" 1;\n"
"}",
"class X {\n"
" readonly ratherLongField = 1;\n"
"}",
getGoogleJSStyleWithColumns(20));
verifyFormat("const x = (5 + 9)\n"
"const y = 3\n",
"const x = ( 5 + 9)\n"
"const y = 3\n");
// Ideally the foo() bit should be indented relative to the async function().
verifyFormat("async function\n"
"foo() {}",
getGoogleJSStyleWithColumns(10));
verifyFormat("await theReckoning;", getGoogleJSStyleWithColumns(10));
verifyFormat("some['a']['b']", getGoogleJSStyleWithColumns(10));
verifyFormat("x = (a['a']\n"
" ['b']);",
getGoogleJSStyleWithColumns(10));
verifyFormat("function f() {\n"
" return foo.bar(\n"
" (param): param is {\n"
" a: SomeType\n"
" }&ABC => 1)\n"
"}",
getGoogleJSStyleWithColumns(25));
}
TEST_F(FormatTestJS, AddsIsTheDictKeyOnNewline) {
// Do not confuse is, the dict key with is, the type matcher. Put is, the dict
// key, on a newline.
verifyFormat("Polymer({\n"
" is: '', //\n"
" rest: 1\n"
"});",
getGoogleJSStyleWithColumns(20));
}
TEST_F(FormatTestJS, AutomaticSemicolonInsertionHeuristic) {
verifyFormat("a\n"
"b;",
" a \n"
" b ;");
verifyFormat("a()\n"
"b;",
" a ()\n"
" b ;");
verifyFormat("a[b]\n"
"c;",
"a [b]\n"
"c ;");
verifyFormat("1\n"
"a;",
"1 \n"
"a ;");
verifyFormat("a\n"
"1;",
"a \n"
"1 ;");
verifyFormat("a\n"
"'x';",
"a \n"
" 'x';");
verifyFormat("a++\n"
"b;",
"a ++\n"
"b ;");
verifyFormat("a\n"
"!b && c;",
"a \n"
" ! b && c;");
verifyFormat("a\n"
"if (1) f();",
" a\n"
" if (1) f();");
verifyFormat("a\n"
"class X {}",
" a\n"
" class X {}");
verifyFormat("var a", "var\n"
"a");
verifyFormat("x instanceof String", "x\n"
"instanceof\n"
"String");
verifyFormat("function f(@Foo bar) {}", "function f(@Foo\n"
" bar) {}");
verifyFormat("function f(@Foo(Param) bar) {}", "function f(@Foo(Param)\n"
" bar) {}");
verifyFormat("a = true\n"
"return 1",
"a = true\n"
" return 1");
verifyFormat("a = 's'\n"
"return 1",
"a = 's'\n"
" return 1");
verifyFormat("a = null\n"
"return 1",
"a = null\n"
" return 1");
// Below "class Y {}" should ideally be on its own line.
verifyFormat("x = {\n"
" a: 1\n"
"} class Y {}",
" x = {a : 1}\n"
" class Y { }");
verifyFormat("if (x) {\n"
"}\n"
"return 1",
"if (x) {}\n"
" return 1");
verifyFormat("if (x) {\n"
"}\n"
"class X {}",
"if (x) {}\n"
" class X {}");
}
TEST_F(FormatTestJS, ImportExportASI) {
verifyFormat("import {x} from 'y'\n"
"export function z() {}",
"import {x} from 'y'\n"
" export function z() {}");
// Below "class Y {}" should ideally be on its own line.
verifyFormat("export {x} class Y {}", " export {x}\n"
" class Y {\n}");
verifyFormat("if (x) {\n"
"}\n"
"export class Y {}",
"if ( x ) { }\n"
" export class Y {}");
}
TEST_F(FormatTestJS, ImportExportType) {
verifyFormat("import type {x, y} from 'y';\n"
"import type * as x from 'y';\n"
"import type x from 'y';\n"
"import {x, type yu, z} from 'y';\n");
verifyFormat("export type {x, y} from 'y';\n"
"export {x, type yu, z} from 'y';\n"
"export type {x, y};\n"
"export {x, type yu, z};\n");
}
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();");
}
TEST_F(FormatTestJS, StringLiteralConcatenation) {
verifyFormat("var literal = 'hello ' +\n"
" 'world';");
// Long strings should be broken.
verifyFormat("var literal =\n"
" 'xxxxxxxx ' +\n"
" 'xxxxxxxx';",
"var literal = 'xxxxxxxx xxxxxxxx';",
getGoogleJSStyleWithColumns(17));
verifyFormat("var literal =\n"
" 'xxxxxxxx ' +\n"
" 'xxxxxxxx';",
"var literal = 'xxxxxxxx xxxxxxxx';",
getGoogleJSStyleWithColumns(18));
verifyFormat("var literal =\n"
" 'xxxxxxxx' +\n"
" ' xxxxxxxx';",
"var literal = 'xxxxxxxx xxxxxxxx';",
getGoogleJSStyleWithColumns(16));
// The quotes should be correct.
for (char OriginalQuote : {'\'', '"'}) {
auto VerifyQuotes = [=](FormatStyle::JavaScriptQuoteStyle StyleQuote,
char TargetQuote) {
auto Style = getGoogleJSStyleWithColumns(17);
Style.JavaScriptQuotes = StyleQuote;
std::string Target{"var literal =\n"
" \"xxxxxxxx \" +\n"
" \"xxxxxxxx\";"};
std::string Original{"var literal = \"xxxxxxxx xxxxxxxx\";"};
std::replace(Target.begin(), Target.end(), '"', TargetQuote);
std::replace(Original.begin(), Original.end(), '"', OriginalQuote);
verifyFormat(Target, Original, Style);
};
VerifyQuotes(FormatStyle::JSQS_Leave, OriginalQuote);
VerifyQuotes(FormatStyle::JSQS_Single, '\'');
VerifyQuotes(FormatStyle::JSQS_Double, '"');
}
// Parentheses should be added when necessary.
verifyFormat("var literal =\n"
" ('xxxxxxxx ' +\n"
" 'xxxxxx')[0];",
"var literal = 'xxxxxxxx xxxxxx'[0];",
getGoogleJSStyleWithColumns(18));
auto Style = getGoogleJSStyleWithColumns(20);
Style.SpacesInParens = FormatStyle::SIPO_Custom;
Style.SpacesInParensOptions.Other = true;
verifyFormat("var literal =\n"
" ( 'xxxxxxxx ' +\n"
" 'xxxxxx' )[0];",
"var literal = 'xxxxxxxx xxxxxx'[0];", Style);
// FIXME: When the part before the string literal is shorter than the
// continuation indentation, and the option AlignAfterOpenBracket is set to
// AlwaysBreak which is the default for the Google style, the unbroken string
// does not get to a new line while the broken string does due to the added
// parentheses. The formatter does not do it in one pass.
EXPECT_EQ(
"x = ('xxxxxxxx ' +\n"
" 'xxxxxx')[0];",
format("x = 'xxxxxxxx xxxxxx'[0];", getGoogleJSStyleWithColumns(18)));
verifyFormat("x =\n"
" ('xxxxxxxx ' +\n"
" 'xxxxxx')[0];",
getGoogleJSStyleWithColumns(18));
// Breaking of template strings and regular expressions is not implemented.
verifyFormat("var literal =\n"
" `xxxxxxxx xxxxxxxx`;",
getGoogleJSStyleWithColumns(18));
verifyFormat("var literal =\n"
" /xxxxxxxx xxxxxxxx/;",
getGoogleJSStyleWithColumns(18));
// There can be breaks in the code inside a template string.
verifyFormat("var literal = `xxxxxx ${\n"
" xxxxxxxxxx} xxxxxx`;",
"var literal = `xxxxxx ${xxxxxxxxxx} xxxxxx`;",
getGoogleJSStyleWithColumns(14));
verifyFormat("var literal = `xxxxxx ${\n"
" xxxxxxxxxx} xxxxxx`;",
"var literal = `xxxxxx ${xxxxxxxxxx} xxxxxx`;",
getGoogleJSStyleWithColumns(15));
// Identifiers inside the code inside a template string should not be broken
// even if the column limit is exceeded. This following behavior is not
// optimal. The part after the closing brace which exceeds the column limit
// can be put on a new line. Change this test when it is implemented.
verifyFormat("var literal = `xxxxxx ${\n"
" xxxxxxxxxxxxxxxxxxxxxx} xxxxxx`;",
"var literal = `xxxxxx ${xxxxxxxxxxxxxxxxxxxxxx} xxxxxx`;",
getGoogleJSStyleWithColumns(14));
verifyFormat("var literal = `xxxxxx ${\n"
" xxxxxxxxxxxxxxxxxxxxxx +\n"
" xxxxxxxxxxxxxxxxxxxxxx} xxxxxx`;",
"var literal = `xxxxxx ${xxxxxxxxxxxxxxxxxxxxxx + "
"xxxxxxxxxxxxxxxxxxxxxx} xxxxxx`;",
getGoogleJSStyleWithColumns(14));
}
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 = foo()! / 10;");
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;");
verifyFormat("var regex = /'/g;", "var regex = /'/g ;");
verifyFormat("var regex = /'/g; //'", "var regex = /'/g ; //'");
verifyFormat("var regex = /\\/*/;\n"
"var x = 0;",
"var regex = /\\/*/;\n"
"var x=0;");
verifyFormat("var x = /a\\//;", "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, IgnoresMpegTS) {
std::string MpegTS(200, ' ');
MpegTS.replace(0, strlen("nearlyLooks + like + ts + code; "),
"nearlyLooks + like + ts + code; ");
MpegTS[0] = 0x47;
MpegTS[188] = 0x47;
verifyFormat(MpegTS, MpegTS);
}
TEST_F(FormatTestJS, TypeAnnotations) {
verifyFormat("var x: string;");
verifyFormat("var x: {a: string; b: number;} = {};");
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("for (var y: string of x) {\n x();\n}");
verifyFormat("function x(y: {a?: number;} = {}): number {\n"
" return 12;\n"
"}");
verifyFormat("const x: Array<{a: number; b: string;}> = [];");
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 = {\n"
" y: function(): z {\n"
" return 1;\n"
" }\n"
"};");
verifyFormat("var x = {\n"
" y: function(): {a: number} {\n"
" return 1;\n"
" }\n"
"};");
verifyFormat("function someFunc(args: string[]):\n"
" {longReturnValue: string[]} {}",
getGoogleJSStyleWithColumns(60));
verifyFormat(
"var someValue = (v as aaaaaaaaaaaaaaaaaaaa<T>[])\n"
" .someFunction(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
verifyFormat("const xIsALongIdent:\n"
" YJustBarelyFitsLinex[];",
getGoogleJSStyleWithColumns(20));
verifyFormat("const x = {\n"
" y: 1\n"
"} as const;");
}
TEST_F(FormatTestJS, UnionIntersectionTypes) {
verifyFormat("let x: A|B = A | B;");
verifyFormat("let x: A&B|C = A & B;");
verifyFormat("let x: Foo<A|B> = new Foo<A|B>();");
verifyFormat("function(x: A|B): C&D {}");
verifyFormat("function(x: A|B = A | B): C&D {}");
verifyFormat("function x(path: number|string) {}");
verifyFormat("function x(): string|number {}");
verifyFormat("type Foo = Bar|Baz;");
verifyFormat("type Foo = Bar<X>|Baz;");
verifyFormat("type Foo = (Bar<X>|Baz);");
verifyFormat("let x: Bar|Baz;");
verifyFormat("let x: Bar<X>|Baz;");
verifyFormat("let x: (Foo|Bar)[];");
verifyFormat("type X = {\n"
" a: Foo|Bar;\n"
"};");
verifyFormat("export type X = {\n"
" a: Foo|Bar;\n"
"};");
}
TEST_F(FormatTestJS, UnionIntersectionTypesInObjectType) {
verifyFormat("let x: {x: number|null} = {x: number | null};");
verifyFormat("let nested: {x: {y: number|null}};");
verifyFormat("let mixed: {x: [number|null, {w: number}]};");
verifyFormat("class X {\n"
" contructor(x: {\n"
" a: a|null,\n"
" b: b|null,\n"
" }) {}\n"
"}");
}
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"
" foo() {}\n"
" [bar]() {}\n"
"}\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 {\n return 'asd';\n }\n}");
verifyFormat("class C extends P implements I {}");
verifyFormat("class C extends p.P implements i.I {}");
verifyFormat("x(class {\n"
" a(): A {}\n"
"});");
verifyFormat("class Test {\n"
" aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa: aaaaaaaaaaaaaaaaaaaa):\n"
" aaaaaaaaaaaaaaaaaaaaaa {}\n"
"}");
verifyFormat("foo = class Name {\n"
" constructor() {}\n"
"};");
verifyFormat("foo = class {\n"
" constructor() {}\n"
"};");
verifyFormat("class C {\n"
" x: {y: Z;} = {};\n"
" private y: {y: Z;} = {};\n"
"}");
// ':' is not a type declaration here.
verifyFormat("class X {\n"
" subs = {\n"
" 'b': {\n"
" 'c': 1,\n"
" },\n"
" };\n"
"}");
verifyFormat("@Component({\n"
" moduleId: module.id,\n"
"})\n"
"class SessionListComponent implements OnDestroy, OnInit {\n"
"}");
}
TEST_F(FormatTestJS, StrictPropInitWrap) {
const FormatStyle &Style = getGoogleJSStyleWithColumns(22);
verifyFormat("class X {\n"
" strictPropInitField!:\n"
" string;\n"
"}",
Style);
}
TEST_F(FormatTestJS, InterfaceDeclarations) {
verifyFormat("interface I {\n"
" x: string;\n"
" enum: string[];\n"
" enum?: string[];\n"
"}\n"
"var y;");
// Ensure that state is reset after parsing the interface.
verifyFormat("interface a {}\n"
"export function b() {}\n"
"var x;");
// Arrays of object type literals.
verifyFormat("interface I {\n"
" o: {}[];\n"
"}");
}
TEST_F(FormatTestJS, ObjectTypesInExtendsImplements) {
verifyFormat("class C extends {} {}");
verifyFormat("class C implements {bar: number} {}");
// Somewhat odd, but probably closest to reasonable formatting?
verifyFormat("class C implements {\n"
" bar: number,\n"
" baz: string,\n"
"} {}");
verifyFormat("class C<P extends {}> {}");
}
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;");
verifyFormat("const enum Foo {\n"
" A = 1,\n"
" B\n"
"}");
verifyFormat("export const enum Foo {\n"
" A = 1,\n"
" B\n"
"}");
}
TEST_F(FormatTestJS, Decorators) {
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 C {\n"
" private x(@A x: string) {}\n"
"}");
verifyFormat("class X {}\n"
"class Y {}");
verifyFormat("class X {\n"
" @property() private isReply = false;\n"
"}\n");
}
TEST_F(FormatTestJS, TypeAliases) {
verifyFormat("type X = number;\n"
"class C {}");
verifyFormat("type X<Y> = Z<Y>;");
verifyFormat("type X = {\n"
" y: number\n"
"};\n"
"class C {}");
verifyFormat("export type X = {\n"
" a: string,\n"
" b?: string,\n"
"};\n");
}
TEST_F(FormatTestJS, TypeInterfaceLineWrapping) {
const FormatStyle &Style = getGoogleJSStyleWithColumns(20);
verifyFormat("type LongTypeIsReallyUnreasonablyLong =\n"
" string;\n",
"type LongTypeIsReallyUnreasonablyLong = string;\n", Style);
verifyFormat("interface AbstractStrategyFactoryProvider {\n"
" a: number\n"
"}\n",
"interface AbstractStrategyFactoryProvider { a: number }\n",
Style);
}
TEST_F(FormatTestJS, RemoveEmptyLinesInArrowFunctions) {
verifyFormat("x = () => {\n"
" foo();\n"
" bar();\n"
"};\n",
"x = () => {\n"
"\n"
" foo();\n"
" bar();\n"
"\n"
"};\n");
}
TEST_F(FormatTestJS, Modules) {
verifyFormat("import SomeThing from 'some/module.js';");
verifyFormat("import {X, Y} from 'some/module.js';");
verifyFormat("import a, {X, Y} from 'some/module.js';");
verifyFormat("import {X, Y,} from 'some/module.js';");
verifyFormat("import {X as myLocalX, Y as myLocalY} from 'some/module.js';");
// Ensure Automatic Semicolon Insertion does not break on "as\n".
verifyFormat("import {X as myX} from 'm';", "import {X as\n"
" myX} from 'm';");
verifyFormat("import * as lib from 'some/module.js';");
verifyFormat("var x = {import: 1};\nx.import = 2;");
// Ensure an import statement inside a block is at the correct level.
verifyFormat("function() {\n"
" var x;\n"
" import 'some/module.js';\n"
"}");
verifyFormat("export function fn() {\n"
" return 'fn';\n"
"}");
verifyFormat("export function A() {}\n"
"export default function B() {}\n"
"export function C() {}");
verifyFormat("export default () => {\n"
" let x = 1;\n"
" return x;\n"
"}");
verifyFormat("export const x = 12;");
verifyFormat("export default class X {}");
verifyFormat("export {X, Y} from 'some/module.js';");
verifyFormat("export {X, Y,} from 'some/module.js';");
verifyFormat("export {SomeVeryLongExport as X, "
"SomeOtherVeryLongExport as Y} from 'some/module.js';");
// export without 'from' is wrapped.
verifyFormat("export let someRatherLongVariableName =\n"
" someSurprisinglyLongVariable + someOtherRatherLongVar;");
// ... but not if from is just an identifier.
verifyFormat("export {\n"
" from as from,\n"
" someSurprisinglyLongVariable as\n"
" from\n"
"};",
getGoogleJSStyleWithColumns(20));
verifyFormat("export class C {\n"
" x: number;\n"
" y: string;\n"
"}");
verifyFormat("export class X {\n"
" y: number;\n"
"}");
verifyFormat("export abstract class X {\n"
" y: number;\n"
"}");
verifyFormat("export default class X {\n"
" y: number\n"
"}");
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"
"}");
verifyFormat("export default [\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
" bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n"
"];");
verifyFormat("export default [];");
verifyFormat("export default () => {};");
verifyFormat("export default () => {\n"
" x;\n"
" x;\n"
"};");
verifyFormat("export interface Foo {\n"
" foo: number;\n"
"}\n"
"export class Bar {\n"
" blah(): string {\n"
" return this.blah;\n"
" };\n"
"}");
}
TEST_F(FormatTestJS, ImportWrapping) {
verifyFormat("import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying,"
" VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying"
"} from 'some/module.js';");
FormatStyle Style = getGoogleJSStyleWithColumns(80);
Style.JavaScriptWrapImports = true;
verifyFormat("import {\n"
" VeryLongImportsAreAnnoying,\n"
" VeryLongImportsAreAnnoying,\n"
" VeryLongImportsAreAnnoying,\n"
"} from 'some/module.js';",
Style);
verifyFormat("import {\n"
" A,\n"
" A,\n"
"} from 'some/module.js';",
Style);
verifyFormat("export {\n"
" A,\n"
" A,\n"
"} from 'some/module.js';",
Style);
Style.ColumnLimit = 40;
// Using this version of verifyFormat because test::messUp hides the issue.
verifyFormat("import {\n"
" A,\n"
"} from\n"
" 'some/path/longer/than/column/limit/module.js';",
" import { \n"
" A, \n"
" } from\n"
" 'some/path/longer/than/column/limit/module.js' ; ",
Style);
}
TEST_F(FormatTestJS, TemplateStrings) {
// Keeps any whitespace/indentation within the template string.
verifyFormat("var x = `hello\n"
" ${name}\n"
" !`;",
"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.
verifyFormat("var x = `hellö ${wörld}` >= söme();",
getGoogleJSStyleWithColumns(35)); // Fits due to UTF-8.
verifyFormat("var x = `hello\n"
" ${world}` >=\n"
" some();",
"var x =\n"
" `hello\n"
" ${world}` >= some();",
getGoogleJSStyleWithColumns(21)); // Barely doesn't fit.
verifyFormat("var x = `hello\n"
" ${world}` >= some();",
"var x =\n"
" `hello\n"
" ${world}` >= some();",
getGoogleJSStyleWithColumns(22)); // Barely fits.
verifyFormat("var x =\n"
" `h`;",
getGoogleJSStyleWithColumns(11));
verifyFormat("var x =\n `multi\n line`;", "var x = `multi\n line`;",
getGoogleJSStyleWithColumns(13));
verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
" `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`);");
// Repro for an obscure width-miscounting issue with template strings.
verifyFormat(
"someLongVariable =\n"
" "
"`${logPrefix[11]}/${logPrefix[12]}/${logPrefix[13]}${logPrefix[14]}`;",
"someLongVariable = "
"`${logPrefix[11]}/${logPrefix[12]}/${logPrefix[13]}${logPrefix[14]}`;");
// 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.
verifyFormat("var x = `//a`;\n"
"var y;",
"var x =\n `//a`;\n"
"var y ;");
verifyFormat("var x = `/*a`;\n"
"var y;",
"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;");
verifyFormat("it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa);",
"it(`'aaaaaaaaaaaaaaa `, aaaaaaaaa) ;",
getGoogleJSStyleWithColumns(40));
// Backticks in a comment - not a template string.
verifyFormat("var x = 1 // `/*a`;\n"
" ;",
"var x =\n 1 // `/*a`;\n"
" ;");
verifyFormat("/* ` */ var x = 1; /* ` */", "/* ` */ var x\n= 1; /* ` */");
// Comment spans multiple template strings.
verifyFormat("var x = `/*a`;\n"
"var y = ` */ `;",
"var x =\n `/*a`;\n"
"var y =\n ` */ `;");
// Escaped backtick.
verifyFormat("var x = ` \\` a`;\n"
"var y;",
"var x = ` \\` a`;\n"
"var y;");
// Escaped dollar.
verifyFormat("var x = ` \\${foo}`;\n");
// The token stream can contain two string_literals in sequence, but that
// doesn't mean that they are implicitly concatenated in JavaScript.
verifyFormat("var f = `aaaa ${a ? 'a' : 'b'}`;");
// Ensure that scopes are appropriately set around evaluated expressions in
// template strings.
verifyFormat("var f = `aaaaaaaaaaaaa:${aaaaaaa.aaaaa} aaaaaaaa\n"
" aaaaaaaaaaaaa:${aaaaaaa.aaaaa} aaaaaaaa`;",
"var f = `aaaaaaaaaaaaa:${aaaaaaa. aaaaa} aaaaaaaa\n"
" aaaaaaaaaaaaa:${ aaaaaaa. aaaaa} aaaaaaaa`;");
verifyFormat("var x = someFunction(`${})`) //\n"
" .oooooooooooooooooon();");
verifyFormat("var x = someFunction(`${aaaa}${\n"
" aaaaa( //\n"
" aaaaa)})`);");
}
TEST_F(FormatTestJS, TemplateStringMultiLineExpression) {
verifyFormat("var f = `aaaaaaaaaaaaaaaaaa: ${\n"
" aaaaa + //\n"
" bbbb}`;",
"var f = `aaaaaaaaaaaaaaaaaa: ${aaaaa + //\n"
" bbbb}`;");
verifyFormat("var f = `\n"
" aaaaaaaaaaaaaaaaaa: ${\n"
" aaaaa + //\n"
" bbbb}`;",
"var f = `\n"
" aaaaaaaaaaaaaaaaaa: ${ aaaaa + //\n"
" bbbb }`;");
verifyFormat("var f = `\n"
" aaaaaaaaaaaaaaaaaa: ${\n"
" someFunction(\n"
" aaaaa + //\n"
" bbbb)}`;",
"var f = `\n"
" aaaaaaaaaaaaaaaaaa: ${someFunction (\n"
" aaaaa + //\n"
" bbbb)}`;");
// It might be preferable to wrap before "someFunction".
verifyFormat("var f = `\n"
" aaaaaaaaaaaaaaaaaa: ${someFunction({\n"
" aaaa: aaaaa,\n"
" bbbb: bbbbb,\n"
"})}`;",
"var f = `\n"
" aaaaaaaaaaaaaaaaaa: ${someFunction ({\n"
" aaaa: aaaaa,\n"
" bbbb: bbbbb,\n"
" })}`;");
}
TEST_F(FormatTestJS, TemplateStringASI) {
verifyFormat("var x = `hello${world}`;", "var x = `hello${\n"
" world\n"
"}`;");
}
TEST_F(FormatTestJS, NestedTemplateStrings) {
verifyFormat(
"var x = `<ul>${xs.map(x => `<li>${x}</li>`).join('\\n')}</ul>`;");
verifyFormat("var x = `he${({text: 'll'}.text)}o`;");
// Crashed at some point.
verifyFormat("}");
verifyFormat("`");
// FIXME: still crashing?
// verifyFormat("`\\");
}
TEST_F(FormatTestJS, TaggedTemplateStrings) {
verifyFormat("var x = html`<ul>`;");
verifyFormat("yield `hello`;");
verifyFormat("var f = {\n"
" param: longTagName`This is a ${\n"
" 'really'} long line`\n"
"};",
"var f = {param: longTagName`This is a ${'really'} long line`};",
getGoogleJSStyleWithColumns(40));
}
TEST_F(FormatTestJS, CastSyntax) {
verifyFormat("var x = <type>foo;");
verifyFormat("var x = foo as type;");
verifyFormat("let x = (a + b) as\n"
" LongTypeIsLong;",
getGoogleJSStyleWithColumns(20));
verifyFormat("foo = <Bar[]>[\n"
" 1, //\n"
" 2\n"
"];");
verifyFormat("var x = [{x: 1} as type];");
verifyFormat("x = x as [a, b];");
verifyFormat("x = x as {a: string};");
verifyFormat("x = x as (string);");
verifyFormat("x = x! as (string);");
verifyFormat("x = y! in z;");
verifyFormat("var x = something.someFunction() as\n"
" something;",
getGoogleJSStyleWithColumns(40));
}
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, UserDefinedTypeGuards) {
verifyFormat(
"function foo(check: Object):\n"
" check is {foo: string, bar: string, baz: string, foobar: string} {\n"
" return 'bar' in check;\n"
"}\n");
}
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("constructor({aa}: {\n"
" aa?: string,\n"
" aaaaaaaa?: string,\n"
" aaaaaaaaaaaaaaa?: boolean,\n"
" aaaaaa?: List<string>\n"
"}) {}");
verifyFormat("type X = [y?];");
}
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}");
}
TEST_F(FormatTestJS, JSDocAnnotations) {
verifyFormat("/**\n"
" * @exports {this.is.a.long.path.to.a.Type}\n"
" */",
"/**\n"
" * @exports {this.is.a.long.path.to.a.Type}\n"
" */",
getGoogleJSStyleWithColumns(20));
verifyFormat("/**\n"
" * @mods {this.is.a.long.path.to.a.Type}\n"
" */",
"/**\n"
" * @mods {this.is.a.long.path.to.a.Type}\n"
" */",
getGoogleJSStyleWithColumns(20));
verifyFormat("/**\n"
" * @mods {this.is.a.long.path.to.a.Type}\n"
" */",
"/**\n"
" * @mods {this.is.a.long.path.to.a.Type}\n"
" */",
getGoogleJSStyleWithColumns(20));
verifyFormat("/**\n"
" * @param {canWrap\n"
" * onSpace}\n"
" */",
"/**\n"
" * @param {canWrap onSpace}\n"
" */",
getGoogleJSStyleWithColumns(20));
// make sure clang-format doesn't break before *any* '{'
verifyFormat("/**\n"
" * @lala {lala {lalala\n"
" */\n",
"/**\n"
" * @lala {lala {lalala\n"
" */\n",
getGoogleJSStyleWithColumns(20));
// cases where '{' is around the column limit
for (int ColumnLimit = 6; ColumnLimit < 13; ++ColumnLimit) {
verifyFormat("/**\n"
" * @param {type}\n"
" */",
"/**\n"
" * @param {type}\n"
" */",
getGoogleJSStyleWithColumns(ColumnLimit));
}
// don't break before @tags
verifyFormat("/**\n"
" * This\n"
" * tag @param\n"
" * stays.\n"
" */",
"/**\n"
" * This tag @param stays.\n"
" */",
getGoogleJSStyleWithColumns(13));
verifyFormat("/**\n"
" * @see http://very/very/long/url/is/long\n"
" */",
"/**\n"
" * @see http://very/very/long/url/is/long\n"
" */",
getGoogleJSStyleWithColumns(20));
verifyFormat("/**\n"
" * @param This is a\n"
" * long comment\n"
" * but no type\n"
" */",
"/**\n"
" * @param This is a long comment but no type\n"
" */",
getGoogleJSStyleWithColumns(20));
// Break and reindent @param line and reflow unrelated lines.
EXPECT_EQ("{\n"
" /**\n"
" * long long long\n"
" * long\n"
" * @param {this.is.a.long.path.to.a.Type}\n"
" * a\n"
" * long long long\n"
" * long long\n"
" */\n"
" function f(a) {}\n"
"}",
format("{\n"
"/**\n"
" * long long long long\n"
" * @param {this.is.a.long.path.to.a.Type} a\n"
" * long long long long\n"
" * long\n"
" */\n"
" function f(a) {}\n"
"}",
getGoogleJSStyleWithColumns(20)));
}
TEST_F(FormatTestJS, TslintComments) {
// tslint uses pragma comments that must be on their own line.
verifyFormat("// Comment that needs wrapping. Comment that needs wrapping. "
"Comment that needs\n"
"// wrapping. Trailing line.\n"
"// tslint:disable-next-line:must-be-on-own-line",
"// Comment that needs wrapping. Comment that needs wrapping. "
"Comment that needs wrapping.\n"
"// Trailing line.\n"
"// tslint:disable-next-line:must-be-on-own-line");
}
TEST_F(FormatTestJS, TscComments) {
// As above, @ts-ignore and @ts-check comments must be on their own line.
verifyFormat("// Comment that needs wrapping. Comment that needs wrapping. "
"Comment that needs\n"
"// wrapping. Trailing line.\n"
"// @ts-ignore",
"// Comment that needs wrapping. Comment that needs wrapping. "
"Comment that needs wrapping.\n"
"// Trailing line.\n"
"// @ts-ignore");
verifyFormat("// Comment that needs wrapping. Comment that needs wrapping. "
"Comment that needs\n"
"// wrapping. Trailing line.\n"
"// @ts-check",
"// Comment that needs wrapping. Comment that needs wrapping. "
"Comment that needs wrapping.\n"
"// Trailing line.\n"
"// @ts-check");
}
TEST_F(FormatTestJS, RequoteStringsSingle) {
verifyFormat("var x = 'foo';", "var x = \"foo\";");
verifyFormat("var x = 'fo\\'o\\'';", "var x = \"fo'o'\";");
verifyFormat("var x = 'fo\\'o\\'';", "var x = \"fo\\'o'\";");
verifyFormat("var x =\n"
" 'foo\\'';",
// Code below is 15 chars wide, doesn't fit into the line with
// the \ escape added.
"var x = \"foo'\";", getGoogleJSStyleWithColumns(15));
// Removes no-longer needed \ escape from ".
verifyFormat("var x = 'fo\"o';", "var x = \"fo\\\"o\";");
// Code below fits into 15 chars *after* removing the \ escape.
verifyFormat("var x = 'fo\"o';", "var x = \"fo\\\"o\";",
getGoogleJSStyleWithColumns(15));
verifyFormat("// clang-format off\n"
"let x = \"double\";\n"
"// clang-format on\n"
"let x = 'single';\n",
"// clang-format off\n"
"let x = \"double\";\n"
"// clang-format on\n"
"let x = \"single\";\n");
}
TEST_F(FormatTestJS, RequoteAndIndent) {
verifyFormat("let x = someVeryLongFunctionThatGoesOnAndOn(\n"
" 'double quoted string that needs wrapping');",
"let x = someVeryLongFunctionThatGoesOnAndOn("
"\"double quoted string that needs wrapping\");");
verifyFormat("let x =\n"
" 'foo\\'oo';\n"
"let x =\n"
" 'foo\\'oo';",
"let x=\"foo'oo\";\n"
"let x=\"foo'oo\";",
getGoogleJSStyleWithColumns(15));
}
TEST_F(FormatTestJS, RequoteStringsDouble) {
FormatStyle DoubleQuotes = getGoogleStyle(FormatStyle::LK_JavaScript);
DoubleQuotes.JavaScriptQuotes = FormatStyle::JSQS_Double;
verifyFormat("var x = \"foo\";", DoubleQuotes);
verifyFormat("var x = \"foo\";", "var x = 'foo';", DoubleQuotes);
verifyFormat("var x = \"fo'o\";", "var x = 'fo\\'o';", DoubleQuotes);
}
TEST_F(FormatTestJS, RequoteStringsLeave) {
FormatStyle LeaveQuotes = getGoogleStyle(FormatStyle::LK_JavaScript);
LeaveQuotes.JavaScriptQuotes = FormatStyle::JSQS_Leave;
verifyFormat("var x = \"foo\";", LeaveQuotes);
verifyFormat("var x = 'foo';", LeaveQuotes);
}
TEST_F(FormatTestJS, SupportShebangLines) {
verifyFormat("#!/usr/bin/env node\n"
"var x = hello();",
"#!/usr/bin/env node\n"
"var x = hello();");
}
TEST_F(FormatTestJS, NonNullAssertionOperator) {
verifyFormat("let x = foo!.bar();\n");
verifyFormat("let x = foo ? bar! : baz;\n");
verifyFormat("let x = !foo;\n");
verifyFormat("if (!+a) {\n}");
verifyFormat("let x = foo[0]!;\n");
verifyFormat("let x = (foo)!;\n");
verifyFormat("let x = x(foo!);\n");
verifyFormat("a.aaaaaa(a.a!).then(\n"
" x => x(x));\n",
getGoogleJSStyleWithColumns(20));
verifyFormat("let x = foo! - 1;\n");
verifyFormat("let x = {foo: 1}!;\n");
verifyFormat("let x = hello.foo()!\n"
" .foo()!\n"
" .foo()!\n"
" .foo()!;\n",
getGoogleJSStyleWithColumns(20));
verifyFormat("let x = namespace!;\n");
verifyFormat("return !!x;\n");
}
TEST_F(FormatTestJS, CppKeywords) {
// Make sure we don't mess stuff up because of C++ keywords.
verifyFormat("return operator && (aa);");
// .. or QT ones.
verifyFormat("const slots: Slot[];");
// use the "!" assertion operator to validate that clang-format understands
// these C++ keywords aren't keywords in JS/TS.
verifyFormat("auto!;");
verifyFormat("char!;");
verifyFormat("concept!;");
verifyFormat("double!;");
verifyFormat("extern!;");
verifyFormat("float!;");
verifyFormat("inline!;");
verifyFormat("int!;");
verifyFormat("long!;");
verifyFormat("register!;");
verifyFormat("restrict!;");
verifyFormat("sizeof!;");
verifyFormat("struct!;");
verifyFormat("typedef!;");
verifyFormat("union!;");
verifyFormat("unsigned!;");
verifyFormat("volatile!;");
verifyFormat("_Alignas!;");
verifyFormat("_Alignof!;");
verifyFormat("_Atomic!;");
verifyFormat("_Bool!;");
verifyFormat("_Complex!;");
verifyFormat("_Generic!;");
verifyFormat("_Imaginary!;");
verifyFormat("_Noreturn!;");
verifyFormat("_Static_assert!;");
verifyFormat("_Thread_local!;");
verifyFormat("__func__!;");
verifyFormat("__objc_yes!;");
verifyFormat("__objc_no!;");
verifyFormat("asm!;");
verifyFormat("bool!;");
verifyFormat("const_cast!;");
verifyFormat("dynamic_cast!;");
verifyFormat("explicit!;");
verifyFormat("friend!;");
verifyFormat("mutable!;");
verifyFormat("operator!;");
verifyFormat("reinterpret_cast!;");
verifyFormat("static_cast!;");
verifyFormat("template!;");
verifyFormat("typename!;");
verifyFormat("typeid!;");
verifyFormat("using!;");
verifyFormat("virtual!;");
verifyFormat("wchar_t!;");
// Positive tests:
verifyFormat("x.type!;");
verifyFormat("x.get!;");
verifyFormat("x.set!;");
}
TEST_F(FormatTestJS, NullPropagatingOperator) {
verifyFormat("let x = foo?.bar?.baz();\n");
verifyFormat("let x = foo?.(foo);\n");
verifyFormat("let x = foo?.['arr'];\n");
}
TEST_F(FormatTestJS, NullishCoalescingOperator) {
verifyFormat("const val = something ?? 'some other default';\n");
verifyFormat(
"const val = something ?? otherDefault ??\n"
" evenMore ?? evenMore;\n",
"const val = something ?? otherDefault ?? evenMore ?? evenMore;\n",
getGoogleJSStyleWithColumns(40));
}
TEST_F(FormatTestJS, AssignmentOperators) {
verifyFormat("a &&= b;\n");
verifyFormat("a ||= b;\n");
// NB: need to split ? ?= to avoid it being interpreted by C++ as a trigraph
// for #.
verifyFormat("a ?"
"?= b;\n");
}
TEST_F(FormatTestJS, Conditional) {
verifyFormat("y = x ? 1 : 2;");
verifyFormat("x ? 1 : 2;");
verifyFormat("class Foo {\n"
" field = true ? 1 : 2;\n"
" method(a = true ? 1 : 2) {}\n"
"}");
}
TEST_F(FormatTestJS, ImportComments) {
verifyFormat("import {x} from 'x'; // from some location",
getGoogleJSStyleWithColumns(25));
verifyFormat("// taze: x from 'location'", getGoogleJSStyleWithColumns(10));
verifyFormat("/// <reference path=\"some/location\" />",
getGoogleJSStyleWithColumns(10));
}
TEST_F(FormatTestJS, Exponentiation) {
verifyFormat("squared = x ** 2;");
verifyFormat("squared **= 2;");
}
TEST_F(FormatTestJS, NestedLiterals) {
FormatStyle FourSpaces = getGoogleJSStyleWithColumns(15);
FourSpaces.IndentWidth = 4;
verifyFormat("var l = [\n"
" [\n"
" 1,\n"
" ],\n"
"];",
FourSpaces);
verifyFormat("var l = [\n"
" {\n"
" 1: 1,\n"
" },\n"
"];",
FourSpaces);
verifyFormat("someFunction(\n"
" p1,\n"
" [\n"
" 1,\n"
" ],\n"
");",
FourSpaces);
verifyFormat("someFunction(\n"
" p1,\n"
" {\n"
" 1: 1,\n"
" },\n"
");",
FourSpaces);
verifyFormat("var o = {\n"
" 1: 1,\n"
" 2: {\n"
" 3: 3,\n"
" },\n"
"};",
FourSpaces);
verifyFormat("var o = {\n"
" 1: 1,\n"
" 2: [\n"
" 3,\n"
" ],\n"
"};",
FourSpaces);
}
TEST_F(FormatTestJS, BackslashesInComments) {
verifyFormat("// hello \\\n"
"if (x) foo();\n",
"// hello \\\n"
" if ( x) \n"
" foo();\n");
verifyFormat("/* ignore \\\n"
" */\n"
"if (x) foo();\n",
"/* ignore \\\n"
" */\n"
" if ( x) foo();\n");
verifyFormat("// st \\ art\\\n"
"// comment"
"// continue \\\n"
"formatMe();\n",
"// st \\ art\\\n"
"// comment"
"// continue \\\n"
"formatMe( );\n");
}
TEST_F(FormatTestJS, AddsLastLinePenaltyIfEndingIsBroken) {
EXPECT_EQ(
"a = function() {\n"
" b = function() {\n"
" this.aaaaaaaaaaaaaaaaaaa[aaaaaaaaaaa] = aaaa.aaaaaa ?\n"
" aaaa.aaaaaa : /** @type "
"{aaaa.aaaa.aaaaaaaaa.aaaaaaaaaaaaaaaaaaa} */\n"
" (aaaa.aaaa.aaaaaaaaa.aaaaaaaaaaaaa.aaaaaaaaaaaaaaaaa);\n"
" };\n"
"};",
format("a = function() {\n"
" b = function() {\n"
" this.aaaaaaaaaaaaaaaaaaa[aaaaaaaaaaa] = aaaa.aaaaaa ? "
"aaaa.aaaaaa : /** @type "
"{aaaa.aaaa.aaaaaaaaa.aaaaaaaaaaaaaaaaaaa} */\n"
" (aaaa.aaaa.aaaaaaaaa.aaaaaaaaaaaaa.aaaaaaaaaaaaaaaaa);\n"
" };\n"
"};"));
}
TEST_F(FormatTestJS, ParameterNamingComment) {
verifyFormat("callFoo(/*spaceAfterParameterNamingComment=*/ 1);");
}
TEST_F(FormatTestJS, ConditionalTypes) {
// Formatting below is not necessarily intentional, this just ensures that
// clang-format does not break the code.
verifyFormat( // wrap
"type UnionToIntersection<U> =\n"
" (U extends any ? (k: U) => void :\n"
" never) extends((k: infer I) => void) ? I : never;");
}
TEST_F(FormatTestJS, SupportPrivateFieldsAndMethods) {
verifyFormat("class Example {\n"
" pub = 1;\n"
" #priv = 2;\n"
" static pub2 = 'foo';\n"
" static #priv2 = 'bar';\n"
" method() {\n"
" this.#priv = 5;\n"
" }\n"
" static staticMethod() {\n"
" switch (this.#priv) {\n"
" case '1':\n"
" #priv = 3;\n"
" break;\n"
" }\n"
" }\n"
" #privateMethod() {\n"
" this.#privateMethod(); // infinite loop\n"
" }\n"
" static #staticPrivateMethod() {}\n");
}
TEST_F(FormatTestJS, DeclaredFields) {
verifyFormat("class Example {\n"
" declare pub: string;\n"
" declare private priv: string;\n"
"}\n");
}
TEST_F(FormatTestJS, NoBreakAfterAsserts) {
verifyFormat(
"interface Assertable<State extends {}> {\n"
" assert<ExportedState extends {}, DependencyState extends State = "
"State>(\n"
" callback: Callback<ExportedState, DependencyState>):\n"
" asserts this is ExtendedState<DependencyState&ExportedState>;\n"
"}\n",
"interface Assertable<State extends {}> {\n"
" assert<ExportedState extends {}, DependencyState extends State = "
"State>(callback: Callback<ExportedState, DependencyState>): asserts "
"this is ExtendedState<DependencyState&ExportedState>;\n"
"}\n");
}
TEST_F(FormatTestJS, NumericSeparators) {
verifyFormat("x = 1_000_000 + 12;", "x = 1_000_000 + 12;");
}
TEST_F(FormatTestJS, AlignConsecutiveDeclarations) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
Style.AlignConsecutiveDeclarations.Enabled = true;
verifyFormat("let letVariable = 5;\n"
"double constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"const constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"static const constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"static var constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"var constVariable = 10;",
Style);
verifyFormat("double letVariable = 5;\n"
"var constVariable = 10;",
Style);
verifyFormat("const letVariable = 5;\n"
"var constVariable = 10;",
Style);
verifyFormat("int letVariable = 5;\n"
"int constVariable = 10;",
Style);
}
TEST_F(FormatTestJS, AlignConsecutiveAssignments) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
Style.AlignConsecutiveAssignments.Enabled = true;
verifyFormat("let letVariable = 5;\n"
"double constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"const constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"static const constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"static var constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"var constVariable = 10;",
Style);
verifyFormat("double letVariable = 5;\n"
"var constVariable = 10;",
Style);
verifyFormat("const letVariable = 5;\n"
"var constVariable = 10;",
Style);
verifyFormat("int letVariable = 5;\n"
"int constVariable = 10;",
Style);
}
TEST_F(FormatTestJS, AlignConsecutiveAssignmentsAndDeclarations) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_JavaScript);
Style.AlignConsecutiveDeclarations.Enabled = true;
Style.AlignConsecutiveAssignments.Enabled = true;
verifyFormat("let letVariable = 5;\n"
"double constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"const constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"static const constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"static var constVariable = 10;",
Style);
verifyFormat("let letVariable = 5;\n"
"var constVariable = 10;",
Style);
verifyFormat("double letVariable = 5;\n"
"var constVariable = 10;",
Style);
verifyFormat("const letVariable = 5;\n"
"var constVariable = 10;",
Style);
verifyFormat("int letVariable = 5;\n"
"int constVariable = 10;",
Style);
}
} // namespace format
} // end namespace clang