Compare command chores #7947
Compare command chores #7947
Conversation
Signed-off-by: Sebastian Schuberth <[email protected]>
While the `enum class` does not need command context, a nested class in Kotlin does not have outer class context anyway (only `inner` classes have), so it does not hurt to scope the enum to the command where it is being used. Signed-off-by: Sebastian Schuberth <[email protected]>
Use a more general name as this is now used for serializing, too. Signed-off-by: Sebastian Schuberth <[email protected]>
Use code 1 for fundamental errors that prevent the command from properly executing, and codes >= 2 to signal failures detected as part of running the command properly. Signed-off-by: Sebastian Schuberth <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7947 +/- ##
=========================================
Coverage 66.99% 66.99%
Complexity 2041 2041
=========================================
Files 356 356
Lines 17103 17103
Branches 2443 2443
=========================================
Hits 11459 11459
Misses 4623 4623
Partials 1021 1021
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| @@ -70,6 +71,12 @@ class CompareCommand : OrtCommand( | |||
| ).enum<CompareMethod>() | |||
| .default(CompareMethod.TEXT_DIFF) | |||
|
|
|||
| private val contextSize by option( | |||
| "--context-size", "-s", | |||
| help = "The context size to use for the unified diff." | |||
There was a problem hiding this comment.
Could we make the help explain a bit what the context size actually is?
e.g. "number of lines to be copied" ?
There was a problem hiding this comment.
Hmm, this is not the "number of lines to be copied", but the number of (unmodified) lines displayed in context of a modified like, just like for the diff or git diff commands. I'll try to find a compact wording.
| @@ -70,6 +71,12 @@ class CompareCommand : OrtCommand( | |||
| ).enum<CompareMethod>() | |||
| .default(CompareMethod.TEXT_DIFF) | |||
|
|
|||
| private val contextSize by option( | |||
| "--context-size", "-s", | |||
There was a problem hiding this comment.
How about using -c instead of -s like grep and diff ?
There was a problem hiding this comment.
The mentioned tools use upper-case -C, however. I'm now using that as well.
There was a problem hiding this comment.
They use both
diff --help | grep context
-c, -C NUM, --context[=NUM] output NUM (default 3) lines of copied context
There was a problem hiding this comment.
Not on my Linux box:
$ grep --help | grep -- "-[cC],"
-c, --count print only a count of selected lines per FILE
-C, --context=NUM print NUM lines of output context
$ grep --version
grep (GNU grep) 3.11
$ git grep --help | grep -- "-[cC][, ]"
[ -o | --only-matching ] [-c | --count] [--all-match] [-q | --quiet]
[-A <post-context>] [-B <pre-context>] [-C <context>]
-c, --count
-<num>, -C <num>, --context <num>
There was a problem hiding this comment.
Ah, sorry, you were looking at diff and me at grep... I guess diff makes more sense as a reference, but since -C seem to be the "lowest common denominator", shall we stick to it?
sschuberth
force-pushed
the
compare-cmd-chores
branch
from
b1d1ae1 to
a901217
Compare
Signed-off-by: Sebastian Schuberth <[email protected]>
sschuberth
force-pushed
the
compare-cmd-chores
branch
from
a901217 to
b068067
Compare
Please have a look at the individual commit messages for the details.