R/options.R

In styler: Non-Invasive Pretty Printing of R Code

#' Package options
#'
#' These options can be set via [options()] and queried via [getOption()].
#' For this, add a `styler.` prefix (the package name and a dot) to the option name.
#' Example: for an option `foo`, use `options(styler.foo = value)` to set it
#' and `getOption("styler.foo")` to retrieve the current value.
#' An option value of `NULL` means that the default is used.
#'
#' @usage NULL
#' @format NULL
#'
#' @name styler_options
#'
#' @examplesIf FALSE
#' getOption("styler.ignore_alignment")
#' options(
#'   styler.ignore_alignment = TRUE,
#'   styler.quiet = TRUE
#' )
#' getOption("styler.ignore_alignment")
#'
#' @section Options for the styler package:
#'
#' - `styler.addins_style_transformer`: character.
#'   The name of the style transformer to use in the addins.
#'   (default: `"styler::tidyverse_style()"`)
#'
#' - `styler.cache_name`: character.
#'   The name of the styler cache to use.
#'   (default: `r unlist(unname(read.dcf("DESCRIPTION")[, "Version"]), use.names = FALSE)`)
#'
#' - `styler.cache_root`: character.
#'   The directory where the cache files are stored. For more, see `help("caching")`.
#'   (default: `NULL`)
#'
#' - `styler.colored_print.vertical`: logical.
#'   It decides whether or not the output should be colored with `prettycode::highlight()`.
#'   (default: `TRUE`)
#'
#' - `styler.ignore_alignment`: logical.
#'   If `TRUE`, alignment, when detected, is ignored. For more, see `vignette("detect-alignment")`.
#'   (default: `FALSE`)
#'
#' - `styler.ignore_start`, `styler.ignore_stop`: character.
#'   Regular expressions to ignore lines that match them. For more, see `help("stylerignore")`.
#'   (default: `"styler: off"` and `"styler: on"`, respectively)
#'
#' - `styler.quiet`: logical.
#'   It decides whether or not to print an informative message about what the function is doing.
#'   If `TRUE`, no output is printed.
#'   (default: `FALSE`)
#'
#' - `styler.test_dir_writable`: logical.
#'   If `TRUE`, the package tests whether the directory is writable.
#'   (default: `TRUE`)
NULL