mirror of
https://github.com/mgechev/revive.git
synced 2025-02-11 13:38:40 +02:00
feat(color): updated the README.md file about overriding colorization
This commit is contained in:
parent
2e98c7c63a
commit
acce9eb309
13
README.md
13
README.md
@ -80,6 +80,7 @@ Here's how `revive` is different from `golint`:
|
||||
- [Speed Comparison](#speed-comparison)
|
||||
- [golint](#golint)
|
||||
- [revive](#revive)
|
||||
- [Overriding colorization detection](#overriding-colorization-detection)
|
||||
- [Contributors](#contributors)
|
||||
- [License](#license)
|
||||
|
||||
@ -485,6 +486,18 @@ sys 0m17.192s
|
||||
|
||||
Currently, type checking is enabled by default. If you want to run the linter without type checking, remove all typed rules from the configuration file.
|
||||
|
||||
## Overriding colorization detection
|
||||
|
||||
By default, `revive` determines whether or not to colorize its output based on whether it's connected to a TTY or not.
|
||||
This works for most use cases, but may not behave as expected if you use `revive` in a pipeline of commands,
|
||||
where STDOUT is being piped to another command.
|
||||
|
||||
To force colorization, add `REVIVE_FORCE_COLOR=1` to the environment you're running in. For example:
|
||||
|
||||
```shell
|
||||
REVIVE_FORCE_COLOR=1 revive -formatter friendly ./... | tee revive.log
|
||||
```
|
||||
|
||||
## Contributors
|
||||
|
||||
[<img alt="mgechev" src="https://avatars1.githubusercontent.com/u/455023?v=4&s=117" width="117">](https://github.com/mgechev) |[<img alt="chavacava" src="https://avatars2.githubusercontent.com/u/25788468?v=4&s=117" width="117">](https://github.com/chavacava) |[<img alt="xuri" src="https://avatars2.githubusercontent.com/u/2809468?v=4&s=117" width="117">](https://github.com/xuri) |[<img alt="dshemin" src="https://avatars3.githubusercontent.com/u/11780307?v=4&s=117" width="117">](https://github.com/dshemin) |[<img alt="gsamokovarov" src="https://avatars0.githubusercontent.com/u/604618?v=4&s=117" width="117">](https://github.com/gsamokovarov) |[<img alt="morphy2k" src="https://avatars2.githubusercontent.com/u/4280578?v=4&s=117" width="117">](https://github.com/morphy2k) |
|
||||
|
Loading…
x
Reference in New Issue
Block a user