R/zzz.R

In box.linters: Linters for 'box' Modules

r_version_compatibility <- function() {
  if (as.numeric(R.Version()$major) >= 4 && as.numeric(R.Version()$minor) >= 3.0) {
    namespaced_function_calls()
  } else {
    NULL
  }
}


# nolint start: line_length_linter
#' Rhino default linters
#'
#' See the [Explanation: Rhino style guide](https://appsilon.github.io/rhino/articles/explanation/rhino-style-guide.html)
#' to learn about the details.
#'
#' @examples
#' linters <- lintr::linters_with_defaults(defaults = box.linters::rhino_default_linters)
#'
#' names(linters)
#'
#' @export
# nolint end
rhino_default_linters <- lintr::modify_defaults(
  defaults = lintr::default_linters,
  box_alphabetical_calls_linter = box_alphabetical_calls_linter(),
  box_func_import_count_linter = box_func_import_count_linter(),
  box_mod_fun_exists_linter = box_mod_fun_exists_linter(),
  box_pkg_fun_exists_linter = box_pkg_fun_exists_linter(),
  box_separate_calls_linter = box_separate_calls_linter(),
  box_trailing_commas_linter = box_trailing_commas_linter(),
  box_universal_import_linter = box_universal_import_linter(),
  box_unused_attached_mod_linter = box_unused_attached_mod_linter(),
  box_unused_att_mod_obj_linter = box_unused_att_mod_obj_linter(),
  box_unused_att_pkg_linter = box_unused_attached_pkg_linter(),
  box_unused_attached_pkg_fun_linter = box_unused_att_pkg_fun_linter(),
  box_usage_linter = box_usage_linter(),
  namespaced_function_calls = r_version_compatibility(),
  r6_usage_linter = r6_usage_linter(),
  unused_declared_object_linter = unused_declared_object_linter(),
  object_usage_linter = NULL  # Does not work with `box::use()`
)

#' Box-compatible default linters
#'
#' A replacement for `lintr::object_usage_linter()` that works with `box` modules.
#'
#' @examples
#' linters <- lintr::linters_with_defaults(defaults = box.linters::box_default_linters)
#'
#' names(linters)
#'
#' @export
box_default_linters <- lintr::modify_defaults(
  defaults = lintr::default_linters,
  box_mod_fun_exists_linter = box_mod_fun_exists_linter(),
  box_pkg_fun_exists_linter = box_pkg_fun_exists_linter(),
  box_unused_attached_mod_linter = box_unused_attached_mod_linter(),
  box_unused_att_mod_obj_linter = box_unused_att_mod_obj_linter(),
  box_unused_att_pkg_linter = box_unused_attached_pkg_linter(),
  box_unused_attached_pkg_fun_linter = box_unused_att_pkg_fun_linter(),
  box_usage_linter = box_usage_linter(),
  namespaced_function_calls = r_version_compatibility(),
  r6_usage_linter = r6_usage_linter(),
  unused_declared_object_linter = unused_declared_object_linter(),
  object_usage_linter = NULL  # Does not work with `box::use()`
)