Skip to content

Commit cabc0ff

Browse files
DanielRosenwasserDanielRosenwasser
committed
Merge pull request #4442 from SaschaNaz/formatFunctionType
Format function type (and others)
2 parents 4a75f93 + 96174ba commit cabc0ff

File tree

10 files changed

+207
-4
lines changed

10 files changed

+207
-4
lines changed

‎src/services/formatting/rules.ts‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,26 @@ namespace ts.formatting {
213213
public NoSpaceBetweenYieldKeywordAndStar: Rule;
214214
public SpaceBetweenYieldOrYieldStarAndOperand: Rule;
215215

216+
// Async-await
217+
public SpaceBetweenAsyncAndFunctionKeyword: Rule;
218+
public NoSpaceBetweenAsyncAndFunctionKeyword: Rule;
219+
public SpaceAfterAwaitKeyword: Rule;
220+
public NoSpaceAfterAwaitKeyword: Rule;
221+
222+
// Type alias declaration
223+
public SpaceAfterTypeKeyword: Rule;
224+
public NoSpaceAfterTypeKeyword: Rule;
225+
226+
// Tagged template string
227+
public SpaceBetweenTagAndTemplateString: Rule;
228+
public NoSpaceBetweenTagAndTemplateString: Rule;
229+
230+
// Union type
231+
public SpaceBeforeBar: Rule;
232+
public NoSpaceBeforeBar: Rule;
233+
public SpaceAfterBar: Rule;
234+
public NoSpaceAfterBar: Rule;
235+
216236
constructor() {
217237
///
218238
/// Common Rules
@@ -360,6 +380,27 @@ namespace ts.formatting {
360380
this.NoSpaceBetweenYieldKeywordAndStar = new Rule(RuleDescriptor.create1(SyntaxKind.YieldKeyword, SyntaxKind.AsteriskToken), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext, Rules.IsYieldOrYieldStarWithOperand), RuleAction.Delete));
361381
this.SpaceBetweenYieldOrYieldStarAndOperand = new Rule(RuleDescriptor.create4(Shared.TokenRange.FromTokens([SyntaxKind.YieldKeyword, SyntaxKind.AsteriskToken]), Shared.TokenRange.Any), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext, Rules.IsYieldOrYieldStarWithOperand), RuleAction.Space));
362382

383+
// Async-await
384+
this.SpaceBetweenAsyncAndFunctionKeyword = new Rule(RuleDescriptor.create1(SyntaxKind.AsyncKeyword, SyntaxKind.FunctionKeyword), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Space));
385+
this.NoSpaceBetweenAsyncAndFunctionKeyword = new Rule(RuleDescriptor.create1(SyntaxKind.AsyncKeyword, SyntaxKind.FunctionKeyword), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Delete));
386+
this.SpaceAfterAwaitKeyword = new Rule(RuleDescriptor.create3(SyntaxKind.AwaitKeyword, Shared.TokenRange.Any), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Space));
387+
this.NoSpaceAfterAwaitKeyword = new Rule(RuleDescriptor.create3(SyntaxKind.AwaitKeyword, Shared.TokenRange.Any), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Delete));
388+
389+
// Type alias declaration
390+
this.SpaceAfterTypeKeyword = new Rule(RuleDescriptor.create3(SyntaxKind.TypeKeyword, Shared.TokenRange.Any), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Space));
391+
this.NoSpaceAfterTypeKeyword = new Rule(RuleDescriptor.create3(SyntaxKind.TypeKeyword, Shared.TokenRange.Any), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Delete));
392+
393+
// template string
394+
this.SpaceBetweenTagAndTemplateString = new Rule(RuleDescriptor.create3(SyntaxKind.Identifier, Shared.TokenRange.FromTokens([SyntaxKind.NoSubstitutionTemplateLiteral, SyntaxKind.TemplateHead])), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Space));
395+
this.NoSpaceBetweenTagAndTemplateString = new Rule(RuleDescriptor.create3(SyntaxKind.Identifier, Shared.TokenRange.FromTokens([SyntaxKind.NoSubstitutionTemplateLiteral, SyntaxKind.TemplateHead])), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Delete));
396+
397+
// union type
398+
this.SpaceBeforeBar = new Rule(RuleDescriptor.create3(SyntaxKind.BarToken, Shared.TokenRange.Any), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Space));
399+
this.NoSpaceBeforeBar = new Rule(RuleDescriptor.create3(SyntaxKind.BarToken, Shared.TokenRange.Any), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Delete));
400+
this.SpaceAfterBar = new Rule(RuleDescriptor.create2(Shared.TokenRange.Any, SyntaxKind.BarToken), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Space));
401+
this.NoSpaceAfterBar = new Rule(RuleDescriptor.create2(Shared.TokenRange.Any, SyntaxKind.BarToken), RuleOperation.create2(new RuleOperationContext(Rules.IsSameLineTokenContext), RuleAction.Delete));
402+
403+
363404
// These rules are higher in priority than user-configurable rules.
364405
this.HighPriorityCommonRules =
365406
[
@@ -386,6 +427,11 @@ namespace ts.formatting {
386427
this.NoSpaceBeforeOpenParenInFuncCall,
387428
this.SpaceBeforeBinaryKeywordOperator, this.SpaceAfterBinaryKeywordOperator,
388429
this.SpaceAfterVoidOperator,
430+
this.SpaceBetweenAsyncAndFunctionKeyword, this.NoSpaceBetweenAsyncAndFunctionKeyword,
431+
this.SpaceAfterAwaitKeyword, this.NoSpaceAfterAwaitKeyword,
432+
this.SpaceAfterTypeKeyword, this.NoSpaceAfterTypeKeyword,
433+
this.SpaceBetweenTagAndTemplateString, this.NoSpaceBetweenTagAndTemplateString,
434+
this.SpaceBeforeBar, this.NoSpaceBeforeBar, this.SpaceAfterBar, this.NoSpaceAfterBar,
389435

390436
// TypeScript-specific rules
391437
this.NoSpaceAfterConstructor, this.NoSpaceAfterModuleImport,

‎src/services/formatting/smartIndenter.ts‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,7 @@ namespace ts.formatting {
408408
case SyntaxKind.ClassDeclaration:
409409
case SyntaxKind.InterfaceDeclaration:
410410
case SyntaxKind.EnumDeclaration:
411+
case SyntaxKind.TypeAliasDeclaration:
411412
case SyntaxKind.ArrayLiteralExpression:
412413
case SyntaxKind.Block:
413414
case SyntaxKind.ModuleBlock:
@@ -429,6 +430,16 @@ namespace ts.formatting {
429430
case SyntaxKind.ArrayBindingPattern:
430431
case SyntaxKind.ObjectBindingPattern:
431432
case SyntaxKind.JsxElement:
433+
case SyntaxKind.MethodSignature:
434+
case SyntaxKind.CallSignature:
435+
case SyntaxKind.ConstructSignature:
436+
case SyntaxKind.Parameter:
437+
case SyntaxKind.FunctionType:
438+
case SyntaxKind.ConstructorType:
439+
case SyntaxKind.UnionType:
440+
case SyntaxKind.ParenthesizedType:
441+
case SyntaxKind.TaggedTemplateExpression:
442+
case SyntaxKind.AwaitExpression:
432443
return true;
433444
}
434445
return false;
@@ -448,8 +459,6 @@ namespace ts.formatting {
448459
case SyntaxKind.FunctionDeclaration:
449460
case SyntaxKind.FunctionExpression:
450461
case SyntaxKind.MethodDeclaration:
451-
case SyntaxKind.MethodSignature:
452-
case SyntaxKind.CallSignature:
453462
case SyntaxKind.ArrowFunction:
454463
case SyntaxKind.Constructor:
455464
case SyntaxKind.GetAccessor:

‎tests/cases/fourslash/formatAsyncAwait.ts‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
/// <reference path="fourslash.ts"/>
2+
3+
////async function asyncFunction() {/*asyncKeyword*/
4+
//// await
5+
/////*awaitExpressionIndent*/
6+
//// Promise.resolve("await");/*awaitExpressionAutoformat*/
7+
//// return await Promise.resolve("completed");/*awaitKeyword*/
8+
////}
9+
10+
format.document();
11+
12+
goTo.marker("asyncKeyword");
13+
verify.currentLineContentIs("async function asyncFunction() {");
14+
goTo.marker("awaitExpressionIndent");
15+
verify.indentationIs(8);
16+
goTo.marker("awaitExpressionAutoformat");
17+
verify.currentLineContentIs(' Promise.resolve("await");');
18+
goTo.marker("awaitKeyword");
19+
verify.currentLineContentIs(' return await Promise.resolve("completed");');

‎tests/cases/fourslash/formatFunctionAndConstructorType.ts‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/// <reference path='fourslash.ts' />
2+
3+
////function renderElement(
4+
//// element: Element,
5+
//// renderNode:
6+
////(/*funcAutoformat*/
7+
//// node: Node/*funcParamAutoformat*/
8+
/////*funcIndent*/
9+
//// ) => void,
10+
////newNode:
11+
////new(/*constrAutoformat*/
12+
//// name: string/*constrParamAutoformat*/
13+
/////*constrIndent*/
14+
////) => Node
15+
////): void {
16+
////}
17+
18+
format.document();
19+
20+
goTo.marker("funcAutoformat");
21+
verify.currentLineContentIs(" (");
22+
goTo.marker("funcParamAutoformat");
23+
verify.currentLineContentIs(" node: Node");
24+
goTo.marker("funcIndent");
25+
verify.indentationIs(12);
26+
27+
goTo.marker("constrAutoformat");
28+
verify.currentLineContentIs(" new (");
29+
goTo.marker("constrParamAutoformat");
30+
verify.currentLineContentIs(" name: string");
31+
goTo.marker("constrIndent");
32+
verify.indentationIs(12);

‎tests/cases/fourslash/formatParameter.ts‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/// <reference path='fourslash.ts' />
2+
3+
////function foo(
4+
//// first:
5+
//// number,/*first*/
6+
//// second: (
7+
//// string/*second*/
8+
//// ),
9+
//// third:
10+
//// (
11+
//// boolean/*third*/
12+
//// )
13+
////) {
14+
////}
15+
16+
format.document();
17+
18+
goTo.marker("first");
19+
verify.currentLineContentIs(" number,");
20+
goTo.marker("second");
21+
verify.currentLineContentIs(" string");
22+
goTo.marker("third");
23+
verify.currentLineContentIs(" boolean");

‎tests/cases/fourslash/formatSignatures.ts‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/// <reference path="fourslash.ts"/>
2+
3+
////type Foo = {
4+
//// (
5+
//// call: any/*callAutoformat*/
6+
/////*callIndent*/
7+
//// ): void;
8+
//// new (
9+
//// constr: any/*constrAutoformat*/
10+
/////*constrIndent*/
11+
//// ): void;
12+
//// method(
13+
//// whatever: any/*methodAutoformat*/
14+
/////*methodIndent*/
15+
//// ): void;
16+
////};
17+
18+
format.document();
19+
20+
goTo.marker("callAutoformat");
21+
verify.currentLineContentIs(" call: any");
22+
goTo.marker("callIndent");
23+
verify.indentationIs(8);
24+
goTo.marker("constrAutoformat");
25+
verify.currentLineContentIs(" constr: any");
26+
goTo.marker("constrIndent");
27+
verify.indentationIs(8);
28+
goTo.marker("methodAutoformat");
29+
verify.currentLineContentIs(" whatever: any");
30+
goTo.marker("methodIndent");
31+
verify.indentationIs(8);

‎tests/cases/fourslash/formatTemplateLiteral.ts‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
////var x = `sadasdasdasdasfegsfd
33
/////*1*/rasdesgeryt35t35y35 e4 ergt er 35t 3535 `;
44
////var y = `1${2}/*2*/3`;
5+
////let z= `foo`/*3*/
6+
////let w= `bar${3}`/*4*/
7+
////String.raw
8+
//// `template`/*5*/
59

610

711
goTo.marker("1");
@@ -10,4 +14,15 @@ edit.insert("\r\n"); // edit will trigger formatting - should succeeed
1014
goTo.marker("2");
1115
edit.insert("\r\n");
1216
verify.indentationIs(0);
13-
verify.currentLineContentIs("3`;")
17+
verify.currentLineContentIs("3`;")
18+
19+
goTo.marker("3");
20+
edit.insert(";");
21+
verify.currentLineContentIs("let z = `foo`;");
22+
goTo.marker("4");
23+
edit.insert(";");
24+
verify.currentLineContentIs("let w = `bar${3}`;");
25+
26+
goTo.marker("5");
27+
edit.insert(";");
28+
verify.currentLineContentIs(" `template`;");

‎tests/cases/fourslash/formatTypeAlias.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/// <reference path="fourslash.ts"/>
2+
3+
////type Alias = /*typeKeyword*/
4+
/////*indent*/
5+
////number;/*autoformat*/
6+
7+
format.document();
8+
9+
goTo.marker("typeKeyword");
10+
verify.currentLineContentIs("type Alias =");
11+
goTo.marker("indent");
12+
verify.indentationIs(4);
13+
goTo.marker("autoformat");
14+
verify.currentLineContentIs(" number;");

‎tests/cases/fourslash/formatTypeUnion.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/// <reference path="fourslash.ts"/>
2+
3+
////type Union = number | {}/*formatOperator*/
4+
/////*indent*/
5+
////|string/*autoformat*/
6+
7+
format.document();
8+
9+
goTo.marker("formatOperator");
10+
verify.currentLineContentIs("type Union = number | {}");
11+
goTo.marker("indent");
12+
verify.indentationIs(4);
13+
goTo.marker("autoformat");
14+
verify.currentLineContentIs(" | string");

‎tests/cases/fourslash/smartIndentOnUnclosedFunctionDeclaration04.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ function verifyIndentationAfterNewLine(marker: string, indentation: number): voi
1212
verifyIndentationAfterNewLine("1", 4);
1313
verifyIndentationAfterNewLine("2", 4);
1414
verifyIndentationAfterNewLine("3", 4);
15-
verifyIndentationAfterNewLine("4", 4);
15+
verifyIndentationAfterNewLine("4", 8);
1616
verifyIndentationAfterNewLine("5", 4);
1717
verifyIndentationAfterNewLine("6", 4);

0 commit comments

Comments
 (0)