Skip to content

YAML: Fix printing doubles a blank line before a comment #9143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexander-akait merged 12 commits into from
Sep 7, 2020
Merged

YAML: Fix printing doubles a blank line before a comment #9143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
84f97df
Print hardline for endComments only when under mappingValue
sosukesuzuki Sep 3, 2020
a1d9395
Add changelog
sosukesuzuki Sep 4, 2020
3b4b8f9
Fix from linter
sosukesuzuki Sep 4, 2020
6c666fc
Update tests
sosukesuzuki Sep 4, 2020
70b5a76
Use shouldPrintEndCommentsWithAlign
sosukesuzuki Sep 4, 2020
1ea45d4
Add tests
sosukesuzuki Sep 4, 2020
9562fe4
Add test
fisker Sep 7, 2020
3fb93b0
Fix format
fisker Sep 7, 2020
6d921b2
Update test
fisker Sep 7, 2020
c0ed2fe
Test map too
fisker Sep 7, 2020
ea4a29d
Update tests
fisker Sep 7, 2020
1bd970f
`shouldPrintEndCommentsWithAlign` -> `shouldPrintEndComments`
fisker Sep 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions changelog_unreleased/yaml/pr-9143.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#### Fix printing doubles a blank line before a comment (#9143 by @sosukesuzuki)

<!-- prettier-ignore -->
```yaml
# Input
- foo: 0
bar: 1

# baz: 2
- quux: 3

# Prettier stable
- foo: 0
bar: 1


# baz: 2
- quux: 3

# Prettier master
- foo: 0
bar: 1

# baz: 2
- quux: 3

```
14 changes: 11 additions & 3 deletions src/language-yaml/printer-yaml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,7 @@ function genericPrint(path, options, print) {
])
)
: "",
nextEmptyLine,
hasEndComments(node) && !isNode(node, ["documentHead", "documentBody"])
shouldPrintEndComments(node)
? align(
node.type === "sequenceItem" ? 2 : 0,
concat([
Expand All @@ -153,6 +152,7 @@ function genericPrint(path, options, print) {
])
)
: "",
nextEmptyLine,
]);
}

Expand Down Expand Up @@ -703,6 +703,12 @@ function needsSpaceInFrontOfMappingValue(node) {
return node.key.content && node.key.content.type === "alias";
}

function shouldPrintEndComments(node) {
return (
hasEndComments(node) && !isNode(node, ["documentHead", "documentBody"])
);
}

function printNextEmptyLine(path, originalText) {
const node = path.getValue();
const root = path.stack[0];
Expand All @@ -713,7 +719,9 @@ function printNextEmptyLine(path, originalText) {
if (!root.isNextEmptyLinePrintedChecklist[node.position.end.line]) {
if (isNextLineEmpty(node, originalText)) {
root.isNextEmptyLinePrintedChecklist[node.position.end.line] = true;
return softline;
if (!shouldPrintEndComments(path.getParentNode())) {
return softline;
}
}
}

Expand Down
202 changes: 202 additions & 0 deletions tests/yaml/comment/__snapshots__/jsfmt.spec.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,44 @@ printWidth: 80
================================================================================
`;

exports[`issue-9130.yml format 1`] = `
====================================options=====================================
parsers: ["yaml"]
printWidth: 80
| printWidth
=====================================input======================================
- foo: 0
bar: 1

# baz: 2
- quux: 3

- foo: 0
bar: 1

# baz: 2

# baz: 3
- quux: 3

=====================================output=====================================
- foo: 0
bar: 1

# baz: 2
- quux: 3

- foo: 0
bar: 1

# baz: 2

# baz: 3
- quux: 3

================================================================================
`;

exports[`map.yml format 1`] = `
====================================options=====================================
parsers: ["yaml"]
Expand Down Expand Up @@ -282,6 +320,69 @@ foo2:
================================================================================
`;

exports[`map-4.yml format 1`] = `
====================================options=====================================
parsers: ["yaml"]
printWidth: 80
| printWidth
=====================================input======================================
before:

# before.comment
after:
# after.comment

before-after:

# before-after.comment

none:
# none.comment
before(2 line):


# before.comment
after(2 line):
# after.comment


before-after(2 line):


# before-after.comment


none(2):
# none.comment
=====================================output=====================================
before:

# before.comment
after:
# after.comment

before-after:

# before-after.comment

none:
# none.comment
before(2 line):

# before.comment
after(2 line):
# after.comment

before-after(2 line):

# before-after.comment

none(2):
# none.comment

================================================================================
`;

exports[`object.yml format 1`] = `
====================================options=====================================
parsers: ["yaml"]
Expand Down Expand Up @@ -336,6 +437,107 @@ printWidth: 80
================================================================================
`;

exports[`sequence.yml format 1`] = `
====================================options=====================================
parsers: ["yaml"]
printWidth: 80
| printWidth
=====================================input======================================
- - a

# - b

# - c

- e

- - a

# - b

# - c

=====================================output=====================================
- - a

# - b

# - c

- e

- - a

# - b

# - c

================================================================================
`;

exports[`sequence-2.yml format 1`] = `
====================================options=====================================
parsers: ["yaml"]
printWidth: 80
| printWidth
=====================================input======================================
- before

# before.comment
- after
# after.comment

- before-after

# before-after.comment

- none:
# none.comment
- before(2 line)


# before.comment
- after(2 line)
# after.comment


- before-after(2 line)


# before-after.comment


- none(2)
# none.comment
=====================================output=====================================
- before

# before.comment
Comment on lines +513 to +515
Copy link
Member

@fisker fisker Sep 7, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is strange!!!

Prettier pr-9143
Playground link

--parser yaml

Input:

foo:
  # comment
bar:
  # comment

Output:

foo:
  # comment
bar:
  # comment

Prettier pr-9143
Playground link

--parser yaml

Input:

foo:
  # comment
barr:
  # comment

Output:

foo:
# comment   <---  this comment didn't indent, next key is `barr`
barr:
  # comment

Copy link
Member

@fisker fisker Sep 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, seems attaching logic issue. I'll open an issue in the parser.

Copy link
Member

@fisker fisker Sep 7, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue in yaml-unist-parser prettier/yaml-unist-parser#275

- after
# after.comment

- before-after

# before-after.comment

- none:
# none.comment
- before(2 line)

# before.comment
- after(2 line)
# after.comment

- before-after(2 line)

# before-after.comment

- none(2)
# none.comment

================================================================================
`;

exports[`set.yml format 1`] = `
====================================options=====================================
parsers: ["yaml"]
Expand Down
13 changes: 13 additions & 0 deletions tests/yaml/comment/issue-9130.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
- foo: 0
bar: 1

# baz: 2
- quux: 3

- foo: 0
bar: 1

# baz: 2

# baz: 3
- quux: 3
28 changes: 28 additions & 0 deletions tests/yaml/comment/map-4.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
before:

# before.comment
after:
# after.comment

before-after:

# before-after.comment

none:
# none.comment
before(2 line):


# before.comment
after(2 line):
# after.comment


before-after(2 line):


# before-after.comment


none(2):
# none.comment
28 changes: 28 additions & 0 deletions tests/yaml/comment/sequence-2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
- before

# before.comment
- after
# after.comment

- before-after

# before-after.comment

- none:
# none.comment
- before(2 line)


# before.comment
- after(2 line)
# after.comment


- before-after(2 line)


# before-after.comment


- none(2)
# none.comment
13 changes: 13 additions & 0 deletions tests/yaml/comment/sequence.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
- - a

# - b

# - c

- e

- - a

# - b

# - c