don't allow editing/remove default prompts (closes #59)

R/prompt.R

@@ -108,6 +108,7 @@ prompt_new <- function(role, interface, contents = NULL) {
 #' @rdname prompt
 #' @export
 prompt_remove <- function(role) {
+  check_role(role)
   path <- prompt_locate(role)
   file.remove(path)
 
@@ -121,6 +122,7 @@ prompt_remove <- function(role) {
 #' @rdname prompt
 #' @export
 prompt_edit <- function(role) {
+  check_role(role)
   path <- prompt_locate(role)
   if (interactive()) {
     file.edit(path)

R/utils.R

@@ -42,6 +42,13 @@ check_role <- function(role, call = caller_env()) {
     )
   }
 
+  if (role %in% default_roles & is.null(getOption(".pal_on_load"))) {
+    cli::cli_abort(
+      "Default roles cannot be edited or removed.",
+      call = call
+    )
+  }
+
   invisible(role)
 }
 

R/zzz.R

@@ -2,6 +2,7 @@
 
 .onLoad <- function(libname, pkgname) {
   pal_env <- pal_env()
+  withr::local_options(.pal_on_load = TRUE)
 
   directory_load(system.file("prompts", package = "pal"))
 

tests/testthat/_snaps/prompt.md

@@ -16,14 +16,6 @@
       ! There's already a pal with role "boop".
       i You can edit it with `prompt_edit("boop")`
 
----
-
-    Code
-      prompt_new("cli", "replace")
-    Condition
-      Error in `prompt_new()`:
-      ! There's already a pal with role "cli".
-
 # prompt_remove errors informatively with bad role
 
     Code
@@ -47,3 +39,27 @@
       Error in `prompt_new()`:
       ! `contents` must be a connection to a markdown file.
 
+# default roles can't be overwritten or deleted (#59)
+
+    Code
+      prompt_new("cli", "replace")
+    Condition
+      Error in `prompt_new()`:
+      ! Default roles cannot be edited or removed.
+
+---
+
+    Code
+      prompt_edit("cli")
+    Condition
+      Error in `prompt_edit()`:
+      ! Default roles cannot be edited or removed.
+
+---
+
+    Code
+      prompt_remove("cli")
+    Condition
+      Error in `prompt_remove()`:
+      ! Default roles cannot be edited or removed.
+

tests/testthat/test-prompt.R

@@ -31,8 +31,6 @@ test_that("prompt_new errors informatively with redundant role", {
 
   expect_snapshot(error = TRUE, prompt_new("boop", "replace"))
   expect_snapshot(error = TRUE, prompt_new("boop", "prefix"))
-
-  expect_snapshot(error = TRUE, prompt_new("cli", "replace"))
 })
 
 test_that("prompt_new works when directory doesn't exist yet (#47)", {
@@ -130,6 +128,12 @@ test_that("prompts can be added, removed, and added again without restart (#58)"
   expect_true(file.exists(path))
 })
 
+test_that("default roles can't be overwritten or deleted (#59)", {
+  expect_snapshot(error = TRUE, prompt_new("cli", "replace"))
+  expect_snapshot(error = TRUE, prompt_edit("cli"))
+  expect_snapshot(error = TRUE, prompt_remove("cli"))
+})
+
 test_that("is_markdown_file works", {
   expect_true(is_markdown_file("some_file.md"))
   expect_true(is_markdown_file("some_file.Md"))