Merge branch 'master' of github.com:daroczig/logger

.gitignore

@@ -1,2 +1,4 @@
 docs/
 README.html
+
+/.quarto/

R/color.R

@@ -1,9 +1,12 @@
-#' Colorize string by the related log level
+#' Color string by the related log level
 #'
-#' Adding color to a string to be used in terminal output. Supports ANSI standard colors 8 or 256.
-#' @param msg string
+#' Color log messages according to their severity with either a rainbow
+#' or grayscale color scheme. The greyscale theme assumes a dark background on
+#' the terminal.
+#' 
+#' @param msg String to color.
 #' @param level see [log_levels()]
-#' @return string with ANSI escape code
+#' @return A string with ANSI escape codes.
 #' @export
 #' @examplesIf requireNamespace("crayon")
 #' cat(colorize_by_log_level('foobar', FATAL), '\n')
@@ -13,6 +16,14 @@
 #' cat(colorize_by_log_level('foobar', INFO), '\n')
 #' cat(colorize_by_log_level('foobar', DEBUG), '\n')
 #' cat(colorize_by_log_level('foobar', TRACE), '\n')
+#' 
+#' cat(grayscale_by_log_level('foobar', FATAL), '\n')
+#' cat(grayscale_by_log_level('foobar', ERROR), '\n')
+#' cat(grayscale_by_log_level('foobar', WARN), '\n')
+#' cat(grayscale_by_log_level('foobar', SUCCESS), '\n')
+#' cat(grayscale_by_log_level('foobar', INFO), '\n')
+#' cat(grayscale_by_log_level('foobar', DEBUG), '\n')
+#' cat(grayscale_by_log_level('foobar', TRACE), '\n')
 colorize_by_log_level <- function(msg, level) {
 
     fail_on_missing_package('crayon')
@@ -33,22 +44,8 @@ colorize_by_log_level <- function(msg, level) {
 
 }
 
-
-#' Render a string with light/dark gray based on the related log level
-#'
-#' Adding color to a string to be used in terminal output. Supports ANSI standard colors 8 or 256.
-#' @param msg string
-#' @param level see [log_levels()]
-#' @return string with ANSI escape code
 #' @export
-#' @examplesIf requireNamespace("crayon")
-#' cat(grayscale_by_log_level('foobar', FATAL), '\n')
-#' cat(grayscale_by_log_level('foobar', ERROR), '\n')
-#' cat(grayscale_by_log_level('foobar', WARN), '\n')
-#' cat(grayscale_by_log_level('foobar', SUCCESS), '\n')
-#' cat(grayscale_by_log_level('foobar', INFO), '\n')
-#' cat(grayscale_by_log_level('foobar', DEBUG), '\n')
-#' cat(grayscale_by_log_level('foobar', TRACE), '\n')
+#' @rdname colorize_by_log_level
 grayscale_by_log_level <- function(msg, level) {
 
     fail_on_missing_package('crayon')

R/layouts.R

@@ -168,10 +168,15 @@ layout_glue <- layout_glue_generator()
 
 
 #' Format a log message with `glue` and ANSI escape codes to add colors
+#' 
+#' Colour log levels based on their severity. Log levels are coloured
+#' with [colorize_by_log_level()] and the messages are coloured with
+#' [grayscale_by_log_level()].
+#' 
 #' @inheritParams layout_simple
 #' @return character vector
 #' @export
-#' @examples \dontrun{
+#' @examplesIf requireNamespace("crayon")
 #' log_layout(layout_glue_colors)
 #' log_threshold(TRACE)
 #' log_info('Starting the script...')
@@ -182,7 +187,6 @@ layout_glue <- layout_glue_generator()
 #' log_debug('Getting an error is usually bad')
 #' log_error('This is another problem')
 #' log_fatal('The last problem.')
-#' }
 #' @seealso This is a [log_layout()], for alternatives, see [layout_blank()], [layout_simple()], [layout_glue()], [layout_json()], [layout_json_parser()], or generator functions such as [layout_glue_generator()]
 #' @note This functionality depends on the \pkg{crayon} package.
 layout_glue_colors <- layout_glue_generator(

R/utils.R

@@ -92,3 +92,7 @@ catch_base_log <- function(
     log_appender(orginal_appender, namespace = namespace)
     res
 }
+
+in_pkgdown <- function() {
+    identical(Sys.getenv("IN_PKGDOWN"), "true")
+}

R/zzz.R

@@ -10,7 +10,7 @@ namespaces <- new.env()
             threshold = as.loglevel(Sys.getenv('LOGGER_LOG_LEVEL', unset = 'INFO')),
             layout    = layout_simple,
             formatter = formatter_sprintf,
-            appender  = appender_console))
+            appender  = if (in_pkgdown()) appender_stdout else appender_console))
 
     if (requireNamespace('glue', quietly = TRUE)) {
         log_formatter(formatter_glue, namespace = 'global', index = 1)

README.Rmd

@@ -67,7 +67,7 @@ for (letter in letters) {
 log_warn('There might be many, like {1:2} or more warnings!!!')
 ```
 
-You can even use a custom log layout to render the log records with colors, as you can see in `demo(colors, package = 'logger', echo = FALSE)`:
+You can even use a custom log layout to render the log records with colors, as you can see in `layout_glue_colors()`:
 
 <img src="man/figures/colors.png" alt="colored log output">
 

README.md

@@ -46,11 +46,11 @@ messages in ad-hoc and programmatic ways:
 library(logger)
 log_threshold(DEBUG)
 log_info('Script starting up...')
-#> INFO [2024-07-31 08:26:30] Script starting up...
+#> INFO [2024-08-05 16:05:22] Script starting up...
 
 pkgs <- available.packages()
 log_info('There are {nrow(pkgs)} R packages hosted on CRAN!')
-#> INFO [2024-07-31 08:26:30] There are 21122 R packages hosted on CRAN!
+#> INFO [2024-08-05 16:05:23] There are 21132 R packages hosted on CRAN!
 
 for (letter in letters) {
   lpkgs <- sum(grepl(letter, pkgs[, 'Package'], ignore.case = TRUE))
@@ -59,28 +59,27 @@ for (letter in letters) {
     '{lpkgs} R packages including the {shQuote(letter)} letter'
   )
 }
-#> DEBUG [2024-07-31 08:26:30] 10188 R packages including the 'a' letter
-#> DEBUG [2024-07-31 08:26:30] 7013 R packages including the 'c' letter
-#> DEBUG [2024-07-31 08:26:30] 5750 R packages including the 'd' letter
-#> DEBUG [2024-07-31 08:26:30] 10902 R packages including the 'e' letter
-#> DEBUG [2024-07-31 08:26:30] 8821 R packages including the 'i' letter
-#> DEBUG [2024-07-31 08:26:30] 7055 R packages including the 'l' letter
-#> DEBUG [2024-07-31 08:26:30] 7039 R packages including the 'm' letter
-#> DEBUG [2024-07-31 08:26:30] 6661 R packages including the 'n' letter
-#> DEBUG [2024-07-31 08:26:30] 7859 R packages including the 'o' letter
-#> DEBUG [2024-07-31 08:26:30] 6579 R packages including the 'p' letter
-#> DEBUG [2024-07-31 08:26:31] 11224 R packages including the 'r' letter
-#> DEBUG [2024-07-31 08:26:31] 10292 R packages including the 's' letter
-#> DEBUG [2024-07-31 08:26:31] 9526 R packages including the 't' letter
+#> DEBUG [2024-08-05 16:05:23] 10194 R packages including the 'a' letter
+#> DEBUG [2024-08-05 16:05:23] 7016 R packages including the 'c' letter
+#> DEBUG [2024-08-05 16:05:23] 5751 R packages including the 'd' letter
+#> DEBUG [2024-08-05 16:05:23] 10908 R packages including the 'e' letter
+#> DEBUG [2024-08-05 16:05:23] 8825 R packages including the 'i' letter
+#> DEBUG [2024-08-05 16:05:23] 7060 R packages including the 'l' letter
+#> DEBUG [2024-08-05 16:05:23] 7045 R packages including the 'm' letter
+#> DEBUG [2024-08-05 16:05:23] 6665 R packages including the 'n' letter
+#> DEBUG [2024-08-05 16:05:23] 7863 R packages including the 'o' letter
+#> DEBUG [2024-08-05 16:05:23] 6582 R packages including the 'p' letter
+#> DEBUG [2024-08-05 16:05:23] 11230 R packages including the 'r' letter
+#> DEBUG [2024-08-05 16:05:23] 10296 R packages including the 's' letter
+#> DEBUG [2024-08-05 16:05:23] 9531 R packages including the 't' letter
 
 log_warn('There might be many, like {1:2} or more warnings!!!')
-#> WARN [2024-07-31 08:26:31] There might be many, like 1 or more warnings!!!
-#> WARN [2024-07-31 08:26:31] There might be many, like 2 or more warnings!!!
+#> WARN [2024-08-05 16:05:23] There might be many, like 1 or more warnings!!!
+#> WARN [2024-08-05 16:05:23] There might be many, like 2 or more warnings!!!
 ```
 
 You can even use a custom log layout to render the log records with
-colors, as you can see in
-`demo(colors, package = 'logger', echo = FALSE)`:
+colors, as you can see in `layout_glue_colors()`:
 
 <img src="man/figures/colors.png" alt="colored log output">
 

_pkgdown.yml

@@ -61,7 +61,6 @@ reference:
 - title: Other helpers
   contents:
   - colorize_by_log_level
-  - grayscale_by_log_level
   - logger
   - delete_logger_index
   - "%except%"