Added support for customizing the output color for #582. #585

AdamMc331 · 2019-09-17T18:12:24Z

Summary

This resolves the issue discussed here, that the default DARK_GRAY background color was hard to read against dark terminals: #582

Usage

I made sure this was a non breaking change by allowing the current usage of KtLint to behave the way it does now. For example:

./ktlint
- Will output without color as it does now
./ktlint --color
- Will color the output in DARK_GRAY as it does now
./ktlint --color --color-name="RED"
- Will color the output in RED, or whatever was supplied.

How it was tested

I've added unit tests to PlainReporterTest to validate the colored output. I also added PlainReporterProviderTest which ensures the input for a color maps to the expected output.

I also ran this manually. Here is KtLint with no command args:

Here it is with --color:

Here it is with --color --colorName="RED":

romtsn · 2019-09-18T20:39:25Z

ktlint/src/main/kotlin/com/pinterest/ktlint/Main.kt

@@ -128,9 +128,10 @@ class KtlintCommandLine {

    @Option(
        names = ["--color"],
-        description = ["Make output colorful"]
+        description = ["Make output colorful. To specify the color, use --COLOR=RED"],


I think it's better to specify lowercase --color here, because picocli is case sensitive. You'll end up with UnmatchedArgumentException otherwise.

romtsn · 2019-09-18T20:42:08Z

...-reporter-plain/src/main/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterProvider.kt

+    private fun getColor(colorInput: String?): Color? {
+        return when (colorInput) {
+            "null" -> null
+            else -> Color.values().firstOrNull { it.name == colorInput } ?: Color.DARK_GRAY


Not sure, maybe it's better not to fallback to gray color here, but behave like the value wasn't supplied? Or maybe even throw an exception that the argument is not matched.

AdamMc331 · 2019-09-19T02:59:58Z

@rom4ek Thanks for the feedback! I think those were good changes and I've made the updates.

Let me know what you think of this. Also if you want me to rebase and squash these commits into one I'd be happy to once we resolve the reviews.

romtsn · 2019-09-21T13:25:07Z

@AdamMc331 not that I pretended to review, but lgtm, I think it's a great improvement :)

shashachu · 2019-09-24T05:31:35Z

@AdamMc331 thanks for the PR! Can you see what happens if you pass in a color for ./ktlint --color=RED printAST? Assuming it's not supported but wondering if maybe we should error out, or print a warning about it.

AdamMc331 · 2019-09-24T13:37:47Z

I get output like this, but I don't see anything colored red. Should I expect to? I'm not familiar with printAST.

I just realized that causes an interesting problem with this though. If I were to run just ./ktlint --color printAST, it reads printAST as the color name and so it crashes. So this can't be merged yet. I'll do some digging and figure out how to handle that.

Tapchicoma · 2019-09-25T18:27:26Z

ktlint/src/main/kotlin/com/pinterest/ktlint/Main.kt

    )
-    var color: Boolean = false
+    var color: String? = null


Changing type here will be a breaking change.

I would propose to introduce additional parameter --console-main-color (short -C), that will be strongly typed Color: https://picocli.info/#_enum_types with default value Color.NO_COLOR. Additionally deprecate --color parameter.

@Tapchicoma Do you think I may still run into the problem mentioned here where if I did --console-main-color printAST it would be interpreted as the param name? #585 (comment)

I can test later to be sure, I'm still learning picocli.

This particular problem comes from arity = "0..1" that allows to not have option value: https://picocli.info/#_arity. In the case above printAST is parsed as optional option value and not as subcommand.

My proposal for --console-main-color is to have mandatory option value (basically arity = "1")

Okay. Should be easy enough. I'm a little iffy about deprecating --color. The other alternative could be to introduce a new parameter, --color-name but then I think that's kind of annoying to ask the user to specify two parameters and do --color --color-name RED.

Which would you prefer?

Maybe yes, let's leave --color option that would just enable output coloring with default color (RED?) and --color-name that could be used to change color value.

AdamMc331 · 2019-09-30T16:23:16Z

Okay I've updated this to use a second parameter after all, which should be a non breaking change but provide people with this additional functionality.

What is the rule when it comes to changelog/README? Should I update those files to account for this change too, or will that happen closer to the release process?

Tapchicoma

LGTM! Thank you for your contribution.

Changelog will be updated before release.

Tapchicoma · 2019-10-01T19:46:45Z

...orter-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterProviderTest.kt

+        } catch (iae: IllegalArgumentException) {
+            // Expected case
+        } catch (e: Exception) {
+            fail("Expected IllegalArgumentException but was: $e")


Nit: you don't need to add Exception catch block. If code will throw uncaught exception - test will fail.

Ooo whoops. Want me to fix?

Tapchicoma · 2019-10-01T19:47:34Z

...orter-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterProviderTest.kt

+import org.junit.Assert.fail
+import org.junit.Test
+
+class PlainReporterProviderTest {


Thank you for adding tests 👍

Tapchicoma · 2019-10-01T20:02:04Z

ktlint/src/main/kotlin/com/pinterest/ktlint/Main.kt

+        names = ["--color-name"],
+        description = ["Customize the output color"]
+    )
+    var colorName: String = Color.DARK_GRAY.name


Would be nice to use here enum type, but it will require a lot of changes :(

I agree and thought the same but I wasn't sure if I could reference an enum as a command line argument? I assumed it had to be a string. If you know something I don't - let me know and I can try to adjust.

AdamMc331 · 2019-10-01T20:05:40Z

Whoops replied while merging happened. Let me know if anything was glaring and we can talk about it as a future follow up. Thanks for reviewing!

AdamMc331 mentioned this pull request Sep 17, 2019

Customize console output color? #582

Closed

romtsn reviewed Sep 18, 2019

View reviewed changes

Tapchicoma reviewed Sep 25, 2019

View reviewed changes

AdamMc331 added 2 commits September 30, 2019 12:15

Added support for customizing the output color for pinterest#582.

f5a71d1

Fixed test compilation.

ed35f20

AdamMc331 force-pushed the KTL-582/customize-color branch from c46cd9c to ed35f20 Compare September 30, 2019 16:17

AdamMc331 requested a review from Tapchicoma September 30, 2019 16:23

Tapchicoma approved these changes Oct 1, 2019

View reviewed changes

Tapchicoma merged commit 6815796 into pinterest:master Oct 1, 2019

AdamMc331 deleted the KTL-582/customize-color branch October 1, 2019 20:14

AdamMc331 mentioned this pull request Oct 1, 2019

Is it possible to pass our own command line arguments? JLLeitschuh/ktlint-gradle#290

Closed

AdamMc331 mentioned this pull request Oct 20, 2019

Added output color name property. JLLeitschuh/ktlint-gradle#297

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for customizing the output color for #582. #585

Added support for customizing the output color for #582. #585

AdamMc331 commented Sep 17, 2019 •

edited

Loading

romtsn Sep 18, 2019 •

edited

Loading

romtsn Sep 18, 2019

AdamMc331 commented Sep 19, 2019

romtsn commented Sep 21, 2019

shashachu commented Sep 24, 2019

AdamMc331 commented Sep 24, 2019

Tapchicoma Sep 25, 2019

AdamMc331 Sep 25, 2019

Tapchicoma Sep 25, 2019

AdamMc331 Sep 25, 2019

Tapchicoma Sep 26, 2019

AdamMc331 commented Sep 30, 2019

Tapchicoma left a comment

Tapchicoma Oct 1, 2019

AdamMc331 Oct 1, 2019

Tapchicoma Oct 1, 2019

Tapchicoma Oct 1, 2019

AdamMc331 Oct 1, 2019

AdamMc331 commented Oct 1, 2019

Added support for customizing the output color for #582. #585

Added support for customizing the output color for #582. #585

Conversation

AdamMc331 commented Sep 17, 2019 • edited Loading

Summary

Usage

How it was tested

romtsn Sep 18, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AdamMc331 commented Sep 19, 2019

romtsn commented Sep 21, 2019

shashachu commented Sep 24, 2019

AdamMc331 commented Sep 24, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AdamMc331 commented Sep 30, 2019

Tapchicoma left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AdamMc331 commented Oct 1, 2019

AdamMc331 commented Sep 17, 2019 •

edited

Loading

romtsn Sep 18, 2019 •

edited

Loading