Support NO_COLOR env var for wemake formatter (#2750)

wemake-services · Oct 10, 2023 · 98261fa · 98261fa
1 parent 54c9f93
commit 98261fa
Show file tree

Hide file tree

Showing 5 changed files with 725 additions and 30 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,12 +16,19 @@ Semantic versioning in our case means:
   But, in the future we might change the configuration names/logic,
   change the client facing API, change code conventions significantly, etc.
 
+
 ## WIP
 
+### Features
+
+- `wemake` output formatter now respects `NO_COLOR=1` option
+  to disable text highlighting. See https://no-color.org
+
 ### Bugfixes
 
 - Fix `ForbiddenInlineIgnoreViolation` config parsing. #2590
 
+
 ## 0.18.0
 
 ### Features

diff --git a/docs/pages/usage/formatter.rst b/docs/pages/usage/formatter.rst
@@ -114,3 +114,12 @@ You can also show links to the documentation pages of violations:
 In modern terminals, you can click them to open the respective docs page.
 
 We do not include ``show-violation-links`` in our default configuration.
+
+
+.. rubric:: Disabling colors and text highlight
+
+Set ``NO_COLOR=1`` environment variable
+to completely disable all text highligt and colors
+in ``wemake`` formatter.
+
+See https://no-color.org for more information about ``NO_COLOR``.