DS-5106: Merge upstream changes from r-lib/cli

.github/workflows/R-CMD-check.yaml

@@ -22,27 +22,27 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          - {os: macOS-latest,   r: 'release'}
+          - {os: macos-latest,   r: 'release'}
 
-          - {os: windows-2022,   r: 'devel'}
           - {os: windows-latest, r: 'release'}
           # Use 3.6 to trigger usage of RTools35
           - {os: windows-latest, r: '3.6'}
+          # use 4.1 to check with rtools40's older compiler
+          - {os: windows-latest, r: '4.1'}
 
-          # Use older ubuntu to maximise backward compatibility
-          - {os: ubuntu-18.04,   r: 'devel', http-user-agent: 'release'}
-          - {os: ubuntu-18.04,   r: 'release'}
-          - {os: ubuntu-18.04,   r: 'oldrel-1'}
-          - {os: ubuntu-18.04,   r: 'oldrel-2'}
-          - {os: ubuntu-18.04,   r: 'oldrel-3'}
-          - {os: ubuntu-18.04,   r: 'oldrel-4'}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
+          - {os: ubuntu-latest,   r: 'oldrel-2'}
+          - {os: ubuntu-latest,   r: 'oldrel-3'}
+          - {os: ubuntu-latest,   r: 'oldrel-4'}
 
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_KEEP_PKG_SOURCE: yes
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -56,7 +56,6 @@ jobs:
         with:
           extra-packages: any::rcmdcheck
           needs: check
-          pak-version: rc
 
       - uses: r-lib/actions/check-r-package@v2
         with:

.github/workflows/pkgdown.yaml

@@ -21,7 +21,7 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_CLI_NUM_COLORS: 256
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -36,7 +36,6 @@ jobs:
             local::.
             local::./tests/testthat/progresstest
           needs: website
-          pak-version: rc
 
       - name: Build site
         run: |
@@ -48,7 +47,7 @@ jobs:
 
       - name: Deploy to GitHub pages 🚀
         if: github.event_name != 'pull_request'
-        uses: JamesIves/github-pages-deploy-action@4.1.4
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
         with:
           clean: false
           branch: gh-pages

.github/workflows/pr-commands.yaml

@@ -14,7 +14,7 @@ jobs:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/pr-fetch@v2
         with:
@@ -28,7 +28,6 @@ jobs:
         with:
           extra-packages: any::roxygen2
           needs: pr-document
-          pak-version: rc
 
       - name: Document
         run: roxygen2::roxygenise()
@@ -52,7 +51,7 @@ jobs:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/pr-fetch@v2
         with:

.github/workflows/rhub.yaml

@@ -0,0 +1,72 @@
+# R-hub's genetic GitHub Actions workflow file. It's canonical location is at
+# https://github.com/r-hub/rhub2/blob/v1/inst/workflow/rhub.yaml
+# You can update this file to a newer version using the rhub2 package:
+#
+# rhub2::rhub_setup()
+#
+# It is unlikely that you need to modify this file manually.
+
+name: R-hub
+
+on:
+  workflow_dispatch:
+    inputs:
+      config:
+        description: 'A comma separated list of R-hub platforms to use.'
+        type: string
+        default: 'linux,windows,macos'
+
+jobs:
+
+  setup:
+    runs-on: ubuntu-latest
+    outputs:
+      containers: ${{ steps.rhub-setup.outputs.containers }}
+      platforms: ${{ steps.rhub-setup.outputs.platforms }}
+
+    steps:
+    # NO NEED TO CHECKOUT HERE
+    - uses: r-hub/rhub2/actions/rhub-setup@v1
+      with:
+        config: ${{ github.event.inputs.config }}
+      id: rhub-setup
+
+  linux-containers:
+    needs: setup
+    if: ${{ needs.setup.outputs.containers != '[]' }}
+    runs-on: ubuntu-latest
+    name: ${{ matrix.config.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config: ${{ fromJson(needs.setup.outputs.containers) }}
+    container:
+      image: ${{ matrix.config.container }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: r-hub/rhub2/actions/rhub-check@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+
+  other-platforms:
+    needs: setup
+    if: ${{ needs.setup.outputs.platforms != '[]' }}
+    runs-on: ${{ matrix.config.os }}
+    name: ${{ matrix.config.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config: ${{ fromJson(needs.setup.outputs.platforms) }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: r-hub/rhub2/actions/rhub-setup-r@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}
+      - uses: r-hub/rhub2/actions/rhub-check@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}

.github/workflows/test-coverage.yaml

@@ -15,7 +15,7 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/setup-r@v2
         with:
@@ -25,8 +25,26 @@ jobs:
         with:
           extra-packages: any::covr
           needs: coverage
-          pak-version: rc
 
       - name: Test coverage
-        run: covr::codecov(quiet = FALSE)
+        run: |
+          covr::codecov(
+            quiet = FALSE,
+            clean = FALSE,
+            install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
+          )
         shell: Rscript {0}
+
+      - name: Show testthat output
+        if: always()
+        run: |
+          ## --------------------------------------------------------------------
+          find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
+        shell: bash
+
+      - name: Upload test results
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-test-failures
+          path: ${{ runner.temp }}/package

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: cli
 Title: Helpers for Developing Command Line Interfaces
-Version: 3.4.1.9000
+Version: 3.6.1.9000
 Authors@R: c(
     person("Gábor", "Csárdi", , "csardi.gabor@gmail.com", role = c("aut", "cre")),
     person("Hadley", "Wickham", role = "ctb"),
@@ -50,10 +50,11 @@ Config/Needs/website:
     decor,
     desc,
     fansi,
+    prettyunits,
     sessioninfo,
     tidyverse/tidytemplate,
     usethis,
     vctrs
 Config/testthat/edition: 3
 Encoding: UTF-8
-RoxygenNote: 7.2.1.9000
+RoxygenNote: 7.2.3

NAMESPACE

@@ -166,22 +166,29 @@ export(format_inline)
 export(format_message)
 export(format_warning)
 export(get_spinner)
+export(has_keypress_support)
 export(hash_animal)
 export(hash_emoji)
+export(hash_file_md5)
+export(hash_file_sha1)
 export(hash_file_sha256)
 export(hash_md5)
 export(hash_obj_animal)
 export(hash_obj_emoji)
 export(hash_obj_md5)
+export(hash_obj_sha1)
 export(hash_obj_sha256)
 export(hash_raw_animal)
 export(hash_raw_emoji)
 export(hash_raw_md5)
+export(hash_raw_sha1)
 export(hash_raw_sha256)
+export(hash_sha1)
 export(hash_sha256)
 export(is_ansi_tty)
 export(is_dynamic_tty)
 export(is_utf8_output)
+export(keypress)
 export(list_border_styles)
 export(list_spinners)
 export(list_symbols)

NEWS.md

@@ -1,5 +1,29 @@
 # cli (development version)
 
+# cli 3.6.1
+
+* ANSI hyperlinks are now turned off on the RStudio render plane (#581).
+
+# cli 3.6.0
+
+* The progressr progress handler now reports progress correctly
+  (@HenrikBengtsson, #558).
+
+* New `hash_*sha1()` functions to calculate the SHA-1 hash of strings,
+  objects, files.
+
+* cli now shows progress bars after one second by default, if they
+  are less than half way at the point. (Or after two seconds,
+  unconditionally, as before.) See the the `cli.progress_show_after`
+  option in `?cli-config` for details (#542).
+
+* `format_inline()` now has a new argument `keep_whitespace`, and it keeps
+  whitespace, including newline and form feed characters by default.
+
+# cli 3.5.0
+
+* New `keypress()` function to read a single key press from a terminal.
+
 * New function `pretty_print_code()` to print function objects with syntax
   highlighting at the R console.
 
@@ -11,6 +35,9 @@
 * `ansi_strtrim()` now handles some edge cases better, when `ellipsis` has
   length zero, and when it is wider than `width`.
 
+* New `hash_file_md5()` function to calculate the MD5 hash of one or more
+  files.
+
 # cli 3.4.1
 
 * cli has better error messages now.

R/aab-rstudio-detect.R

@@ -209,7 +209,8 @@ rstudio <- local({
       ansi_tty = FALSE,
       ansi_color = FALSE,
       num_colors = 1L,
-      hyperlink = FALSE
+      hyperlink = FALSE,
+      has_canonical_mode = FALSE
     )
   }
 
@@ -220,7 +221,8 @@ rstudio <- local({
       ansi_tty = FALSE,
       ansi_color = data$envs[["RSTUDIO_CONSOLE_COLOR"]] != "",
       num_colors = as.integer(data$envs[["RSTUDIO_CONSOLE_COLOR"]]),
-      hyperlink = data$envs[["RSTUDIO_CLI_HYPERLINKS"]] != ""
+      hyperlink = data$envs[["RSTUDIO_CLI_HYPERLINKS"]] != "",
+      has_canonical_mode = FALSE
     )
   }
 
@@ -237,7 +239,8 @@ rstudio <- local({
       ansi_tty = FALSE,
       ansi_color = FALSE,
       num_colors = 1L,
-      hyperlink = FALSE
+      hyperlink = FALSE,
+      has_canonical_mode = FALSE
     )
   }
 
@@ -248,7 +251,8 @@ rstudio <- local({
       ansi_tty = FALSE,
       ansi_color = data$envs[["RSTUDIO_CONSOLE_COLOR"]] != "",
       num_colors = as.integer(data$envs[["RSTUDIO_CONSOLE_COLOR"]]),
-      hyperlink = data$envs[["RSTUDIO_CLI_HYPERLINKS"]] != ""
+      hyperlink = data$envs[["RSTUDIO_CLI_HYPERLINKS"]] != "",
+      has_canonical_mode = FALSE
     )
   }
 
@@ -259,7 +263,8 @@ rstudio <- local({
       ansi_tty = FALSE,
       ansi_color = data$envs[["RSTUDIO_CONSOLE_COLOR"]] != "",
       num_colors = as.integer(data$envs[["RSTUDIO_CONSOLE_COLOR"]]),
-      hyperlink = data$envs[["RSTUDIO_CLI_HYPERLINKS"]] != ""
+      hyperlink = data$envs[["RSTUDIO_CLI_HYPERLINKS"]] != "",
+      has_canonical_mode = FALSE
     )
   }
 
@@ -270,7 +275,8 @@ rstudio <- local({
       ansi_tty = FALSE,
       ansi_color = FALSE,
       num_colors = 1L,
-      hyperlink = data$envs[["RSTUDIO_CLI_HYPERLINKS"]] != ""
+      hyperlink = FALSE,
+      has_canonical_mode = FALSE
     )
   }
 
@@ -281,7 +287,8 @@ rstudio <- local({
       ansi_tty = FALSE,
       ansi_color = FALSE,
       num_colors = 1L,
-      hyperlink = FALSE
+      hyperlink = FALSE,
+      has_canonical_mode = FALSE
     )
   }
 

R/ansi-hyperlink.R

@@ -327,17 +327,7 @@ ansi_has_hyperlink_support <- function() {
   if (isTRUE(as.logical(enabled))){ return(TRUE) }
 
   ## If ANSI support is off, then this is off as well
-  opt <- as.integer(getOption("cli.num_colors", NULL))[1]
-  if (!is.na(opt) && opt == 1) return(FALSE)
-  env <- as.integer(Sys.getenv("R_CLI_NUM_COLORS", ""))[1]
-  if (!is.na(env) && env == 1) return(FALSE)
-  cray_opt <- as.logical(getOption("crayon.enabled", NULL))[1]
-  if (!is.na(cray_opt) && !cray_opt) return(FALSE)
-  if (!is.na(Sys.getenv("NO_COLOR", NA_character_))) return(FALSE)
-
-  ## environment variable used by RStudio
-  enabled <- Sys.getenv("RSTUDIO_CLI_HYPERLINKS", "")
-  if (isTRUE(as.logical(enabled))){ return(TRUE) }
+  if (num_ansi_colors() == 1) return(FALSE)
 
   ## Are we in RStudio?
   rstudio <- rstudio_detect()