Merge pull request #22 from olivroy/cli

Use cli instead of crayon.

Author: PMassicotte

.Rbuildignore

@@ -0,0 +1,2 @@
+^.*\.Rproj$
+^\.Rproj\.user$

DESCRIPTION

@@ -21,12 +21,11 @@ Description: Simple interface to query gitignore.io to fetch
     gitignore templates that can be included in the .gitignore file. More
     than 450 templates are currently available.
 License: GPL-3
-URL: https://docs.ropensci.org/gitignore/, https://github.com/ropensci/gitignore, https://github.com/ropensci/gitignore
+URL: https://docs.ropensci.org/gitignore/, https://github.com/ropensci/gitignore
 BugReports: https://github.com/ropensci/gitignore/issues
 Imports: 
+    cli,
     clipr,
-    clisymbols,
-    crayon,
     curl,
     glue,
     here,
@@ -44,4 +43,4 @@ VignetteBuilder:
 Encoding: UTF-8
 Language: en-US
 LazyData: true
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1

NEWS.md

@@ -1,5 +1,7 @@
 # gitignore (development version)
 
+- gitignore now provides clickable links as it uses cli instead of crayon.
+
 # gitignore 0.1.6
 
 - Skip or do not execute code chunks in vignettes if the internet or the gitignore API is not available, to fix CRAN problems.
@@ -13,7 +15,7 @@
 
 # gitignore 0.1.4
 
-- Change backend from https://www.gitignore.io/ to https://www.toptal.com/developers/gitignore as the former now redirects to the later (#13 @pat-s).
+- Change backend from https://www.gitignore.io/ to https://www.toptal.com/developers/gitignore as the former now redirects to the latter (#13 @pat-s).
 
 - Use `file.path()` instead of `paste0()` to build path. @dpprdan
 

R/gi_available_templates.R

@@ -15,13 +15,13 @@ gi_available_templates <-
     res <- curl::curl_fetch_memory(url)
 
     if (res$status_code != 200) {
-      stop(paste("http request failed with status code:"), res$status_code)
+      cli::cli_abort("http request failed with status code: {res$status_code}")
     }
 
     json_text <- rawToChar(res$content)
 
     if (!jsonlite::validate(json_text)) {
-      stop("Invalid json file returned in gi_available_templates() function.")
+      cli::cli_abort("Invalid json file returned in gi_available_templates() function.")
     }
 
     r <- jsonlite::fromJSON(json_text)

R/gi_fetch_templates.R

@@ -42,9 +42,10 @@ gi_fetch_templates <-
     i <- template_name %in% l
 
     if (!all(i)) {
-      stop(
-        "Some template_name were not found on gitignore.io: ",
-        crayon::red$bold(paste(template_name[!i], collapse = ", "))
+      # https://cli.r-lib.org/reference/cli_div.html
+      cli::cli_div(theme = list(span.emph = list(color = "red", "font-weight" = "bold")))
+      cli::cli_abort(
+        "Some template_name were not found on gitignore.io: {.emph {template_name[!i]}}.",
       )
     }
 
@@ -56,17 +57,15 @@ gi_fetch_templates <-
     )
 
     if (r$status_code != 200) {
-      stop(paste("http request failed with status code:"), r$status_code)
+      cli::cli_abort("http request failed with status code: {r$status_code}")
     }
 
     # Copy or not into the clipboard
     if (clipr::clipr_available() && copy_to_clipboard) { # nocov start
       clipr::write_clip(rawToChar(r$content))
-      message(
-        crayon::green(clisymbols::symbol$bullet),
-        paste(
-          " Copied to the clipboard.",
-          "You can now paste it in your .gitignore file.\n"
+      cli::cli_inform(c(
+        "v" = "Copied to the clipboard.
+             You can now paste it in your {.file .gitignore}"
         )
       ) # nocov end
     } else {

R/gi_write_gitignore.R

@@ -24,13 +24,11 @@ gi_write_gitignore <-
     stopifnot(basename(gitignore_file) == ".gitignore")
 
     if (!file.exists(gitignore_file)) { # nocov start
-      message(
-        crayon::red(clisymbols::symbol$bullet),
-        " The .gitignore file could not be found in the project directory",
-        here::here(),
-        "Would you like to create it?",
-        "\n"
-      )
+      cli::cli_inform(c(
+        "x" = "The .gitignore file could not be found in the
+        project directory {.path {here::here()}}",
+        i = "Would you like to create it?"
+      ))
 
       response <- utils::menu(c("Yes", "No"))
 
@@ -39,9 +37,8 @@ gi_write_gitignore <-
         file.create(gitignore_file)
 
       } else {
-        stop(
-         "Could not find the file: ",
-          crayon::red$bold(gitignore_file)
+        cli::cli_abort(
+         "Could not find the file: {.file {gitignore_file}}",
         )
       }
     } # nocov end
@@ -54,21 +51,19 @@ gi_write_gitignore <-
     new <- setdiff(fetched_template_splitted, existing_lines)
 
     if (length(new) == 0) {
-      message(
-        crayon::yellow(clisymbols::symbol$bullet),
-        " Nothing to be modified in the .gitignore file.\n"
-      )
+      cli::cli_inform(c(
+        "!" = "Nothing to be modified in the {.file .gitignore} file."
+      ))
       return(FALSE)
     }
 
     all <- c(existing_lines, new)
 
     xfun::write_utf8(all, gitignore_file)
 
-    message(
-      crayon::green(clisymbols::symbol$bullet),
-      " .gitignore file successfully modified.\n"
-    )
+    cli::cli_inform(c(
+      "v" = "{.file .gitignore} file successfully modified."
+    ))
 
     invisible(TRUE)
   }