Add parser support for --lines, --offset, --length#627
Open
ZacSweers wants to merge 10 commits into
Open
Conversation
meta-cla
Bot
added
the
CLA Signed
hick209
requested changes
Jun 15, 2026
hick209
left a comment
hick209
left a comment
Contributor
There was a problem hiding this comment.
Just haven't finished core/src/main/java/com/facebook/ktfmt/format/Formatter.kt, but here's the start.
I'll resume tomorrow
| return parts[1].takeIf { parts[0] == key || parts.size == 2 } | ||
| } | ||
|
|
||
| private fun String?.toIntOrNull(): Int? { |
Contributor
There was a problem hiding this comment.
Any reason why we re-implement this here?
Isn't there an equivalent in the core Kotlin API?
Comment on lines
+167
to
+184
| arg == "--lines" || arg == "--line" -> { | ||
| val value = | ||
| nextValue() ?: return ParseResult.Error("required value was not provided for: $arg") | ||
| when (val result = parseLineRanges(lineRanges, value)) { | ||
| LineRangeParseResult.Success -> Unit | ||
| is LineRangeParseResult.Error -> return ParseResult.Error(result.message) | ||
| } | ||
| } | ||
| arg.startsWith("--lines=") -> | ||
| when (val result = parseLineRanges(lineRanges, parseKeyValueArg("--lines", arg))) { | ||
| LineRangeParseResult.Success -> Unit | ||
| is LineRangeParseResult.Error -> return ParseResult.Error(result.message) | ||
| } | ||
| arg.startsWith("--line=") -> | ||
| when (val result = parseLineRanges(lineRanges, parseKeyValueArg("--line", arg))) { | ||
| LineRangeParseResult.Success -> Unit | ||
| is LineRangeParseResult.Error -> return ParseResult.Error(result.message) | ||
| } |
Contributor
There was a problem hiding this comment.
Could likely be simplified to something like this or similar. Same goes for the options below
arg.startsWith("--line") -> {
val argSplit = arg.split('=', limit = 2)
val key = argSplit.first()
if (key != "--lines" && key != "--line") {
ParseResult.Error("Unexpected option: $key")
}
val value = if (argSplit.size > 1) argSplit.last() else nextValue() ?: return ParseResult.Error("required value was not provided for: $key")
when (val result = parseLineRanges(lineRanges, value)) {
LineRangeParseResult.Success -> Unit
is LineRangeParseResult.Error -> return ParseResult.Error(result.message)
}
}
Comment on lines
+269
to
+270
| private fun invalidInt(flag: String, value: String?): String = | ||
| "invalid integer value for $flag: $value" |
Contributor
There was a problem hiding this comment.
Doesn't feel like this method adds much value. I won't stop if you like it though
| @Test | ||
| fun `parseOptions recognizes --lines ranges`() { | ||
| val parsed = | ||
| assertSucceeds(ParsedArgs.parseOptions(arrayOf("--lines=1:3,5", "--lines", "7", "foo.kt"))) |
Contributor
There was a problem hiding this comment.
Maybe create a helper to reduce boilerplate here (not on you really, but since you are touching it, you know 😅)
// In this test file here
private fun parseOptions(vararg options: String) =
ParsedArgs.parseOptions(options.toTypedArray())
Comment on lines
+383
to
+387
| private fun lineRanges(vararg ranges: Range<Int>): RangeSet<Int> { | ||
| return ranges(*ranges) | ||
| } | ||
|
|
||
| private fun ranges(vararg ranges: Range<Int>): RangeSet<Int> { |
Contributor
There was a problem hiding this comment.
Why both of those here? Let's just pick one and go with that
Comment on lines
+378
to
+379
| parsedArgs.lineRanges.addAll(lineRanges) | ||
| parsedArgs.characterRanges.addAll(characterRanges) |
Contributor
There was a problem hiding this comment.
The logic here doesn't feel like it should live here for me.
Thoughts?
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Resolves #218 and includes IDE support as well.
Note that I opted to match GJF's current behavior and allow statement-level boundaries (the issue described function-level granularity only, but that's not what I see GJF do).