[skip-changelog] Add output.no_color to configuration docs (#2246)

* Add output.no_color to configuration docs * Add output.no_color to configuration.schema.json
arduino · Jul 20, 2023 · 0727686 · 0727686
1 parent df12786
commit 0727686
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/configuration/configuration.schema.json b/configuration/configuration.schema.json
@@ -135,6 +135,16 @@
       },
       "type": "object"
     },
+    "output": {
+      "description": "settings related to text output.",
+      "properties": {
+        "no_color": {
+          "description": "ANSI color escape codes are added by default to the output. Set to `true` to disable colored text output.",
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
     "sketch": {
       "description": "configuration options relating to [Arduino sketches][sketch specification].",
       "properties": {

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -28,6 +28,9 @@
 - `metrics` - settings related to the collection of data used for continued improvement of Arduino CLI.
   - `addr` - TCP port used for metrics communication.
   - `enabled` - controls the use of metrics.
+- `output` - settings related to text output.
+  - `no_color` - ANSI color escape codes are added by default to the output. Set to `true` to disable colored text
+    output.
 - `sketch` - configuration options relating to [Arduino sketches][sketch specification].
   - `always_export_binaries` - set to `true` to make [`arduino-cli compile`][arduino-cli compile] always save binaries
     to the sketch folder. This is the equivalent of using the [`--export-binaries`][arduino-cli compile options] flag.