basic code template for styling roxygen code examples

Author: lorenzwalthert

DESCRIPTION

@@ -55,6 +55,7 @@ Collate:
     'serialize.R'
     'set-assert-args.R'
     'style-guides.R'
+    'style-roxgen-examples.R'
     'styler.R'
     'testing.R'
     'token-create.R'

R/style-roxgen-examples.R

@@ -0,0 +1,66 @@
+#' Figure out where code examples start and stop
+#'
+#' Finds the start and stop indices of the lines in `text` that are
+#' code examples in roxygen comments.
+#' @param text
+identify_start_and_stop_of_royxgen_examples_from_text <- function(text) {
+  starts <- identify_start_points(text)
+  stop_candidates <- identify_stop_candidates(text)
+  stops <- map_int(starts, match_stop_to_start,
+    stop_candidates = stop_candidates
+  )
+  NULL
+}
+
+identify_start_stop_of_royxgen_examples_from_paths <- function(path) {
+  content <- enc::read_lines_enc(path) # ensure file can be read
+  identify_start_stop_of_royxgen_examples_from_text(content)
+  list(
+    c(5, 9),
+    c(18, 39)
+  )
+}
+
+match_stop_to_start <- function(start, stop_candidates) {
+  NULL
+}
+
+#' TODO:
+#' * move to R/ui.R
+#' * same arguments as other stylers
+#' * add include_roxygen_code_examples argument to style_pkg() et al.
+#' * export
+style_roxygen_code_examples <- function(path) {
+  map(path, style_roxygen_code_examples_one)
+}
+
+style_roxygen_code_examples_one <- function(path) {
+  full_file_content <- enc::read_lines_enc(path)
+  start_stop_sequences <- identify_start_and_stop_of_royxgen_examples_from_paths(
+    full_file_content
+  ) %>%
+    start_stop_pairs_to_sequences()
+
+  masked_examples <- extract_selected_lines_from_text(
+    full_file_content, start_stop_sequences
+  )
+
+  plain_examples <- map(start_stop_paris, remove_roxygen_mask,
+    text = masked_examples
+  )
+  styled_examples <- map(plain_examples, style_text, ...)
+  masked_examples <- map(styled_examples, add_roxygen_mask)
+  full_file_content <- update_selected_lines_of_text(
+    full_file_content, masked_examples, start_stop_sequences
+  )
+  enc::write_lines_enc(path, full_file_content)
+}
+
+
+remove_roxygen_mask <- function() {
+  NULL
+}
+
+add_roxygen_mask <- function() {
+  NULL
+}

R/utils.R

@@ -92,3 +92,16 @@ extend_if_comment <- function(pd, pos) {
 map_filetype_to_pattern <- function(filetype) {
   paste0("(", paste(set_and_assert_arg_filetype(filetype), collapse = "|"), ")$")
 }
+
+
+extract_selected_lines_from_text <- function() {
+  NULL
+}
+
+update_selected_lines_of_text <- function() {
+  NULL
+}
+
+start_stop_pairs_to_sequences <- function() {
+  NULL
+}