Merge pull request #11 from react-R/add-node_modules-rbuildignore

Scaffolding: Add node_modules to .Rbuildignore, creating it if necessary

Author: timelyportfolio

DESCRIPTION

@@ -38,6 +38,7 @@ Suggests:
     rmarkdown,
     shiny,
     V8,
-    knitr
+    knitr,
+    usethis
 RoxygenNote: 6.1.1
 VignetteBuilder: knitr

R/scaffold.R

@@ -4,19 +4,18 @@
 #' R package.
 #'
 #' @param name Name of widget
-#' @param npmPkg Optional \href{https://npmjs.com/}{NPM} package upon which this
-#'   widget is based, a named list with two elements: \code{name} and
-#'   \href{https://docs.npmjs.com/files/package.json#dependencies}{version}. If
-#'   you specify this parameter the package will be added to the
-#'   \code{dependency} section of the generated \code{package.json}.
+#' @param npmPkgs Optional \href{https://npmjs.com/}{NPM} packages upon which
+#'   this widget is based which will be used to populate \code{package.json}.
+#'   Should be a named list of names to
+#'   \href{https://docs.npmjs.com/files/package.json#dependencies}{versions}.
 #' @param edit Automatically open the widget's JavaScript source file after
 #'   creating the scaffolding.
 #'
 #' @note This function must be executed from the root directory of the package
 #'   you wish to add the widget to.
 #'
 #' @export
-scaffoldReactWidget <- function(name, npmPkg = NULL, edit = interactive()){
+scaffoldReactWidget <- function(name, npmPkgs = NULL, edit = interactive()){
   if (!file.exists('DESCRIPTION')){
     stop(
       "You need to create a package to house your widget first!",
@@ -29,19 +28,26 @@ scaffoldReactWidget <- function(name, npmPkg = NULL, edit = interactive()){
   package <- read.dcf('DESCRIPTION')[[1,"Package"]]
   addWidgetConstructor(name, package, edit)
   addWidgetYAML(name, edit)
-  addPackageJSON(toDepJSON(npmPkg))
+  addPackageJSON(toDepJSON(npmPkgs))
   addWebpackConfig(name)
   addWidgetJS(name, edit)
   addExampleApp(name)
+
+  usethis::use_build_ignore(c("node_modules", "srcjs"))
+  usethis::use_git_ignore(c("node_modules", "srcjs"))
+  lapply(c("htmltools", "htmlwidgets", "reactR"), usethis::use_package)
+
   message("To install dependencies from npm run: yarn install")
   message("To build JavaScript run: yarn run webpack --mode=development")
 }
 
-toDepJSON <- function(npmPkg) {
-  if (is.null(npmPkg)) {
+toDepJSON <- function(npmPkgs) {
+  if (is.null(npmPkgs)) {
     ""
+  } else if (!length(names(npmPkgs))) {
+    stop("Must specify npm package names in the names attributes of npmPkgs")
   } else {
-    sprintf('"%s": "%s"', npmPkg$name, npmPkg$version)
+    paste0(sprintf('"%s": "%s"', names(npmPkgs), npmPkgs), collapse = ",\n")
   }
 }
 
@@ -101,8 +107,8 @@ addWidgetYAML <- function(name, edit){
   if (edit) fileEdit(file_)
 }
 
-addPackageJSON <- function(npmPkg) {
-  tpl <- renderTemplate(slurp('templates/widget_package.json.txt'), list(npmPkg = npmPkg))
+addPackageJSON <- function(npmPkgs) {
+  tpl <- renderTemplate(slurp('templates/widget_package.json.txt'), list(npmPkgs = npmPkgs))
   if (!file.exists('package.json')) {
     cat(tpl, file = 'package.json')
     message('Created package.json')

inst/templates/widget_package.json.txt

@@ -1,7 +1,7 @@
 {
   "private": true,
   "dependencies": {
-    ${npmPkg}
+    ${npmPkgs}
   },
   "devDependencies": {
     "webpack": "^4.27.1",

man/scaffoldReactWidget.Rd

@@ -49,15 +49,15 @@ usethis::create_package("~/sparklines")
 # Inject the widget templating
 withr::with_dir(
   "~/sparklines", 
-  reactR::scaffoldReactWidget("sparklines", list(name = "react-sparklines", version = "^1.7.0"))
+  reactR::scaffoldReactWidget("sparklines", list("react-sparklines" = "^1.7.0"))
 )
 ```
 
 ## Building and installing
 
 ### Building the JavaScript
 
-The next step is to navigate to the newly-created `sparklines` directory in your terminal. Then, run the following commands:
+The next step is to navigate to the newly-created `sparklines` project and run the following R commands:
 
 ```{r}
 system("yarn install")