List position based formatting#13574

saschanaz · 2017-01-19T08:42:49Z

Fixes #5830, fixes #5890, fixes #6252, fixes #6320, fixes #6451, fixes #10681, fixes #13688, and maybe more.

Previous behavior:

foo.then
  <
  void // list does not add indentation
  >();

foo
  .then(
  () => {}
  );

function foo(
  param1: number,
  param2: number
): {
    attribute: number // incorrectly double indented
  } {
}

New behavior:

foo.then
  <
    void // every list adds indentation
  >();

foo
  .then( // list starts on single-indented line
    () => {} // new formatter is list-position-sensitive, its children are now double indented
  );

function foo(
  param1: number,
  param2: number
): { // list starts on non-indented line
  attribute: number // correctly single indented
} {
}

RyanCavanaugh · 2017-01-20T22:16:46Z

src/services/formatting/formatting.ts

                if ((<TypeReferenceNode>node).typeArguments === list) {
                    return SyntaxKind.LessThanToken;
                }
+            case SyntaxKind.TypeLiteral:


Is this an intended fallthrough?

No, fixed now.

zhengbli · 2017-04-14T20:43:44Z

src/services/formatting/formatting.ts

     */
    interface DynamicIndentation {
-        getIndentationForToken(tokenLine: number, tokenKind: SyntaxKind, container: Node): number;
+        getIndentationForToken(tokenLine: number, tokenKind: SyntaxKind, container: Node, suppressDelta: boolean): number;


Can you add a comment for the "suppressDelta" parameter, including examples of when would that be set to true? So it would be easier to read

I added now 👍

zhengbli · 2017-04-14T21:04:32Z

src/services/formatting/formatting.ts

+                            consumeTokenAndAdvanceScanner(tokenInfo, parent, parentDynamicIndentation, parent);
+
+                            if (indentationOnLastIndentedLine !== Constants.Unknown) {
+                                indentationOnListStartToken = indentationOnLastIndentedLine;


Can you add a comment here explaining the relationship between indentationOnLastIndentedLine and indentationOnListStartToken? It looks like they are related somehow

Also added 👍

saschanaz · 2017-05-29T15:53:12Z

Test fails on codeFixClassImplementInterfaceComputedPropertyNameWellKnownSymbols because of a strange NodeArray object with the form [ pos: undefined, end: undefined, hasTrailingComma: undefined ]. Need some bisecting to solve this.

saschanaz · 2017-05-29T16:08:11Z

BTW I think the fix for codeFixClassImplementInterfaceComputedPropertyNameWellKnownSymbols is out of scope of this PR, a simple workaround may be enough?

See microsoft#13574 (comment)

... and add explicit delta suppressor for list end tokens

See microsoft#13574 (comment)

saschanaz · 2017-05-29T18:28:51Z

Rebased and squashed for easier review. Sorry for previous mess 😅

magnushiie · 2017-08-13T19:54:00Z

What is the status of this PR?

saschanaz · 2017-08-14T00:31:51Z

I think it's mature enough, time to merge conflicts anyway...

typescript-bot · 2018-06-13T17:11:23Z

Thanks for your contribution. This PR has not been updated in a while and cannot be automatically merged at the time being. For housekeeping purposes we are closing stale PRs. If you'd still like to continue working on this PR, please leave a message and one of the maintainers can reopen it.

mhegazy · 2018-07-19T22:01:38Z

@Andy-MS can you refresh this PR

saschanaz · 2018-11-03T05:11:58Z

Note for myself: downgrade to TS 2.4.x, gulp-typescript 3.0.x, and mocha 3.5.x to build this.

See microsoft#13574 (comment)

saschanaz · 2018-11-04T06:37:23Z

Test fails on codeFixClassImplementInterfaceComputedPropertyNameWellKnownSymbols

Solved by #18284

msftclas added the cla-already-signed label Jan 19, 2017

saschanaz mentioned this pull request Jan 19, 2017

Fix child element indentation in multiline lists #3827

Closed

RyanCavanaugh reviewed Jan 20, 2017

View reviewed changes

jwbay mentioned this pull request Jan 26, 2017

Callback functions don't have the expected indentation #13688

Closed

WuTheFWasThat mentioned this pull request Mar 11, 2017

multi-line argument indentation #14596

Closed

saschanaz mentioned this pull request Apr 11, 2017

Fix formatting of parameter list of a multiple-line call expression #14955

Closed

saschanaz changed the title ~~List based formatting~~ List position based formatting Apr 14, 2017

zhengbli reviewed Apr 17, 2017

View reviewed changes

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request May 29, 2017

workaround for codefix test failure

1e4358f

See microsoft#13574 (comment)

saschanaz force-pushed the listIndent branch from 1e4358f to 8971bc7 Compare May 29, 2017 17:16

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request May 29, 2017

workaround for codefix test failure

96d11e6

See microsoft#13574 (comment)

saschanaz added 7 commits May 30, 2017 02:34

use last line indentation on formatter

8d1cfbd

... and add explicit delta suppressor for list end tokens

remove deprecated function

e92711c

add getListByPosition

bfb1bf5

indent using list start position before first list item

0464ee1

indent using list start position

1541096

tests

92d6566

workaround for codefix test failure

cd2acf5

See microsoft#13574 (comment)

saschanaz force-pushed the listIndent branch from 8971bc7 to cd2acf5 Compare May 29, 2017 18:26

msftgits removed the cla-already-signed label Sep 26, 2017

typescript-bot closed this Jun 13, 2018

mhegazy reopened this Jul 19, 2018

mhegazy assigned ghost Jul 19, 2018

RyanCavanaugh mentioned this pull request Sep 5, 2018

Revive PR #13574 #26906

Closed

RyanCavanaugh closed this Sep 5, 2018

saschanaz mentioned this pull request Nov 3, 2018

Hard to reproduce older build environment #28327

Closed

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

d28d0d1

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

87ecfa1

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

4fe3bfa

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

d6e8ddd

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

c6744a4

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

578a129

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

d68a218

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

0ebfb3a

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

8b20b3c

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

fd45b84

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

18810d2

See microsoft#13574 (comment)

saschanaz added a commit to saschanaz/TypeScript that referenced this pull request Nov 3, 2018

workaround for codefix test failure

1556743

See microsoft#13574 (comment)

saschanaz mentioned this pull request Nov 5, 2018

List position based formatting #28340

Merged

microsoft locked as resolved and limited conversation to collaborators Oct 16, 2025

Conversation

saschanaz commented Jan 19, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RyanCavanaugh Jan 20, 2017

Choose a reason for hiding this comment

Uh oh!

saschanaz Jan 21, 2017

Choose a reason for hiding this comment

Uh oh!

zhengbli Apr 14, 2017

Choose a reason for hiding this comment

Uh oh!

saschanaz Apr 18, 2017

Choose a reason for hiding this comment

Uh oh!

zhengbli Apr 14, 2017

Choose a reason for hiding this comment

Uh oh!

saschanaz Apr 18, 2017

Choose a reason for hiding this comment

Uh oh!

saschanaz commented May 29, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

saschanaz commented May 29, 2017

Uh oh!

saschanaz commented May 29, 2017

Uh oh!

magnushiie commented Aug 13, 2017

Uh oh!

saschanaz commented Aug 14, 2017

Uh oh!

typescript-bot commented Jun 13, 2018

Uh oh!

mhegazy commented Jul 19, 2018

Uh oh!

saschanaz commented Nov 3, 2018

Uh oh!

saschanaz commented Nov 4, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

saschanaz commented Jan 19, 2017 •

edited

Loading

saschanaz commented May 29, 2017 •

edited

Loading