Add text_parse() utility

NAMESPACE

@@ -86,6 +86,7 @@ export(range_end_byte)
 export(range_end_point)
 export(range_start_byte)
 export(range_start_point)
+export(text_parse)
 export(tree_included_ranges)
 export(tree_language)
 export(tree_root_node)

R/parse.R

@@ -1,3 +1,27 @@
+#' Parse a snippet of text
+#'
+#' @description
+#' `text_parse()` is a convenience utility for quickly parsing a small snippet
+#' of text using a particular language and getting access to its root node. It
+#' is meant for demonstration purposes. If you are going to need to reparse the
+#' text after an edit has been made, you should create a full parser with
+#' [parser()] and use [parser_parse()] instead.
+#'
+#' @param x `[string]`
+#'
+#'   The text to parse.
+#'
+#' @param language `[tree_sitter_language]`
+#'
+#'   The language to parse with.
+#'
+#' @export
+#' @examplesIf rlang::is_installed("treesitter.r")
+#' language <- treesitter.r::language()
+#' text <- "map(xs, function(x) 1 + 1)"
+#'
+#' # Note that this directly returns the root node, not the tree
+#' text_parse(text, language)
 text_parse <- function(x, language) {
   check_string(x)
   check_language(language)