go/revive
1
0
Fork 0
mirror of https://github.com/mgechev/revive.git synced 2025-07-13 01:00:17 +02:00
Code Issues Releases Activity

feat(color): updated the README.md file about overriding colorization

Browse Source
This commit is contained in:
Tymoteusz Blazejczyk
2020-05-14 23:08:30 +02:00
committed by Minko Gechev
parent 2e98c7c63a
commit acce9eb309
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -80,6 +80,7 @@ Here's how `revive` is different from `golint`:
- [Speed Comparison](#speed-comparison) - [Speed Comparison](#speed-comparison)
- [golint](#golint) - [golint](#golint)
- [revive](#revive) - [revive](#revive)
- [Overriding colorization detection](#overriding-colorization-detection)
- [Contributors](#contributors) - [Contributors](#contributors)
- [License](#license) - [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. 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 ## 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) | [<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) |