From e835d01d598268bd6edbd70faccbcd1fb4b6e83e Mon Sep 17 00:00:00 2001
From: Boris Lykah <lykahb@gmail.com>
Date: Fri, 11 Mar 2022 14:07:52 -0700
Subject: [PATCH] Document stat feature

---
 README.md  | 29 +++++++++++++++++++++++++++++
 action.yml | 10 ++++++++++
 2 files changed, 39 insertions(+)

diff --git a/README.md b/README.md
index 106b471a..e84497e3 100644
--- a/README.md
+++ b/README.md
@@ -70,6 +70,7 @@ For more scenarios see [examples](#examples) section.
 
 ## What's New
 
+- Add `stat` parameter that enables output of the file changes statistics per filter.
 - Add `ref` input parameter
 - Add `list-files: csv` format
 - Configure matrix job to run for each folder with changes using `changes` output
@@ -160,6 +161,7 @@ For more information, see [CHANGELOG](https://github.com/dorny/paths-filter/blob
 - For each filter, it sets an output variable with the name `${FILTER_NAME}_count` to the count of matching files.
 - If enabled, for each filter it sets an output variable with the name `${FILTER_NAME}_files`. It will contain a list of all files matching the filter.
 - `changes` - JSON array with names of all filters matching any of the changed files.
+- If `stat` input is set to an output format, the output variable `stat` contains JSON or CSV value with the change statistics for each filter.
 
 ## Examples
 
@@ -504,6 +506,33 @@ jobs:
 
 </details>
 
+<details>
+  <summary>Passing number of added lines from a filter to another action</summary>
+
+```yaml
+- uses: dorny/paths-filter@v2
+  id: filter
+  with:
+    # Enable listing of diff stat matching each filter.
+    # Paths to files will be available in `stat` output variable.
+    # Stat will be formatted as JSON object
+    stat: json
+
+    # In this example all changed files are passed to the following action to do
+    # some custom processing.
+    filters: |
+      changed:
+        - '**'
+- name: Lint Markdown
+  uses: johndoe/some-action@v1
+  # Run action only if the change is large enough.
+  if: ${{fromJson(steps.filter.outputs.stat).changed.additionCount > 1000}}
+  with:
+    files: ${{ steps.filter.outputs.changed_files }}
+```
+
+</details>
+
 ## See also
 
 - [test-reporter](https://github.com/dorny/test-reporter) - Displays test results from popular testing frameworks directly in GitHub
diff --git a/action.yml b/action.yml
index dc515281..65128ddc 100644
--- a/action.yml
+++ b/action.yml
@@ -36,6 +36,16 @@ inputs:
                   Backslash escapes every potentially unsafe character.
     required: true
     default: none
+  stat:
+    description: |
+      Enables listing of that enables output of the file change statistics per filter, similar to `git diff --shortstat`.
+      If some changes do not match any filter, the output includes an additional entry with the filter name 'other'.
+        'none'  - Disables listing of stats (default).
+        'csv'   - Coma separated list that has name of filter, count of additions, count of deletions, count of changed files.
+                  If needed it uses double quotes to wrap name of filter with unsafe characters. For example, `"some filter",12,7,2`.
+        'json'  - Serialized as JSON object where the filter names are keys. For example, `{"some filter": {"additionCount": 12, "deletionCount": 7, "fileCount": 2}}`
+    required: false
+    default: none
   initial-fetch-depth:
     description: |
       How many commits are initially fetched from base branch.