Create a cheat sheet

[Moohan]

I love cli but always find myself having to pour through the docs to find the same types of things. A cheat sheet would be great!

[gaborcsardi]

Some of cli is still in flux, so it is bit early to create a cheat sheet now. But maybe we can improve the organization of the existing docs at https://cli.r-lib.org/reference/index.html?

[cynthiahqy]

Working on this at tidy-dev-day with @simonpcouch and @gadenbuie

Draft prioritisation of topics in https://cli.r-lib.org/reference/:

Section/Page 1:

• Format and signal errors with cli formatting
  • cli_bullets()
  • Inline Markup (for one line of text)
  • substitution of classes; (pure styling)
  • glue substitution (code eval)
  • default classes: bullets & .class modifiers
• Semantic CLI Elements
  • "Structured elements": bullets, ul/ol, blockquote,
  • purely messages (beyond inline markup)
  • usually for print()
• Basic Progress bars
• Basic Pluralization

Section/Page 2:

• Advanced Progress bars
• Rules, Boxes, Trees, Spinners, etc.
• Themes

Not on cheatsheet:

• Functions for (should be covered in page 1 as cli elements OR inline markup)
  • Pluralization
  • Terminal Colors and Styles
  • ANSI and/or UTF-8 String Manipulation
  • Syntax Highlighting
• ANSI Control Sequences
• Hashing
• Superseded functions

Unsure:

• Utilities and Configuration
  • cli_fmt() (no print) vs cli_format() (print)