-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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.
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
Implement multilineObject config option #16163
Open
pauldraper
wants to merge
1
commit into
prettier:main
Choose a base branch
from
pauldraper:pauldraper/multiline-object
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,32 @@ | ||||||
#### Implement multilineObject config option (#16163 by @pauldraper) | ||||||
|
||||||
Prettier has historically done semi-manual formatting of multi-line JavaScript object literals. | ||||||
|
||||||
Namely, an object is kept on multiple lines if there is a newline prior to the first property, even if it could fit on a single line. | ||||||
|
||||||
While this behavior continues to be the default, `--multiline-object=collapse` instead ignores whitespace when formatting object literals. | ||||||
|
||||||
<!-- prettier-ignore --> | ||||||
```js | ||||||
// Input | ||||||
const obj1 = { | ||||||
name1: "value1", name2: "value2", | ||||||
}; | ||||||
|
||||||
const obj2 = { name1: "value1", | ||||||
name2: "value2", | ||||||
}; | ||||||
|
||||||
// Prettier stable | ||||||
const obj1 = { | ||||||
name1: "value1", | ||||||
name2: "value2", | ||||||
}; | ||||||
|
||||||
const obj2 = { name1: "value1", name2: "value2" }; | ||||||
|
||||||
// Prettier main | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
const obj1 = { name1: "value1", name2: "value2" }; | ||||||
|
||||||
const obj2 = { name1: "value1", name2: "value2" }; | ||||||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
87 changes: 87 additions & 0 deletions
87
tests/format/js/object-multiline/__snapshots__/jsfmt.spec.js.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
// Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
||
exports[`multiline.js - {"multilineObject":"collapse"} format 1`] = ` | ||
====================================options===================================== | ||
multilineObject: "collapse" | ||
parsers: ["babel", "flow"] | ||
printWidth: 80 | ||
| printWidth | ||
=====================================input====================================== | ||
const a = { | ||
name1: 'value1', | ||
name2: 'value2', | ||
}; | ||
|
||
const b = { name1: 'value1', | ||
name2: 'value2', | ||
}; | ||
|
||
const c = { | ||
name1: 'value1', name2: 'value2', | ||
}; | ||
|
||
const d = { | ||
name1: 'value1', name2: 'value2', }; | ||
|
||
const e = { name1: 'value1', name2: 'value2', }; | ||
|
||
=====================================output===================================== | ||
const a = { name1: "value1", name2: "value2" }; | ||
|
||
const b = { name1: "value1", name2: "value2" }; | ||
|
||
const c = { name1: "value1", name2: "value2" }; | ||
|
||
const d = { name1: "value1", name2: "value2" }; | ||
|
||
const e = { name1: "value1", name2: "value2" }; | ||
|
||
================================================================================ | ||
`; | ||
|
||
exports[`multiline.js format 1`] = ` | ||
====================================options===================================== | ||
parsers: ["babel", "flow", "typescript"] | ||
printWidth: 80 | ||
| printWidth | ||
=====================================input====================================== | ||
const a = { | ||
name1: 'value1', | ||
name2: 'value2', | ||
}; | ||
|
||
const b = { name1: 'value1', | ||
name2: 'value2', | ||
}; | ||
|
||
const c = { | ||
name1: 'value1', name2: 'value2', | ||
}; | ||
|
||
const d = { | ||
name1: 'value1', name2: 'value2', }; | ||
|
||
const e = { name1: 'value1', name2: 'value2', }; | ||
|
||
=====================================output===================================== | ||
const a = { | ||
name1: "value1", | ||
name2: "value2", | ||
}; | ||
|
||
const b = { name1: "value1", name2: "value2" }; | ||
|
||
const c = { | ||
name1: "value1", | ||
name2: "value2", | ||
}; | ||
|
||
const d = { | ||
name1: "value1", | ||
name2: "value2", | ||
}; | ||
|
||
const e = { name1: "value1", name2: "value2" }; | ||
|
||
================================================================================ | ||
`; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
runFormatTest(import.meta, ["babel", "flow", "typescript"]); | ||
runFormatTest(import.meta, ["babel", "flow"], { multilineObject: "collapse" }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
const a = { | ||
name1: 'value1', | ||
name2: 'value2', | ||
}; | ||
|
||
const b = { name1: 'value1', | ||
name2: 'value2', | ||
}; | ||
|
||
const c = { | ||
name1: 'value1', name2: 'value2', | ||
}; | ||
|
||
const d = { | ||
name1: 'value1', name2: 'value2', }; | ||
|
||
const e = { name1: 'value1', name2: 'value2', }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.