Skip to content

[REQ] Log colouration #4615

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

Closed
ybelenko opened this issue Nov 26, 2019 · 8 comments
Closed

[REQ] Log colouration #4615

ybelenko opened this issue Nov 26, 2019 · 8 comments

Comments

@ybelenko
Copy link
Contributor

Is your feature request related to a problem? Please describe.

Right now it's hard to distinguish WARN/DEBUG/ERROR console messages in Macos Terminal. Most of time I ignore these messages, because it looks like INFO noise to me. When you generate the same build over and over again you just check error exit code or something red/yellow coloured in terminal output. If everything white or grey so it looks like nothing bad happened.

Describe the solution you'd like

I think it would be great to add an option of color output to all generators, like it works in maven or other significant libraries.

This line of code works in MacOs Terminal, but we need more global solution.

LOGGER.warn("\u001B[33m" + "Yellow message" + "\u001B[0m");

Describe alternatives you've considered

@Fjolnir-Dvorak suggested log-colouration pipelines. See quotes below.

Additional context

Quotes from Slack conversation:

@jimschubert says:

Another consideration is that we support creating custom standalone generators. Adding colors affects those. See, for example, Apache ServiceComb Toolkit.

@wing328 says:

As a workaround, what about simply grepping for WARN or ERROR in the output ?

@Fjolnir-Dvorak says:

For maven there are log-colouration pipelines. I think that would be the best for openapi-generator, too. If you want coloured output pipe it through a colourization pipe / shell script. That is in my opinion the most versatile and best solution.
That could also be added to the wrapper script and could be enabled via a --colour (or the american --color 🇺🇸) flag

@ybelenko
Copy link
Contributor Author

If you think this is useful feature and we need colors in console output, please add 👍 or any other emote to this message. It's kind of a poll.

@wing328
Copy link
Member

wing328 commented Nov 27, 2019

Have you considered using https://github.com/mihnita/java-color-loggers ?

@wing328
Copy link
Member

wing328 commented Nov 27, 2019

Or use the following as stated in the readme:

Log4j 2 supports colors out of the box: https://logging.apache.org/log4j/2.x/manual/layouts.html#enable-jansi

https://github.com/mihnita/java-color-loggers#log4j-2

@ybelenko
Copy link
Contributor Author

@wing328 Looks promising. Can we add this package to project dependencies or every user should install it manually?

@wing328
Copy link
Member

wing328 commented Nov 27, 2019

We can include it in the project itself.

@ybelenko
Copy link
Contributor Author

We can include it in the project itself.

@wing328 Yeah, that's what I want, definitely!

@jimschubert
Copy link
Member

The project uses logback, not log4j. You'd need to follow the guides provided by logback, which would require an additional package.

@jimschubert
Copy link
Member

Closed via #5193

@jimschubert jimschubert added this to the 4.3.0 milestone Feb 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants