use @Keywords internal for unexported functions

Author: lorenzwalthert

R/addins.R

@@ -18,6 +18,7 @@ NULL
 
 #' @describeIn styler_addins Styles the active file with [tidyverse_style()] and
 #'   `strict = TRUE`.
+#' @keywords internal
 style_active_file <- function() {
   transformer <- make_transformer(tidyverse_style())
   context <- get_rstudio_context()
@@ -46,6 +47,7 @@ style_active_file <- function() {
 #' @param context The context from `styler:::get_rstudio_context()`.
 #' @param transformer A transformer function most conveniently constructed with
 #'   [make_transformer()].
+#' @keywords internal
 try_transform_as_r_file <- function(context, transformer) {
   tryCatch(
     transformer(context$contents),
@@ -62,6 +64,7 @@ try_transform_as_r_file <- function(context, transformer) {
 
 #' @describeIn styler_addins Styles the highlighted selection in a `.R` or
 #'   `.Rmd` file.
+#' @keywords internal
 style_selection <- function() {
   context <- get_rstudio_context()
   text <- context$selection[[1]]$text

R/communicate.R

@@ -5,6 +5,7 @@
 #' @param changed Boolean with indicating for each file whether or not it has
 #'   been changed.
 #' @inheritParams can_verify_roundtrip
+#' @keywords internal
 communicate_warning <- function(changed, transformers) {
   if (any(changed, na.rm = TRUE) && !can_verify_roundtrip(transformers)) {
     cat("Please review the changes carefully!")
@@ -16,6 +17,7 @@ communicate_warning <- function(changed, transformers) {
 #' @param changed Boolean with indicating for each file whether or not it has
 #'   been changed.
 #' @param ruler_width Integer used to determine the width of the ruler.
+#' @keywords internal
 communicate_summary <- function(changed, ruler_width) {
   cli::cat_rule(width = max(40, ruler_width))
   cat("Status\tCount\tLegend \n")

R/expr-is.R

@@ -2,10 +2,12 @@
 #'
 #' @param pd A parse table.
 #' @name pd_is
+#' @keywords internal
 NULL
 
 #' @describeIn pd_is Checks whether `pd` contains an expression wrapped in
 #'   curly brackets.
+#' @keywords internal
 is_curly_expr <- function(pd) {
   if (is.null(pd)) return(FALSE)
   pd$token[1] == "'{'"
@@ -17,13 +19,15 @@ is_subset_expr <- function(pd) {
 }
 
 #' @describeIn pd_is Checks whether `pd` is a function call.
+#' @keywords internal
 is_function_call <- function(pd) {
   if (is.null(pd)) return(FALSE)
   if (is.na(pd$token_before[2])) return(FALSE)
   pd$token_before[2] == "SYMBOL_FUNCTION_CALL"
 }
 
 #' @describeIn pd_is Checks whether `pd` is a function declaration.
+#' @keywords internal
 is_function_dec <- function(pd) {
   if (is.null(pd)) return(FALSE)
   pd$token[1] == "FUNCTION"
@@ -42,6 +46,7 @@ is_comment <- function(pd) {
 #' @param pd A parse table.
 #' @examples
 #' style_text("#!/usr/bin/env Rscript")
+#' @keywords internal
 is_shebang <- function(pd) {
   is_first_comment <- is_comment(pd) & (pd$pos_id == 1L)
   is_first_comment[is_first_comment] <- grepl(
@@ -61,6 +66,7 @@ is_shebang <- function(pd) {
 #'   "call(3, 2, c(3:2))"
 #'   ))
 #' @param pd A parse table.
+#' @keywords internal
 is_code_chunk_header <- function(pd) {
   is_comment <- is_comment(pd)
   is_comment[is_comment] <- grepl(
@@ -80,6 +86,7 @@ contains_else_expr <- function(pd) {
 #' else-if will be visited separately with the visitor. This applies to all
 #' conditional statements with more than one alternative.
 #' @param pd A parse table
+#' @keywords internal
 contains_else_expr_that_needs_braces <- function(pd) {
   else_idx <- which(pd$token == "ELSE")
   if (length(else_idx) > 0) {

R/indent.R

@@ -5,10 +5,12 @@
 #' @param indent_by How many spaces should be added after the token of interest.
 #' @param token The token the indention should be based on.
 #' @name update_indention
+#' @keywords internal
 NULL
 
 #' @describeIn update_indention Inserts indention based on round, square and
 #'   curly brackets.
+#' @keywords internal
 indent_braces <- function(pd, indent_by) {
   indent_indices <- compute_indent_indices(
     pd,
@@ -21,6 +23,7 @@ indent_braces <- function(pd, indent_by) {
 
 #' @describeIn update_indention Indents *all* tokens after `token` - including
 #'   the last token.
+#' @keywords internal
 indent_op <- function(pd,
                       indent_by,
                       token = c(
@@ -41,6 +44,7 @@ indent_op <- function(pd,
 #' Necessary for consistent indention of the function declaration header.
 #' @param pd A parse table.
 #' @seealso set_unindention_child update_indention_ref_fun_dec
+#' @keywords internal
 unindent_fun_dec <- function(pd) {
   if (is_function_dec(pd)) {
     idx_closing_brace <- which(pd$token %in% "')'")
@@ -55,6 +59,7 @@ unindent_fun_dec <- function(pd) {
 #'   table are necessarily indented, as `EQ_SUB` and `EQ_FORMALS` can occur
 #'   multiple times in a parse table.
 #'   occurs is not indented (see[compute_indent_indices()])
+#' @keywords internal
 indent_eq_sub <- function(pd,
                           indent_by,
                           token = c("EQ_SUB", "EQ_FORMALS")) {
@@ -69,6 +74,7 @@ indent_eq_sub <- function(pd,
 
 #' @describeIn update_indention Same as indent_op, but only indents one token
 #'   after `token`, not all remaining.
+#' @keywords internal
 indent_assign <- function(pd, indent_by, token = NULL) {
   indent_indices <- compute_indent_indices(pd, token)
   pd$indent[indent_indices] <- pd$indent[indent_indices] + indent_by
@@ -77,6 +83,7 @@ indent_assign <- function(pd, indent_by, token = NULL) {
 
 #' @describeIn update_indention Is used to indent for / while / if / if-else
 #'   statements that do not have curly parenthesis.
+#' @keywords internal
 indent_without_paren <- function(pd, indent_by = 2) {
   pd %>%
     indent_without_paren_for_while_fun(indent_by) %>%
@@ -85,6 +92,7 @@ indent_without_paren <- function(pd, indent_by = 2) {
 
 #' @describeIn update_indention Is used to indent for and statements and function
 #'   definitions without parenthesis.
+#' @keywords internal
 indent_without_paren_for_while_fun <- function(pd, indent_by) {
   nrow <- nrow(pd)
   if (!(pd$token[1] %in% c("FOR", "WHILE", "FUNCTION"))) return(pd)
@@ -95,6 +103,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 == "')'")[1])
   has_if_without_curly <-
@@ -138,6 +147,7 @@ indent_without_paren_if_else <- function(pd, indent_by) {
 #' everything between '(' and the penultimate token would result in the wrong
 #' formatting.
 #' @importFrom rlang seq2
+#' @keywords internal
 compute_indent_indices <- function(pd,
                                    token_opening,
                                    token_closing = NULL) {
@@ -166,6 +176,7 @@ compute_indent_indices <- function(pd,
 #' @param potential_triggers_pos A vector with indices of the potential trigger
 #'   tokens in `pd`.
 #' @inheritParams needs_indention_one
+#' @keywords internal
 needs_indention <- function(pd,
                             potential_triggers_pos,
                             other_trigger_tokens = NULL) {
@@ -191,6 +202,7 @@ needs_indention <- function(pd,
 #'   if on the same line as the token corresponding to `potential_trigger`.
 #' @return `TRUE` if indention is needed, `FALSE` otherwise.
 #' @importFrom rlang seq2
+#' @keywords internal
 needs_indention_one <- function(pd,
                                 potential_trigger_pos,
                                 other_trigger_tokens) {
@@ -222,6 +234,7 @@ needs_indention_one <- function(pd,
 #' 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 <- map_lgl(pd$child, pd_is_multi_line)
   pd
@@ -234,6 +247,7 @@ set_multi_line <- function(pd) {
 #' * it contains a line break.
 #' * it has at least one child that is a multi-line expression itself.
 #' @param pd A parse table.
+#' @keywords internal
 pd_is_multi_line <- function(pd) {
   any(pd$multi_line, pd$lag_newlines > 0)
 }
@@ -250,6 +264,7 @@ pd_is_multi_line <- function(pd) {
 #' @param pd A parse table.
 #' @return A parse table with synchronized `lag_newlines` and `newlines` columns.
 #' @seealso choose_indention
+#' @keywords internal
 update_newlines <- function(pd) {
   npd <- nrow(pd) - 1
   pd$newlines[seq_len(npd)] <- pd$lag_newlines[seq_len(npd) + 1]

R/initialize.R

@@ -9,6 +9,7 @@
 #' pd <- styler:::compute_parse_data_nested(string_to_format)
 #' styler:::pre_visit(pd, c(default_style_guide_attributes))
 #' @export
+#' @keywords internal
 default_style_guide_attributes <- function(pd_flat) {
   init_pd <-
     initialize_newlines(pd_flat) %>%
@@ -25,9 +26,11 @@ default_style_guide_attributes <- function(pd_flat) {
 #'
 #' @name initialize_attributes
 #' @inheritParams default_style_guide_attributes
+#' @keywords internal
 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, 1))
   pd_flat$newlines <- pd_flat$line3 - pd_flat$line2
@@ -37,6 +40,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, 1) + 1L)
   pd_flat$col2_nl <- if_else(pd_flat$newlines > 0L,
@@ -54,6 +58,7 @@ remove_attributes <- function(pd_flat, attributes) {
 }
 
 #' @describeIn initialize_attributes Initializes `multi_line`.
+#' @keywords internal
 initialize_multi_line <- function(pd_flat) {
   nrow <- nrow(pd_flat)
   pd_flat$multi_line <- if_else(pd_flat$terminal,
@@ -64,12 +69,14 @@ initialize_multi_line <- function(pd_flat) {
 }
 
 #' @describeIn initialize_attributes Initializes `indention_ref_ind`.
+#' @keywords internal
 initialize_indention_ref_pos_id <- function(pd_flat) {
   pd_flat$indention_ref_pos_id <- NA
   pd_flat
 }
 
 #' @describeIn initialize_attributes Initializes `indent`.
+#' @keywords internal
 initialize_indent <- function(pd_flat) {
   if (!("indent" %in% names(pd_flat))) {
     pd_flat$indent <- 0
@@ -78,6 +85,7 @@ initialize_indent <- function(pd_flat) {
 }
 
 #' @describeIn initialize_attributes validates the parse data.
+#' @keywords internal
 validate_parse_data <- function(pd_flat) {
   if (any(pd_flat$spaces < 0L)) {
     stop("Invalid parse data")

R/nest.R

@@ -6,6 +6,7 @@
 #' @return A nested parse table. See [tokenize()] for details on the columns
 #'   of the parse table.
 #' @importFrom purrr when
+#' @keywords internal
 compute_parse_data_nested <- function(text) {
   parse_data <- tokenize(text) %>%
     add_terminal_token_before() %>%
@@ -25,6 +26,7 @@ compute_parse_data_nested <- function(text) {
 #' Map text corresponding to the token "SPECIAL" to a (more) unique token
 #' description.
 #' @param pd A parse table.
+#' @keywords internal
 enhance_mapping_special <- function(pd) {
   pipes <- pd$token == "SPECIAL" & pd$text == "%>%"
   pd$token[pipes] <- special_and("PIPE")
@@ -46,9 +48,11 @@ special_and <- function(text) {
 #'
 #' @param pd_flat A flat parse table.
 #' @name add_token_terminal
+#' @keywords internal
 NULL
 
 #' @rdname add_token_terminal
+#' @keywords internal
 add_terminal_token_after <- function(pd_flat) {
   terminals <- pd_flat %>%
     filter(terminal) %>%
@@ -59,6 +63,7 @@ add_terminal_token_after <- function(pd_flat) {
 }
 
 #' @rdname add_token_terminal
+#' @keywords internal
 add_terminal_token_before <- function(pd_flat) {
   terminals <- pd_flat %>%
     filter(terminal) %>%
@@ -74,6 +79,7 @@ add_terminal_token_before <- function(pd_flat) {
 #' @describeIn add_token_terminal Removes column `terimnal_token_before`. Might
 #'   be used to prevent the use of invalidated information, e.g. if tokens were
 #'   added to the nested parse table.
+#' @keywords internal
 remove_terminal_token_before_and_after <- function(pd_flat) {
   pd_flat$token_before <- NULL
   pd_flat$token_after <- NULL
@@ -89,6 +95,7 @@ remove_terminal_token_before_and_after <- function(pd_flat) {
 #' @return An integer vector of length spaces_after_prefix, which is either
 #'   one (if `force_one = TRUE`) or `space_after_prefix` with all values
 #'   below one set to one.
+#' @keywords internal
 set_spaces <- function(spaces_after_prefix, force_one) {
   if (force_one) {
     n_of_spaces <- rep(1, length(spaces_after_prefix))
@@ -110,6 +117,7 @@ set_spaces <- function(spaces_after_prefix, force_one) {
 #' @seealso [compute_parse_data_nested()]
 #' @return A nested parse table.
 #' @importFrom purrr map2
+#' @keywords internal
 nest_parse_data <- function(pd_flat) {
   if (all(pd_flat$parent <= 0)) return(pd_flat)
   pd_flat$internal <- with(pd_flat, (id %in% parent) | (parent <= 0))
@@ -141,6 +149,7 @@ nest_parse_data <- function(pd_flat) {
 #' @details Essentially, this is a wrapper around [dplyr::bind_rows()], but
 #'   returns `NULL` if the result of [dplyr::bind_rows()] is a data frame with
 #'   zero rows.
+#' @keywords internal
 combine_children <- function(child, internal_child) {
   bound <- bind_rows(child, internal_child)
   if (nrow(bound) == 0) return(NULL)
@@ -152,6 +161,7 @@ combine_children <- function(child, internal_child) {
 #' On what line does the first token occur?
 #' @param pd_nested A nested parse table.
 #' @return The line number on which the first token occurs.
+#' @keywords internal
 find_start_line <- function(pd_nested) {
   pd_nested$line1[1]
 }

R/nested_to_tree.R

@@ -5,6 +5,7 @@
 #' @inheritParams create_node_from_nested_root
 #' @return A data frame.
 #' @importFrom purrr when
+#' @keywords internal
 create_tree <- function(text, structure_only = FALSE) {
   compute_parse_data_nested(text) %>%
     pre_visit(c(default_style_guide_attributes)) %>%
@@ -28,6 +29,7 @@ create_tree <- function(text, structure_only = FALSE) {
 #' initialized <- styler:::pre_visit(nested_pd, c(default_style_guide_attributes))
 #' styler:::create_node_from_nested_root(initialized, structure_only = FALSE)
 #' }
+#' @keywords internal
 create_node_from_nested_root <- function(pd_nested, structure_only) {
   if (getRversion() < 3.2) stop_insufficient_r_version()
   n <- data.tree::Node$new(ifelse(
@@ -42,6 +44,7 @@ create_node_from_nested_root <- function(pd_nested, structure_only) {
 #' @inheritParams create_node_from_nested_root
 #' @param parent The parent of the node to be created.
 #' @importFrom purrr map2 map
+#' @keywords internal
 create_node_from_nested <- function(pd_nested, parent, structure_only) {
   if (is.null(pd_nested)) {
     return()