Housekeeping

No user-facing changes

Author: ElianHugh

R/config.R

@@ -1,5 +1,5 @@
-# handle all config here to pass to engine
-# including defaults, config files, etc
+# Handle all hotwater config here to pass to engine (see engine.R)
+# Includes defaults, config files, etc
 
 new_config <- function(...) {
     dots <- list(...)

R/mirai.R

@@ -45,12 +45,17 @@ new_runner <- function(engine) {
     i <- 0L
     timeout <- 1000L
 
-    while (i < timeout && is_runner_alive(engine) && !is_plumber_running(engine)) {
+    repeat {
         i <- i + 1L
         try(
             cli::cli_progress_update(.envir = parent.frame(n = 1L)),
             silent = TRUE
         )
+
+        if (i >= timeout || !is_runner_alive(engine) || is_plumber_running(engine)) {
+            break
+        }
+
         Sys.sleep(0.1)
     }
 

R/run.R

@@ -20,24 +20,23 @@
 #'
 #' @param path path to plumber API file.
 #'
-#' @param dirs (optional) a character vector of extra directories
+#' @param dirs **(optional)** a character vector of extra directories
 #' to watch for file changes. Paths are resolved from the current working
 #' directory, not the directory of the plumber API file.
 #'
-#' @param port \[default [httpuv::randomPort()]] port to launch API on.
+#' @param port port to launch API on.
 #'
-#' port can either be set explicitly, or it defaults to the
-#' `plumber.port` option. If the plumber option is undefined, the fallback
-#' value of [httpuv::randomPort()] is used.
+#' If NULL, defaults to the `plumber.port` option.
+#' If the plumber option is undefined, the fallback value of [httpuv::randomPort()] is used.
 #'
-#' @param host \[default "127.0.0.1"] host to launch API on.
+#' @param host host to launch API on.
 #'
-#' host can either be set explicitly, or it defaults to the
-#' `plumber.host` option. If the plumber option is undefined, the fallback
-#' value of "127.0.0.1" is used.
+#' If NULL, defaults to the `plumber.host` option.
+#' If the plumber option is undefined, the fallback value of "127.0.0.1" is used.
 #'
-#' @param ignore \[default `c("*.sqlite", "*.git*")`] vector of file globs
-#' to ignore.
+#' @param ignore vector of file globs to ignore.
+#'
+#' If NULL, defaults to `c("*.sqlite", "*.git")`
 #'
 #' @seealso [plumber::options_plumber],
 #' [plumber::get_option_or_env], [plumber::serializer_html]

README.md

@@ -11,9 +11,12 @@
 
 <!-- badges: end -->
 
+> [!NOTE]
+> This package is under active development and its functionality may change over time.
+
 - autoreload for plumber
 - auto-refresh the browser when a change is made
-- run from the commandline with the `/exec/hotwater` bash script
+- run hotwater from the commandline via included bash script
 
 ## Installation
 

TODO.md

@@ -18,5 +18,4 @@
 
 ## 5
 
-- An error doesn't always cause hotwater to attempt to restart. Should it? An error can indicate that the API has to be changed
-before trying again
+- An error doesn't always cause hotwater to attempt to restart. Should it? An error can indicate that the API has to be changed before trying again

man/hotwater-package.Rd

@@ -1,4 +1,4 @@
-test_that("startup/teardown messages don't error", {
+test_that("startup & teardown messages don't error", {
     engine <- new_test_engine()
     expect_no_error(suppressMessages(buildup_engine(engine)))
     expect_no_error(suppressMessages(teardown_engine(engine)))

man/run.Rd

@@ -1,4 +1,4 @@
-test_that("hotwater install/uninstall works", {
+test_that("hotwater install & uninstall works", {
     skip_on_os("windows")
     local({
         hw_install_folder <- withr::local_tempdir("install_path")

tests/testthat/test-cli.R

@@ -39,7 +39,7 @@ test_that("file watcher works", {
     changes <- get_changed_files(directory_state_old(), directory_state_new())
     expect_true(did_files_change(changes))
     expect_identical(
-        sort(c("./R/run.R", "./R/deleted.R", "./R/new.R")),
+        sort(c("./R/run.R", "./R/deleted.R", "./R/new.R")), # nolint: nonportable_path_linter.
         sort(changes)
     )
 })