Merge pull request #1060 from r-lib/single_pkg_namespace

Document imports in a single file

Author: IndrajeetPatil

DESCRIPTION

@@ -53,7 +53,7 @@ Roxygen: list(markdown = TRUE, roclets = c( "rd", "namespace", "collate",
     if (rlang::is_installed("pkgapi")) "pkgapi::api_roclet" else {
     warning("Please install r-lib/pkgapi to make sure the file API is kept
     up to date"); NULL}))
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.2
 Config/testthat/edition: 3
 Config/testthat/parallel: true
 Collate: 
@@ -85,7 +85,7 @@ Collate:
     'serialize.R'
     'set-assert-args.R'
     'style-guides.R'
-    'styler.R'
+    'styler-package.R'
     'stylerignore.R'
     'testing-mocks.R'
     'testing-public-api.R'

NAMESPACE

@@ -32,9 +32,6 @@ export(tidyverse_math_token_spacing)
 export(tidyverse_reindention)
 export(tidyverse_style)
 importFrom(magrittr,"%>%")
-importFrom(magrittr,or)
-importFrom(magrittr,set_names)
-importFrom(purrr,as_mapper)
 importFrom(purrr,compact)
 importFrom(purrr,flatten)
 importFrom(purrr,flatten_chr)
@@ -52,11 +49,7 @@ importFrom(purrr,pwalk)
 importFrom(purrr,when)
 importFrom(rlang,"%||%")
 importFrom(rlang,abort)
-importFrom(rlang,is_empty)
 importFrom(rlang,is_installed)
 importFrom(rlang,seq2)
+importFrom(rlang,set_names)
 importFrom(rlang,warn)
-importFrom(rlang,with_handlers)
-importFrom(utils,capture.output)
-importFrom(utils,tail)
-importFrom(utils,write.table)

R/addins.R

@@ -45,7 +45,7 @@
 NULL
 
 
-#' @importFrom rlang abort
+
 #' @keywords internal
 style_active_file <- function() {
   communicate_addins_style_transformers()
@@ -118,7 +118,6 @@ save_after_styling_is_active <- function() {
 }
 
 #' Styles the highlighted selection in a `.R` or `.Rmd` file.
-#' @importFrom rlang abort
 #' @keywords internal
 style_selection <- function() {
   communicate_addins_style_transformers()
@@ -148,9 +147,7 @@ get_rstudio_context <- function() {
 }
 
 #' Asks the user to supply a style
-#' @importFrom rlang abort
 #' @keywords internal
-#' @importFrom rlang with_handlers abort
 set_style_transformers <- function() {
   current_style <- get_addins_style_transformer_name()
   new_style <-
@@ -160,7 +157,7 @@ set_style_transformers <- function() {
       current_style
     )
   if (!is.null(new_style)) {
-    parsed_new_style <- with_handlers(
+    parsed_new_style <- rlang::with_handlers(
       {
         transformers <- eval(parse(text = new_style))
         style_text(
@@ -182,7 +179,6 @@ set_style_transformers <- function() {
 }
 
 #' Return the style function or name
-#'
 #' @keywords internal
 get_addins_style_transformer_name <- function() {
   getOption("styler.addins_style_transformer")
@@ -210,10 +206,9 @@ communicate_addins_style_transformers <- function() {
 #' @param context The context from `styler:::get_rstudio_context()`.
 #' @param transformer A transformer function most conveniently constructed with
 #'   [make_transformer()].
-#' @importFrom rlang with_handlers abort
 #' @keywords internal
 try_transform_as_r_file <- function(context, transformer) {
-  with_handlers(
+  rlang::with_handlers(
     transformer(context$contents),
     error = function(e) {
       preamble_for_unsaved <- paste(

R/communicate.R

@@ -40,8 +40,7 @@ communicate_summary <- function(changed, ruler_width) {
   }
 }
 
-#' @importFrom rlang abort
-#' @importFrom rlang is_installed
+
 assert_data.tree_installation <- function() {
   if (!is_installed("data.tree")) {
     abort("The package data.tree needs to be installed for this functionality.")

R/compat-dplyr.R

@@ -10,7 +10,7 @@ lead <- function(x, n = 1L, default = NA) {
   c(x[-seq_len(n)], rep(default, n))
 }
 
-#' @importFrom rlang abort
+
 arrange <- function(.data, ...) {
   ord <- eval(substitute(order(...)), .data, parent.frame())
   .data[ord, , drop = FALSE]
@@ -81,9 +81,8 @@ slice <- function(.data, ...) {
 }
 
 # TODO: Use `purrr::map_dfr()` when it stops implicitly relying on `{dplyr}`
-#' @importFrom purrr as_mapper map
 map_dfr <- function(.x, .f, ..., .id = NULL) {
-  .f <- as_mapper(.f, ...)
+  .f <- purrr::as_mapper(.f, ...)
   res <- map(.x, .f, ...)
   bind_rows(res, .id = .id)
 }

R/detect-alignment-utils.R

@@ -3,7 +3,6 @@
 #' Must be after dropping comments because the closing brace is only guaranteed
 #' to be the last token in that case.
 #' @inheritParams alignment_drop_comments
-#' @importFrom rlang seq2
 #' @keywords internal
 alignment_ensure_no_closing_brace <- function(pd_by_line,
                                               last_line_droped_early) {
@@ -28,7 +27,6 @@ alignment_ensure_no_closing_brace <- function(pd_by_line,
 #' @param pd_by_line A list, each element corresponding to a potentially
 #'   incomplete parse table that represents all token from one line.
 #' @keywords internal
-#' @importFrom purrr map compact
 alignment_drop_comments <- function(pd_by_line) {
   map(pd_by_line, function(x) {
     out <- x[x$token != "COMMENT", ]
@@ -107,7 +105,6 @@ alignment_ensure_trailing_comma <- function(pd_by_line) {
 #' Checks if all arguments of column 1 are named
 #' @param relevant_pd_by_line A list with parse tables of a multi-line call,
 #'   excluding first and last column.
-#' @importFrom purrr map_lgl
 #' @keywords internal
 alignment_col1_all_named <- function(relevant_pd_by_line) {
   map_lgl(relevant_pd_by_line, function(x) {
@@ -124,15 +121,13 @@ alignment_col1_all_named <- function(relevant_pd_by_line) {
 #' Serialize all lines for a given column
 #' @param column The index of the column to serialize.
 #' @inheritParams alignment_col1_all_named
-#' @importFrom purrr map
 #' @keywords internal
 alignment_serialize_column <- function(relevant_pd_by_line, column) {
   map(relevant_pd_by_line, alignment_serialize_line, column = column)
 }
 
 #' Serialize one line for a column
 #'
-#'
 #' @inheritParams alignment_serialize_column
 #' @inheritParams alignment_col1_all_named
 #' @keywords internal
@@ -147,7 +142,7 @@ alignment_serialize_line <- function(relevant_pd_by_line, column) {
     # line does not have values at that column
     return(NULL)
   }
-  between_commas <- seq2(max(1, comma_idx[column - 1L]), comma_idx[column])
+  between_commas <- seq2(max(1L, comma_idx[column - 1L]), comma_idx[column])
   relevant_pd_by_line <- relevant_pd_by_line[between_commas, ]
   alignment_serialize(relevant_pd_by_line)
 }
@@ -178,7 +173,7 @@ alignment_serialize <- function(pd_sub) {
 #' At least one space after comma, none before, for all but the last comma on
 #' the line
 #' @param pd_sub The subset of a parse table corresponding to one line.
-#' @importFrom rlang seq2
+#'
 #' @keywords internal
 alignment_has_correct_spacing_around_comma <- function(pd_sub) {
   comma_tokens <- which(pd_sub$token == "','")
@@ -196,14 +191,13 @@ alignment_has_correct_spacing_around_comma <- function(pd_sub) {
 #' At least one space around `EQ_SUB`
 #' @inheritParams alignment_has_correct_spacing_around_comma
 #' @keywords internal
-#' @importFrom rlang seq2
 alignment_has_correct_spacing_around_eq_sub <- function(pd_sub) {
   relevant_eq_sub_token <- which(pd_sub$token == "EQ_SUB")
   if (length(relevant_eq_sub_token) == 0L) {
     return(TRUE)
   }
 
-  correct_spaces_before <- pd_sub$.lag_spaces[relevant_eq_sub_token] >= 1
-  correct_spaces_after <- pd_sub$spaces[relevant_eq_sub_token] >= 1
+  correct_spaces_before <- pd_sub$.lag_spaces[relevant_eq_sub_token] >= 1L
+  correct_spaces_after <- pd_sub$spaces[relevant_eq_sub_token] >= 1L
   all(correct_spaces_before) && all(correct_spaces_after)
 }

R/detect-alignment.R

@@ -22,8 +22,6 @@
 #' * For the recursive creation of text, greedily check column by column to make
 #'   sure we can stop as soon as we found that columns are not aligned.
 #'
-#' @importFrom purrr map_int map_lgl map compact
-#' @importFrom rlang seq2
 #' @keywords internal
 #' @examples
 #' library("magrittr")

R/indent.R

@@ -29,7 +29,7 @@ indent_without_paren_for_while_fun <- function(pd, indent_by) {
 }
 
 #' @describeIn update_indention Is used to indent if and if-else statements.
-#' @importFrom rlang seq2
+#'
 #' @keywords internal
 indent_without_paren_if_else <- function(pd, indent_by) {
   expr_after_if <- next_non_comment(pd, which(pd$token == "')'")[1L])
@@ -91,7 +91,7 @@ indent_without_paren_if_else <- function(pd, indent_by) {
 #' Since text `[[` has token `"LBB"` and text `]]` is parsed as two independent
 #' `]` (see 'Examples'), indention has to stop at the first `]`.
 # one token earlier
-#' @importFrom rlang seq2
+#'
 #' @keywords internal
 #' @examples
 #' styler:::parse_text("a[1]")
@@ -161,7 +161,7 @@ needs_indention <- function(pd,
 #'   if on the same line as the token corresponding to `potential_trigger` and
 #'   directly followed by a line break.
 #' @return `TRUE` if indention is needed, `FALSE` otherwise.
-#' @importFrom rlang seq2
+#'
 #' @keywords internal
 #' @examples
 #' style_text(c(
@@ -206,7 +206,6 @@ needs_indention_one <- function(pd,
 #' Sets the column `multi_line` in `pd` by checking row-wise whether any child
 #' of a token is a multi-line token.
 #' @param pd A parse table.
-#' @importFrom purrr map_lgl
 #' @keywords internal
 set_multi_line <- function(pd) {
   pd$multi_line <- unname(map_int(pd$child, pd_multi_line))

R/initialize.R

@@ -3,7 +3,6 @@
 #' This function initializes and removes various variables from the parse
 #' table.
 #' @param pd_flat A parse table.
-#' @importFrom utils tail
 #' @examples
 #' withr::with_options(
 #'   list(styler.cache_name = NULL), # temporarily deactivate cache
@@ -37,7 +36,7 @@ NULL
 #' @describeIn initialize_attributes Initializes `newlines` and `lag_newlines`.
 #' @keywords internal
 initialize_newlines <- function(pd_flat) {
-  pd_flat$line3 <- lead(pd_flat$line1, default = tail(pd_flat$line2, 1L))
+  pd_flat$line3 <- lead(pd_flat$line1, default = utils::tail(pd_flat$line2, 1L))
   pd_flat$newlines <- pd_flat$line3 - pd_flat$line2
   pd_flat$lag_newlines <- lag(pd_flat$newlines, default = 0L)
   pd_flat$line3 <- NULL
@@ -47,7 +46,7 @@ initialize_newlines <- function(pd_flat) {
 #' @describeIn initialize_attributes Initializes `spaces`.
 #' @keywords internal
 initialize_spaces <- function(pd_flat) {
-  pd_flat$col3 <- lead(pd_flat$col1, default = tail(pd_flat$col2, 1L) + 1L)
+  pd_flat$col3 <- lead(pd_flat$col1, default = utils::tail(pd_flat$col2, 1L) + 1L)
   pd_flat$col2_nl <- ifelse(pd_flat$newlines > 0L,
     rep(0L, nrow(pd_flat)), pd_flat$col2
   )
@@ -88,7 +87,7 @@ initialize_indent <- function(pd_flat) {
   pd_flat
 }
 
-#' @importFrom rlang abort
+
 #' @describeIn initialize_attributes validates the parse data.
 #' @keywords internal
 validate_parse_data <- function(pd_flat) {

R/io.R

@@ -1,8 +1,6 @@
 #' Apply a function to the contents of a file
 #'
 #' Transforms a file with a function.
-#' @importFrom magrittr set_names
-#' @importFrom rlang abort
 #' @inheritParams transform_utf8_one
 #' @keywords internal
 transform_utf8 <- function(path, fun, dry) {
@@ -19,11 +17,10 @@ transform_utf8 <- function(path, fun, dry) {
 #'   latter returns an error if the input code is not identical to the result
 #'   of styling. "off", the default, writes back if the input and output of
 #'   styling are not identical.
-#' @importFrom rlang with_handlers warn
 #' @keywords internal
 transform_utf8_one <- function(path, fun, dry) {
   rlang::arg_match(dry, c("on", "off", "fail"))
-  with_handlers(
+  rlang::with_handlers(
     {
       file_with_info <- read_utf8(path)
       # only write back when changed OR when there was a missing newline