Add new methods to toolbox.print (highlight and muted) (Fixes #726)

docs/toolbox-print.md

@@ -35,6 +35,26 @@ Well, if your next line of code isn't `process.exit(0)`, then it was probably a
 toolbox.print.error('Out of disk space.  lol.')
 ```
 
+## highlight
+
+Prints a message that's intended to have attention drawn to it.
+You could use it to point out the correct command to be run in an error message.
+Or you could use it to head sections of your help screen printout.
+
+```js
+toolbox.print.highlight('Run `gluegun login` to login')
+```
+
+## muted
+
+Prints a message in a muted gray color.
+This is useful for info that's not the most important but still helpful.
+Think of mundane or commonplace lines in output logging, for example.
+
+```js
+toolbox.print.muted('Connection status: GOOD')
+```
+
 ## debug
 
 Only used for debugging your plugins. You can pass this function a string or an object.
@@ -55,13 +75,14 @@ however we define a theme to make things a bit consistent.
 
 Some available functions include:
 
-| function           | use when you want...                     |
-| ------------------ | ---------------------------------------- |
-| `colors.success()` | the user to smile                        |
-| `colors.error()`   | to say something has failed              |
-| `colors.warning()` | to point out that something might be off |
-| `colors.info()`    | to say something informational           |
-| `colors.muted()`   | you need to say something secondary      |
+| function             | use when you want...                     |
+| -------------------- | ---------------------------------------- |
+| `colors.success()`   | the user to smile                        |
+| `colors.error()`     | to say something has failed              |
+| `colors.warning()`   | to point out that something might be off |
+| `colors.highlight()` | to draw attention to something           |
+| `colors.info()`      | to say something informational           |
+| `colors.muted()`     | you need to say something secondary      |
 
 Each take a `string` parameter and return a `string`.
 

src/toolbox/__snapshots__/print-tools.test.ts.snap

@@ -14,6 +14,14 @@ Array [
     "success!!",
     undefined,
   ],
+  Array [
+    "highlight",
+    undefined,
+  ],
+  Array [
+    "muted",
+    undefined,
+  ],
   Array [
     "error...",
     undefined,

src/toolbox/print-tools.test.ts

@@ -16,6 +16,8 @@ test('info', () => {
   print.info('info')
   print.warning('warning!')
   print.success('success!!')
+  print.highlight('highlight')
+  print.muted('muted')
   print.error('error...')
   print.debug('debugging...')
   const title = 'there'

src/toolbox/print-tools.test.ts.md

@@ -21,6 +21,14 @@ Generated by [AVA](https://ava.li).
         'success!!',
         undefined,
       ],
+      [
+        'highlight',
+        undefined,
+      ],
+      [
+        'muted',
+        undefined,
+      ]
       [
         'error...',
         undefined,

src/toolbox/print-tools.ts

@@ -92,6 +92,7 @@ function table(data: string[][], options: GluegunPrintTableOptions = {}): void {
   let t
   switch (options.format) {
     case 'markdown':
+      // eslint-disable-next-line no-case-declarations
       const header = data.shift()
       t = new CLITable({
         head: header,
@@ -185,6 +186,28 @@ function success(message: string): void {
   console.log(colors.success(message))
 }
 
+/**
+ * Writes a highlighted message.
+ *
+ * To draw attention to specific lines.  Use sparingly.
+ *
+ * @param message The message to show.
+ */
+function highlight(message: string): void {
+  console.log(colors.highlight(message))
+}
+
+/**
+ * Writes a muted message.
+ *
+ * For ancillary info, something that's not the star of the show.
+ *
+ * @param message The message to show.
+ */
+function muted(message: string): void {
+  console.log(colors.muted(message))
+}
+
 /**
  * Creates a spinner and starts it up.
  *
@@ -232,6 +255,8 @@ const print: GluegunPrint = {
   warning,
   debug,
   success,
+  highlight,
+  muted,
   spin,
   printCommands,
   printHelp,

src/toolbox/print-types.ts

@@ -31,6 +31,10 @@ export interface GluegunPrint {
   warning: (message: any) => void
   /* Prints a success-colored message. */
   success: (message: any) => void
+  /* Prints a highlighted (cyan) message. */
+  highlight: (message: any) => void
+  /* Prints a muted (grey) message. */
+  muted: (message: any) => void
   /* Prints an error-colored message. */
   error: (message: any) => void
   /* Prints debug information about any data, with an optional title. */