Rename edit family

Author: hadley

NAMESPACE

@@ -2,11 +2,11 @@
 
 export(create_package)
 export(create_project)
-export(edit_environ_user)
-export(edit_git_config_user)
-export(edit_git_ignore_user)
-export(edit_makevars_user)
-export(edit_profile_user)
+export(edit_git_config)
+export(edit_git_ignore)
+export(edit_r_environ)
+export(edit_r_makevars)
+export(edit_r_profile)
 export(edit_rstudio_snippets)
 export(proj_get)
 export(proj_set)

NEWS.md

@@ -42,11 +42,11 @@ The output from all usethis commands has been reviewed to be informative but not
 
 A new class of functions make it easy to edit common config files:
 
-* `edit_profile_user()` opens `~/.Rprofile`
-* `edit_environ_user()` opens `~/.Renviron`
-* `edit_makevars_user()` opens `~/.R/Makevars`
-* `edit_git_config_user()` opens `~/.gitconfig`
-* `edit_git_ignore_user()` opens `~/.gitignore`
+* `edit_r_profile_user()` opens `.Rprofile`
+* `edit_r_environ_user()` opens `.Renviron`
+* `edit_r_makevars_user()` opens `.R/Makevars`
+* `edit_git_config_user()` opens `.gitconfig`
+* `edit_git_ignore_user()` opens `.gitignore`
 * `edit_rstudio_snippets(type)` opens `~/R/snippets/{type}.snippets`
 
 ## Updates

R/edit.R

@@ -1,51 +1,63 @@
 #' Open useful configuration files
 #'
-#' * `edit_profile_user()` opens `~/.Rprofile`
-#' * `edit_environ_user()` opens `~/.Renviron`
-#' * `edit_makevars_user()` opens `~/.R/Makevars`
-#' * `edit_git_config_user()` opens `~/.gitconfig`
-#' * `edit_git_ignore_user()` opens `~/.gitignore`
+#' * `edit_r_profile()` opens `.Rprofile`
+#' * `edit_r_environ()` opens `.Renviron`
+#' * `edit_r_makevars()` opens `.R/Makevars`
+#' * `edit_git_config()` opens `.gitconfig`
+#' * `edit_git_ignore()` opens `.gitignore`
 #' * `edit_rstudio_snippets(type)` opens `~/R/snippets/{type}.snippets`
 #'
+#' @param scope Edit globally for the current __user__, or locally for the
+#'   current __project__
 #' @name edit
 NULL
 
 #' @export
 #' @rdname edit
-edit_profile_user <- function() {
-  edit_file("~", ".Rprofile")
+edit_r_profile <- function(scope = c("user", "project")) {
+  edit_file(scope_dir(scope), ".Rprofile")
   todo("Restart R for changes to take effect")
   invisible()
 }
 
 #' @export
 #' @rdname edit
-edit_environ_user <- function() {
-  edit_file("~", ".Renviron")
+edit_r_environ <- function(scope = c("user", "project")) {
+  edit_file(scope_dir(scope), ".Renviron")
   todo("Restart R for changes to take effect")
   invisible()
 }
 
 #' @export
 #' @rdname edit
-edit_makevars_user <- function() {
-  create_directory(path.expand("~"), ".R")
-  edit_file("~", ".R/Makevars")
+edit_r_makevars <- function(scope = c("user", "project")) {
+  dir <- scope_dir(scope)
+  create_directory(dir, ".R")
+  edit_file(dir, ".R/Makevars")
   todo("Restart R for changes to take effect")
   invisible()
 }
 
 #' @export
 #' @rdname edit
-edit_git_config_user <- function() {
-  edit_file("~", ".gitconfig")
+edit_git_config <- function(scope = c("user", "project")) {
+  scope <- match.arg(scope)
+  switch(scope,
+    user = edit_file("~", ".gitconfig"),
+    project = edit_file(proj_get(), ".git/config")
+  )
+
   invisible()
 }
 
 #' @export
 #' @rdname edit
-edit_git_ignore_user <- function() {
-  edit_file("~", ".gitignore")
+edit_git_ignore <- function(scope = c("user", "project")) {
+  scope <- match.arg(scope)
+  switch(scope,
+    user = edit_file("~", ".gitignore"),
+    project = edit_file(proj_get(), ".git/ignore")
+  )
   invisible()
 }
 
@@ -57,3 +69,10 @@ edit_rstudio_snippets <- function(type = "R") {
   edit_file("~", paste0(".R/snippets/", tolower(type), ".snippets"))
   invisible()
 }
+
+scope_dir <- function(scope = c("user", "project")) {
+  scope <- match.arg(scope)
+  message("Editing in ", scope, " scope")
+
+  switch(scope, user = path.expand("~"), project = proj_get())
+}

R/use_this.R

@@ -4,7 +4,7 @@
 #'
 #' @export
 use_usethis <- function() {
-  edit_profile_user()
+  edit_r_profile("user")
 
   todo("Include this code to make usethis available in all interactive sessions")
   code_block(