r-lib / clisymbols Goto Github PK

On my system:

$ LC_ALL=C R -q -e 'clisymbols::symbol'
> clisymbols::symbol
$tick
[1] "<U+221A>"

$cross
[1] "x"

$star
[1] "*"

$square
[1] "<U+2588>"

$square_small
[1] "[ ]"

$square_small_filled
[1] "[<U+2588>]"

$circle
[1] "( )"

$circle_filled
[1] "(*)"

$circle_dotted
[1] "( )"

$circle_double
[1] "(o)"

$circle_circle
[1] "(o)"

$circle_cross
[1] "(x)"

$circle_pipe
[1] "(|)"

$circle_question_mark
[1] "(?)"

$bullet
[1] "*"

$dot
[1] "."

$line
[1] "<U+2500>"

$double_line
[1] "="

$ellipsis
[1] "..."

$pointer
[1] ">"

$info
[1] "i"

$warning
[1] "<U+203C>"

$menu
[1] "<U+2261>"

$smiley
[1] "<U+263A>"

$mustache
[1] "<U+250C><U+2500><U+2510>"

$heart
[1] "<U+2665>"

$arrow_up
[1] "^"

$arrow_down
[1] "v"

$arrow_left
[1] "<"

$arrow_right
[1] ">"

$radio_on
[1] "(*)"

$radio_off
[1] "( )"

$checkbox_on
[1] "[x]"

$checkbox_off
[1] "[ ]"

$checkbox_circle_on
[1] "(x)"

$checkbox_circle_off
[1] "( )"

$fancy_question_mark
[1] "(?)"

$neq
[1] "!="

$geq
[1] ">="

$leq
[1] "<="

$upper_block_1
[1] "^"

$upper_block_4
[1] "^"

$lower_block_1
[1] "."

$lower_block_2
[1] "_"

$lower_block_3
[1] "_"

$lower_block_4
[1] "="

$lower_block_5
[1] "="

$lower_block_6
[1] "*"

$lower_block_7
[1] "<U+2588>"

$lower_block_8
[1] "<U+2588>"

$full_block
[1] "<U+2588>"

The master branch of this repository will soon be renamed to main, as part of a coordinated change across several GitHub organizations (including, but not limited to: tidyverse, r-lib, tidymodels, and sol-eng). We anticipate this will happen by the end of September 2021.

That will be preceded by a release of the usethis package, which will gain some functionality around detecting and adapting to a renamed default branch. There will also be a blog post at the time of this master --> main change.

The purpose of this issue is to:

• Help us firm up the list of targetted repositories
• Make sure all maintainers are aware of what's coming
• Give us an issue to close when the job is done
• Give us a place to put advice for collaborators re: how to adapt

message id: euphoric_snowdog

Pre-history

• usethis::use_readme_rmd()
• usethis::use_roxygen_md() (superseded package)
• usethis::use_github_links()
• usethis::use_pkgdown_github_pages() (superseded package)
• usethis::use_tidy_github_labels() (superseded package)
• usethis::use_tidy_style()
• urlchecker::url_check()

2020

• usethis::use_package_doc()
• usethis::use_testthat(3)
• Align the names of R/ files and test/ files

2021

• Remove check environments section from cran-comments.md
• Use lifecycle instead of artisanal deprecation messages

2022

• Handle and close any still-open master --> main issues
• usethis:::use_codecov_badge("r-lib/clisymbols")
• Update pkgdown site using instructions at https://tidytemplate.tidyverse.org (superseded package)
• Update lifecycle badges with more accessible SVGs: usethis::use_lifecycle()

2023

• Update copyright holder in DESCRIPTION: person("Posit Software, PBC", role = c("cph", "fnd"))
• Run devtools::document() to re-generate package-level help topic with DESCRIPTION changes
• usethis::use_tidy_logo()
• usethis::use_tidy_coc()
• Use pak::pak("r-lib/clisymbols") in README
• Consider running usethis::use_tidy_dependencies() and/or replace compat files with use_standalone()
• Use cli errors or file an issue if you don't have time to do it now
• usethis::use_standalone("r-lib/rlang", "types-check") instead of home grown argument checkers;
  or file an issue if you don't have time to do it now
• Add alt-text to pictures, plots, etc; see https://posit.co/blog/knitr-fig-alt/ for examples

Eternal

• usethis::use_mit_license()
• usethis::use_package("R", "Depends", "3.6")
• usethis::use_tidy_description()
• usethis::use_tidy_github_actions()
• devtools::build_readme()
• Re-publish released site if needed

^{Created on 2023-11-03 with usethis::use_tidy_upkeep_issue(), using usethis v2.2.2.9000}

As I understand it, check marks supposed to appear instead of raw Unicode strings like 'U+221A'.

download.file("https://cran.r-project.org/src/contrib/crayon_1.3.4.tar.gz", "crayon_1.3.4.tar.gz")
devtools::check_built("crayon_1.3.4.tar.gz")

## ...
## <U+221A>  checking for file 'crayon/DESCRIPTION'
## <U+2500>  this is package 'crayon' version '1.3.4'
## <U+2500>  package encoding: UTF-8
## <U+221A>  checking package namespace information
## ...

sessionInfo()

## R version 3.4.0 (2017-04-21)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Red Hat Enterprise Linux Server release 6.9 (Santiago)
## 
## Matrix products: default
## BLAS: /lrlhps/apps/R/qualified/R-3.4.0/lib64/R/lib/libRblas.so
## LAPACK: /lrlhps/apps/R/qualified/R-3.4.0/lib64/R/lib/libRlapack.so
## 
## locale:
##  [1] LC_CTYPE=en_US       LC_NUMERIC=C         LC_TIME=en_US
##  [4] LC_COLLATE=en_US     LC_MONETARY=en_US    LC_MESSAGES=en_US
##  [7] LC_PAPER=en_US       LC_NAME=C            LC_ADDRESS=C
## [10] LC_TELEPHONE=C       LC_MEASUREMENT=en_US LC_IDENTIFICATION=C
## 
## attached base packages:
## [1] stats     graphics  grDevices utils     datasets  methods   base
## 
## loaded via a namespace (and not attached):
##  [1] clisymbols_1.2.0     digest_0.6.12        crayon_1.3.4
##  [4] withr_2.0.0          rprojroot_1.2        assertthat_0.2.0
##  [7] R6_2.2.2             backports_1.1.1      debugme_1.0.2
## [10] rlang_0.1.2.9000     callr_1.0.0.9000     devtools_1.13.3.9000
## [13] desc_1.1.1           rcmdcheck_1.2.1      pkgload_0.0.0.9000
## [16] compiler_3.4.0       processx_2.0.0.1     pkgbuild_0.0.0.9000
## [19] memoise_1.1.0        usethis_0.0.0.9000

for tibble, see e.g. tidyverse/tibble#192.

symbol$check was changed to symbol$tick here fb1cae7

but it was not changed in the documentation...

I see that tidyverse packages use cli, usethis uses clisymbols as a direct dependency and clisymbols is not a dependency of the package cli. cli provides more functionality. cli gets recent commits, clisymbols not really. I was wondering whether there is a preference as to what users should use or it would make sense to at least link to clisymbols from the readme.