From 9c03169a91f76f77a40462999b96ddc14b751c9c Mon Sep 17 00:00:00 2001
From: Thijs Koerselman <thijskoerselman@gmail.com>
Date: Wed, 22 Jan 2020 23:29:32 +0700
Subject: [PATCH] Improve list (#21)

* Add title for lists with magenta category name

* Update examples and readme for list
---
 README.md                                 | 24 +++++++++++------------
 examples/list.js                          |  6 ++----
 src/reporters/console/console-reporter.js |  9 ++++++++-
 3 files changed, 21 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 72c839c..4822a86 100644
--- a/README.md
+++ b/README.md
@@ -163,24 +163,21 @@ The following functions are available:
 
 Pretty-prints the `thing`.
 
-### list(key: string, items: Array<string>, hints?: Object)
+### list(title: string, items: Array<string>, hints?: Object)
 
 Generates a list of the provided items. Turns into a definition list if `hints`
-are provided. Note that the `key` is not used.
+are provided.
 
 Example of a simple list:
 
 ```
-const someList = ['bananas', 'tulips', 'eggs', 'bamischijf'];
-
-report.info('My grocery list');
-report.list('ignored', someList);
+report.list('My grocery list', ['bananas', 'tulips', 'eggs', 'bamischijf']);
 ```
 
-generates
+Outputs:
 
 ```
-info My grocery list
+list My grocery list
    - bananas
    - tulips
    - eggs
@@ -191,7 +188,7 @@ info My grocery list
 Example with hints:
 
 ```
-const someList = ['bananas', 'tulips', 'eggs', 'bamischijf'];
+const items = ['bananas', 'tulips', 'eggs', 'bamischijf'];
 
 const hints = {
   bananas: 'for baking',
@@ -200,12 +197,13 @@ const hints = {
   bamischijf: 'if they have it',
 };
 
-report.info('My grocery list');
-report.list('dunno', someList, hints);
+report.list('My grocery list', items, hints);
 ```
-generates
+
+Outputs:
+
 ```
-info My grocery list
+list My grocery list
     - bananas
       for baking
    - tulips
diff --git a/examples/list.js b/examples/list.js
index 73ee074..c52321e 100644
--- a/examples/list.js
+++ b/examples/list.js
@@ -3,8 +3,7 @@ const report = require('../dist');
 /* eslint-disable flowtype/require-return-type */
 const someList = ['bananas', 'tulips', 'eggs', 'bamischijf'];
 
-report.info('My grocery list');
-report.list('dunno', someList);
+report.list('My grocery list', someList);
 
 const hints = {
   bananas: 'for baking',
@@ -13,5 +12,4 @@ const hints = {
   bamischijf: 'if they have it',
 };
 
-report.info('The same list with hints');
-report.list('dunno', someList, hints);
+report.list('The same list with hints', someList, hints);
diff --git a/src/reporters/console/console-reporter.js b/src/reporters/console/console-reporter.js
index 4fb3460..3a0b44c 100644
--- a/src/reporters/console/console-reporter.js
+++ b/src/reporters/console/console-reporter.js
@@ -134,7 +134,14 @@ export default class ConsoleReporter extends BaseReporter {
     this.log(String(value), {force: true});
   }
 
-  list(key: string, items: Array<string>, hints?: Object) {
+  list(title: string, items: Array<string>, hints?: Object) {
+    /**
+     * Because in the original Yarn code list() is called starting with a "key:
+     * string" argument that is ignored, we don't assume that a title has been
+     * passed in or is a valid string, to avoid creating a breaking change.
+     */
+    this._logCategory('list', 'magenta', typeof title === 'string' ? this.format.bold(title) : '');
+
     const gutterWidth = (this._lastCategorySize || 2) - 1;
 
     if (hints) {