#64 - implement NO_COLOR (#65)

* implement NO_COLOR * Update roxygen comment * roxygenise * test and NEWS * Unset crayon option in NO_COLOR test
r-lib · Feb 8, 2018 · 7008001 · 7008001
1 parent b5221ab
commit 7008001
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/R/has_color.r b/R/has_color.r
@@ -9,6 +9,8 @@
 #'     with [options()], then `TRUE` is returned. If it is
 #'     set to something else than `TRUE` (typically `FALSE`),
 #'     then `FALSE` is returned.
+#'   \item Otherwise, if the `NO_COLOR` environment variable is
+#'     set, `FALSE` is returned.
 #'   \item Otherwise, if the standard output is not a terminal, then
 #'     `FALSE` is returned.
 #'   \item Otherwise, if the platform is Windows, `TRUE` is returned
@@ -49,6 +51,10 @@ has_color <- function() {
   enabled <- getOption("crayon.enabled")
   if (!is.null(enabled)) { return(isTRUE(enabled))  }
 
+  if (!is.na(Sys.getenv("NO_COLOR", NA))) {
+    return(FALSE)
+  }
+
   ## RStudio with (potential) ANSI support?
   if (rstudio_with_ansi_support() && sink.number() == 0) {
     return(TRUE)

diff --git a/inst/NEWS.md b/inst/NEWS.md
@@ -1,3 +1,6 @@
+# Next
+
+* `NO_COLOR` enviroment variable disables color (#64)
 
 # 1.3.4
 

diff --git a/man/has_color.Rd b/man/has_color.Rd
diff --git a/tests/testthat/test-has-color.r b/tests/testthat/test-has-color.r
@@ -89,3 +89,13 @@ test_that("tput errors are handled gracefully", {
   mockery::stub(get_terminal_colors, "system", function(...) 16)
   expect_equal(get_terminal_colors(), 16)
 })
+
+test_that("has_color, NO_COLOR=1", {
+  withr::with_options(
+    list(crayon.enabled = NULL),
+    withr::with_envvar(
+      c(NO_COLOR="1"),
+      expect_false(has_color())
+    )
+  )
+})