add: opt in color log output

resolves #275

Author: 2bndy5

README.md

@@ -47,6 +47,9 @@ workflow [`step-summary`][step-summary], and Pull Request reviews (with
 
 Create a new GitHub Actions workflow in your project, e.g. at [.github/workflows/cpp-linter.yml](https://github.com/cpp-linter/cpp-linter-action/blob/main/.github/workflows/cpp-linter.yml)
 
+> [!TIP]
+> To enable color output in the workflow logs, set the environment variable `CPP_LINTER_COLOR` to a value of `on` or `true` or `1`.
+
 The content of the file should be in the following format.
 
 ```yaml
@@ -56,6 +59,7 @@ The content of the file should be in the following format.
         id: linter
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CPP_LINTER_COLOR: on # off by default
         with:
           style: 'file'  # Use .clang-format config file
           tidy-checks: '' # Use .clang-tidy config file

action.yml

@@ -269,6 +269,11 @@ runs:
         source "$GITHUB_ACTION_PATH/venv/bin/activate"
         pip install -r "$GITHUB_ACTION_PATH/requirements.txt"
         clang-tools -i ${{ inputs.version }} -b
+        case "${{ env.CPP_LINTER_COLOR }}" in
+            "true" | "on" | "1")
+                pip install -r "$GITHUB_ACTION_PATH/color-requirements.txt"
+                ;;
+        esac
 
     - name: Run cpp-linter (Unix)
       id: cpp-linter-unix
@@ -308,6 +313,11 @@ runs:
         Invoke-Expression -Command "$env:GITHUB_ACTION_PATH/venv/Scripts/Activate.ps1"
         pip install -r "$env:GITHUB_ACTION_PATH/requirements.txt"
         clang-tools -i ${{ inputs.version }} -b
+        $colorEnabled = "true","on","1"
+        if ( $colorEnabled.contains("${{ env.CPP_LINTER_COLOR }}") )
+        {
+            pip install -r "$GITHUB_ACTION_PATH/color-requirements.txt"
+        }
 
     - name: Run cpp-linter (Windows)
       id: cpp-linter-windows

color-requirements.txt

@@ -0,0 +1 @@
+rich==13.9.2