-
Notifications
You must be signed in to change notification settings - Fork 276
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
PolicyOps: use newlines.ignoreInSyntax
#3613
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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 |
---|---|---|
|
@@ -2576,6 +2576,44 @@ newlines.inInterpolation | |
- `avoid`: attemps to avoid breaks within the spliced code, regardless of line overflow | ||
- `oneline`: formats the splice on a single line, or breaks after `${` if overflows | ||
|
||
### `newlines.ignoreInSyntax` | ||
|
||
The formatter frequently chooses between adding a newline and continuing the | ||
same line but either prohibiting or heavily discouraging subsequent newlines | ||
_between_ tokens, to fit the rest of the expression on the same line. | ||
|
||
However, in many cases and, for historical reasons, intentionally, newlines | ||
_within_ tokens have been frequently ignored, leading to "single-line" blocks | ||
which actually span multiple lines. | ||
|
||
This boolean parameter now allows controlling whether to ignore newlines found | ||
in syntax of strings or other possibly multi-line tokens when newlines are | ||
otherwise prohibited or undesirable (such as for single-line formatting). | ||
|
||
```scala mdoc:defaults | ||
newlines.ignoreInSyntax | ||
``` | ||
|
||
> Since v3.7.13. Prior to that, this behaviour was always enabled. | ||
|
||
```scala mdoc:scalafmt | ||
newlines.ignoreInSyntax = true | ||
--- | ||
// ignores newline in string, pretends everything fits on one line | ||
println(s"""${1} | ||
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. this is an example. contains newline but will be formatted without breaks around open and close parentheses. |
||
""".stripMargin | ||
) | ||
``` | ||
|
||
```scala mdoc:scalafmt | ||
newlines.ignoreInSyntax = false | ||
--- | ||
// detects newline in string, forces proper multi-line formatting | ||
println(s"""${1} | ||
""".stripMargin | ||
) | ||
``` | ||
|
||
### `optIn.annotationNewlines` | ||
|
||
This boolean parameter controls newlines after annotations. | ||
|
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
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.
@tgodzik do you think this explanation makes it a bit clearer?
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.
leading to "single-line" blocks which actually span multiple lines.
is a bit unclear to me, though I guess the example here would need to be the best explanation we can get