R/build.R

In ATFutures/geoplumber: Geospatial applications with R and frontend libraries

#' Build npm packages
#'
#' This function must be called to build
#' React build for online front-end.
#'
#' Runs npm run build. This creates an optimized, production and minified JS front end
#' which is ready to be deployed anywhere.
#'
#' @section TODO: this function will be used less and less during development.
#' For now geoplumber does not have a development function. Once this becomes available,
#' the two functions will work together but do totally different tasks.
#'
#' @param clean clean build TODO
#'
#' @export
gp_build <- function(clean = FALSE) {
  if (!gp_npm_exists()) {
    msg <- paste0 ("geoplumber failed to identify a version of node ",
                   "on this system:\n", Sys.info()["sysname"], "\n",
                   gp_install_node_instructions())
    stop (msg)
  }

  if (!(file.exists ("package.json") | file.exists (tempfile_name ())))
    stop("geoplumber failed to identify a package.json in working directory:\n",
         getwd(), "\nEither change to directory of previously-created ",
         "geoplumger app,\nor run gp_create() to create one.")

  wd <- getwd()
  if(!gp_is_wd_geoplumber()) {
    # try finding the newly created geoplumber app directory
    wd <- change_to_proj_dir ()
  }

  # TODO: do more checks before actually running the command
  second.build <- 1L
  first.build <- try({
    message("Running: ", "npm run build")
    result <- system("npm run build", ignore.stderr = TRUE)
    result
  })
  if(first.build != 0) {
    # run gp_build()
    message("Looks like first run, installing npm packages...")
    message("Running: ", "gp_npm_install()")
    system("npm install")
    # back on to build
    message("Now trying to build: ", "npm run build")
    second.build <- system("npm run build") # we wont filter ignore.stdout or ignore.stderr
  }
  # in both cases.
  if(second.build == 0)
    message("Standard output from create-react-app above works.\n",
          "To run the geoplumber app: gp_plumb()\n")
  setwd (wd)
}

#' Function to clean the front end build for some reason.
#'
#' Three options: clean, cleand and reinstall and rebuild
#' which cleans, reinstall and rebuilds.
#'
#' @param background run command in the background,
#' defaults to `FALSE` just to keep user aware.
#' @param rebuild whether to rebuild the front, defaults to `FALSE`
#' @param reinstall should it just clean node_modules & reinstall them,
#' defaults to `TRUE`
#'
#' @examples
#' \dontrun{
#' gp_clean()
#' }
gp_clean <- function(background = FALSE,
                     rebuild = FALSE, reinstall = TRUE) {
  stop_ifnot_geoplumber()
  message("clear install and buil...")
  command <- "rm -rf node_modules"
  if(reinstall)
    command <- "npm run clean && npm install"
  if(rebuild)
    command <- "npm run clean && npm install && npm run build"
  if(background)
    command <- paste0(command, " &")
  message("Running: ", command)
  system(command = command)
}