JavaScript: Fix indentation for binary expressions with trailing comments by sosukesuzuki · Pull Request #8476 · prettier/prettier

sosukesuzuki · 2020-06-02T08:06:54Z

Fixes #8451
This PR seems to work fine but the doc is transformed so it maybe a dirty way...

I’ve added tests to confirm my change works.
(If the change is user-facing) I’ve added my changes to changelog_unreleased/*/pr-XXXX.md file following changelog_unreleased/TEMPLATE.md.
I’ve read the contributing guidelines.

✨Try the playground for this PR✨

fisker · 2020-06-02T09:00:02Z

Seems dirty, can it done in printBinaryishExpressions?

sosukesuzuki · 2020-06-02T09:04:51Z

okay, I'll try it later.

sosukesuzuki · 2020-06-02T09:44:51Z

done

fisker · 2020-06-02T10:15:15Z

I mean can we print the first part differently in that function?

thorn0 · 2020-06-02T12:59:52Z

Performance-wise, it was better before the change. printBinaryishExpressions is recursive, and we don't need to do this flattening on each recursion level.

thorn0 · 2020-06-02T13:54:40Z

Prettier pr-8476
Playground link

--parser babel

Input:

bifornCringerMoshedPerplexSawder(
  askTrovenaBeenaDependsRowans,
  glimseGlyphsHazardNoopsTieTie,
  averredBathersBoxroomBuggyNurl
) 
|> kochabCooieGameOnOboleUnweave
|> glimseGlyphsHazardNoopsTieTie;

bifornCringerMoshedPerplexSawder(
  askTrovenaBeenaDependsRowans,
  glimseGlyphsHazardNoopsTieTie,
  averredBathersBoxroomBuggyNurl
) // comment
|> kochabCooieGameOnOboleUnweave
|> glimseGlyphsHazardNoopsTieTie;

Output:

bifornCringerMoshedPerplexSawder(
  askTrovenaBeenaDependsRowans,
  glimseGlyphsHazardNoopsTieTie,
  averredBathersBoxroomBuggyNurl
)
  |> kochabCooieGameOnOboleUnweave
  |> glimseGlyphsHazardNoopsTieTie;

bifornCringerMoshedPerplexSawder(
    askTrovenaBeenaDependsRowans,
    glimseGlyphsHazardNoopsTieTie,
    averredBathersBoxroomBuggyNurl
  )  // comment
  |> kochabCooieGameOnOboleUnweave
  |> glimseGlyphsHazardNoopsTieTie;

sosukesuzuki · 2020-06-02T20:47:34Z

@fisker

I mean can we print the first part differently in that function?

I tried but I was not sure how to print it differently...

@thorn0

Performance-wise, it was better before the change. printBinaryishExpressions is recursive, and we don't need to do this flattening on each recursion level.

the flattening is actually done only when the parent node type is ExpressionStatement so I think this is no problem for performance.

thorn0 · 2020-06-02T20:51:40Z

@sosukesuzuki I'd try to do flattening where printComments is called. parts is an array everywhere, assigning it the result of the printComments call, which is a Doc { type: "concat" }, doesn't look right. See also #8451 (comment)

thorn0 · 2020-06-02T20:53:18Z

+    if (isBinaryish(node) && !node.comments) {
+      return hasTrailingCommentInBinaryish(node.left);
+    }
+    return isBinaryish(node) && hasTrailingComment(node);


Prettier pr-8476
Playground link

--parser babel

Input:

bifornCringerMoshedPerplexSawder( askTrovenaBeenaDependsRowans, glimseGlyphsHazardNoopsTieTie ) |> foo |> kochabCooieGameOnOboleUnweave |> glimseGlyphsHazardNoopsTieTie; bifornCringerMoshedPerplexSawder( askTrovenaBeenaDependsRowans, glimseGlyphsHazardNoopsTieTie ) |> foo // comment |> kochabCooieGameOnOboleUnweave |> glimseGlyphsHazardNoopsTieTie;

Output:

bifornCringerMoshedPerplexSawder( askTrovenaBeenaDependsRowans, glimseGlyphsHazardNoopsTieTie ) |> foo |> kochabCooieGameOnOboleUnweave |> glimseGlyphsHazardNoopsTieTie; bifornCringerMoshedPerplexSawder( askTrovenaBeenaDependsRowans, glimseGlyphsHazardNoopsTieTie ) |> foo // comment |> kochabCooieGameOnOboleUnweave |> glimseGlyphsHazardNoopsTieTie;

sosukesuzuki · 2020-06-03T07:19:43Z

@thorn0 How do you think about adding an option named shouldReturnParts to comments.printComments. See 4ce5bf3

thorn0 · 2020-06-03T08:47:19Z

Looks complicated and I'm not sure it's okay to circumvent the prependCursorPlaceholder calls (need to investigate, I never used formatWithCursor).

I have another idea. There is a function called normalizeParts in language-html/utils. It isn't specific to HTML, so let's extract it to document/doc-utils and call it on the result of our printComments call.

thorn0 · 2020-06-03T14:16:29Z

+        // We group here when the callee is itself a call expression.
+        // See `isLongCurriedCallExpression` for more info.
+        isCallOrOptionalCallExpression(n.callee) ||
+        isBinaryish(path.getParentNode())


No, we can't tackle it this way:

Prettier pr-8476
Playground link

--parser babel

Input:

bifornCringerMoshedPerplexSawder[ askTrovenaBeenaDependsRowans + glimseGlyphsHazardNoopsTieTie ] |> foo // comment |> kochabCooieGameOnOboleUnweave |> glimseGlyphsHazardNoopsTieTie;

Output:

bifornCringerMoshedPerplexSawder[ askTrovenaBeenaDependsRowans + glimseGlyphsHazardNoopsTieTie ] |> foo // comment |> kochabCooieGameOnOboleUnweave |> glimseGlyphsHazardNoopsTieTie;

I know, I'm fixing it.:+1:

done d4e5e6c

thorn0

Looks good. Fixes this place in needs-parens.js:

prettier/src/language-js/needs-parens.js

Lines 138 to 151 in 7659a86

    
           if ( 
        
             (parent.type === "ArrowFunctionExpression" && 
        
             parent.body === node && 
        
             node.type !== "SequenceExpression" && // these have parens added anyway 
        
               util.startsWithNoLookaheadToken( 
        
                 node, 
        
                 /* forbidFunctionClassAndDoExpr */ false 
        
               )) || 
        
             (parent.type === "ExpressionStatement" && 
        
               util.startsWithNoLookaheadToken( 
        
                 node, 
        
                 /* forbidFunctionClassAndDoExpr */ true 
        
               )) 
        
           ) {

alexander-akait · 2020-06-03T15:11:44Z

+  }
+
+  return newParts;
+}


We export this file to plugins, so I think we should documented it

prettier/src/index.js

Line 50 in cedb1a2

doc,

https://github.com/prettier/prettier/blob/cedb1a2c2539fcc5813bc4aa4169401d5ea2d7cd/src/document/index.js

I was wrong, we don't have documentation about utils

This is definitely out of scope for this PR. The entire prettier.doc namespace isn't documented.

alexander-akait

👍

thorn0 · 2020-06-03T15:22:41Z

@sosukesuzuki I think we came close to fixing #1210.

fisker · 2020-06-04T02:45:49Z

With block comment seems ugly

Prettier pr-8476
Playground link

--parser babel

Input:

bifornCringerMoshedPerplexSawder
|> foo 
|> foo /* comment */
|> foo /* comment */
|> kochabCooieGameOnOboleUnweave
|> glimseGlyphsHazardNoopsTieTie;

Output:

bifornCringerMoshedPerplexSawder
  |> foo
  |> foo |>
  /* comment */
  foo |>
  /* comment */
  kochabCooieGameOnOboleUnweave
  |> glimseGlyphsHazardNoopsTieTie;

Prettier 2.0.5
Playground link

--parser babel

Input:

bifornCringerMoshedPerplexSawder
|> foo 
|> foo /* comment */
|> foo /* comment */
|> kochabCooieGameOnOboleUnweave
|> glimseGlyphsHazardNoopsTieTie;

Output:

bifornCringerMoshedPerplexSawder
|> foo
|> foo /* comment */
|> foo /* comment */
  |> kochabCooieGameOnOboleUnweave
  |> glimseGlyphsHazardNoopsTieTie;

thorn0 · 2020-06-04T05:17:31Z

@fisker This is an oversight from #7787. I'm going to revert it.

sosukesuzuki added 9 commits June 2, 2020 01:44

Modify to align binaryish expression with trailing comment

f96c05f

Add tests

2219397

Add comment

f553b6a

Add test

3ff6cb3

Add changelog

efa164f

Fix by lint

98fd68e

Modify to move transformation to printBinaryishExpressions

ff3d58b

Remove unnecessary new line

8bdd7e7

Fix hasTrailingCommentInBinaryish

431ae8a

alexander-akait approved these changes Jun 2, 2020

View reviewed changes

sosukesuzuki added 3 commits June 3, 2020 03:11

Add shouldReturnParts option to printComments

4ce5bf3

Add tests from review

480cd21

Fix by lint

702a0ca

thorn0 reviewed Jun 2, 2020

View reviewed changes

sosukesuzuki added 6 commits June 3, 2020 06:37

Extract and use normalizeParts

040c23e

Group CallExpression when parent node is binaryish

a5ea6ed

Fix by lint

25d991c

Remove unnecessary change

ee57111

Wrap the doc of most left node with group

d4e5e6c

Add tests

cedb1a2

This comment has been minimized.

Sign in to view

sosukesuzuki marked this pull request as draft June 3, 2020 13:29

thorn0 reviewed Jun 3, 2020

View reviewed changes

sosukesuzuki marked this pull request as ready for review June 3, 2020 14:41

thorn0 approved these changes Jun 3, 2020

View reviewed changes

alexander-akait reviewed Jun 3, 2020

View reviewed changes

Update pr-8476.md

2a33356

sosukesuzuki changed the title ~~JavaScript: Align indentation for binary/logical expression statements with trailing comments~~ JavaScript: Fix indentation for binary expressions with trailing comments Jun 3, 2020

This comment has been minimized.

Sign in to view

thorn0 mentioned this pull request Jun 3, 2020

Fix unstable comment in binary expression #8491

Merged

4 tasks

fisker approved these changes Jun 4, 2020

View reviewed changes

thorn0 merged commit 9c67e7b into prettier:master Jun 4, 2020

sosukesuzuki deleted the 8451 branch June 4, 2020 06:53

fisker mentioned this pull request Jun 21, 2020

Improve multiparser handle finalNewLine and frontMatter #8595

Merged

1 task

github-actions Bot locked as resolved and limited conversation to collaborators Jun 5, 2021

	if (
	(parent.type === "ArrowFunctionExpression" &&
	parent.body === node &&
	node.type !== "SequenceExpression" && // these have parens added anyway
	util.startsWithNoLookaheadToken(
	node,
	/* forbidFunctionClassAndDoExpr */ false
	)) \|\|
	(parent.type === "ExpressionStatement" &&
	util.startsWithNoLookaheadToken(
	node,
	/* forbidFunctionClassAndDoExpr */ true
	))
	) {

Uh oh!

Conversation

sosukesuzuki commented Jun 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fisker commented Jun 2, 2020

Uh oh!

sosukesuzuki commented Jun 2, 2020

Uh oh!

sosukesuzuki commented Jun 2, 2020

Uh oh!

fisker commented Jun 2, 2020

Uh oh!

thorn0 commented Jun 2, 2020

Uh oh!

thorn0 commented Jun 2, 2020

Uh oh!

sosukesuzuki commented Jun 2, 2020

Uh oh!

thorn0 commented Jun 2, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sosukesuzuki commented Jun 3, 2020

Uh oh!

thorn0 commented Jun 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thorn0 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexander-akait left a comment

Choose a reason for hiding this comment

Uh oh!

thorn0 commented Jun 3, 2020

Uh oh!

This comment has been minimized.

fisker commented Jun 4, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thorn0 commented Jun 4, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sosukesuzuki commented Jun 2, 2020 •

edited

Loading

thorn0 commented Jun 3, 2020 •

edited

Loading

thorn0 left a comment •

edited

Loading

fisker commented Jun 4, 2020 •

edited

Loading

thorn0 commented Jun 4, 2020 •

edited

Loading