From da6a17d49f2772330e30dfb10be3febb23ee66d7 Mon Sep 17 00:00:00 2001
From: JohnAlbin <virtually.johnalbin@gmail.com>
Date: Mon, 5 Apr 2021 12:37:57 +0800
Subject: [PATCH] Improve docs for convertColors

---
 README.md                |  2 +-
 plugins/convertColors.js | 10 +++++++++-
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 93aa3a6cf..c507c4415 100644
--- a/README.md
+++ b/README.md
@@ -227,7 +227,7 @@ const config = await loadConfig(configFile, cwd);
 | [cleanupEnableBackground](https://github.com/svg/svgo/blob/master/plugins/cleanupEnableBackground.js)               | remove or cleanup `enable-background` attribute when possible                                                                                            | `enabled`  |
 | [minifyStyles](https://github.com/svg/svgo/blob/master/plugins/minifyStyles.js)                                     | minify `<style>` elements content with [CSSO](https://github.com/css/csso)                                                                               | `enabled`  |
 | [convertStyleToAttrs](https://github.com/svg/svgo/blob/master/plugins/convertStyleToAttrs.js)                       | convert styles into attributes                                                                                                                           | `disabled` |
-| [convertColors](https://github.com/svg/svgo/blob/master/plugins/convertColors.js)                                   | convert colors (from `rgb()` to `#rrggbb`, from `#rrggbb` to `#rgb`)                                                                                     | `enabled`  |
+| [convertColors](https://github.com/svg/svgo/blob/master/plugins/convertColors.js)                                   | convert colors (from `rgb()` to `#rrggbb`, from `#rrggbb` to `#rgb`, optionally to `currentColor`)                                                                                     | `enabled`  |
 | [convertPathData](https://github.com/svg/svgo/blob/master/plugins/convertPathData.js)                               | convert Path data to relative or absolute (whichever is shorter), convert one segment to another, trim useless delimiters, smart rounding, and much more | `enabled`  |
 | [convertTransform](https://github.com/svg/svgo/blob/master/plugins/convertTransform.js)                             | collapse multiple transforms into one, convert matrices to the short aliases, and much more                                                              | `enabled`  |
 | [removeUnknownsAndDefaults](https://github.com/svg/svgo/blob/master/plugins/removeUnknownsAndDefaults.js)           | remove unknown elements content and attributes, remove attributes with default values                                                                    | `enabled`  |
diff --git a/plugins/convertColors.js b/plugins/convertColors.js
index 3f3cece15..891507b16 100644
--- a/plugins/convertColors.js
+++ b/plugins/convertColors.js
@@ -5,7 +5,8 @@ const collections = require('./_collections.js');
 exports.type = 'visitor';
 exports.name = 'convertColors';
 exports.active = true;
-exports.description = 'converts colors: rgb() to #rrggbb and #rrggbb to #rgb';
+exports.description =
+  'converts colors: rgb() to #rrggbb and #rrggbb to #rgb, optionally to currentColor';
 
 const rNumber = '([+-]?(?:\\d*\\.\\d+|\\d+\\.?)%?)';
 const rComma = '\\s*,\\s*';
@@ -61,6 +62,13 @@ const convertRgbToHex = ([r, g, b]) => {
  * Convert hex to short name
  * #000080 ➡ navy
  *
+ * To optionally convert colors to `currentColor`, set `params.currentColor` to
+ * `true` to replace all colors (except "none") or set it to a string containing
+ * the color to replace or set it to a regex to replace multiple colors. e.g.
+ * params: { currentColor: true }
+ * params: { currentColor: '#000' }
+ * params: { currentColor: /#0{3,6}/ }
+ *
  * @author Kir Belevich
  *
  * @type {import('../lib/types').Plugin<{