chore: outputs changed-files (#13)

### Added

- outputs `changed-files` with a comma-separated list of files changed by phpcbf
- `prettier-config-path` as an optional path to a custom Prettier config file

### Changed

- list of branches if `debug` is `true`

Author: WorkOfStan

.github/linters/.markdown-lint.yml

@@ -0,0 +1,41 @@
+---
+###########################
+###########################
+## Markdown Linter rules ##
+###########################
+###########################
+
+# Linter rules doc:
+# - https://github.com/DavidAnson/markdownlint
+#
+# Note:
+# To comment out a single error:
+#   <!-- markdownlint-disable -->
+#   any violations you want
+#   <!-- markdownlint-restore -->
+#
+
+############################
+# Super-linter Rules by id #
+############################
+MD004: false # Unordered list style
+MD007:
+  indent: 2 # Unordered list indentation
+MD013:
+  line_length: 808 # Line length 80 is far too short
+MD026:
+  punctuation: ".,;:!。，；:" # List of not allowed
+MD029: false # Ordered list item prefix
+MD033: false # Allow inline HTML
+MD036: false # Emphasis used instead of a heading
+
+##############################
+# Super-linter Rules by tags #
+##############################
+blank_lines: false # Error on blank lines
+
+########################
+# Seablast Rules by id #
+########################
+# Multiple heading with the same content (in CHANGELOG.md)
+MD024: false # No-duplicate-heading

.github/workflows/polish-the-code.yml

@@ -0,0 +1,27 @@
+---
+name: Super-linter
+
+on:
+  push:
+    branches-ignore:
+      # notest branches to ignore testing of partial online commits
+      - "notest/**"
+
+  pull_request:
+    branches-ignore:
+      # notest branches to ignore testing of partial online commits
+      - "notest/**"
+
+  schedule:
+    # Run the workflow at 6:30 AM UTC on the 18th of every month
+    - cron: "30 6 18 * *"
+    # Scheduled runs should not commit-changes automatically to the same branch
+
+permissions:
+  contents: read
+
+jobs:
+  super-linter:
+    uses: WorkOfStan/seablast-actions/.github/workflows/linter.yml@v0.2.3
+    with:
+      runs-on: "ubuntu-latest"

.github/workflows/prettier-fix.yml

@@ -15,5 +15,6 @@ jobs:
         # Use the latest commit in the main branch.
         uses: WorkOfStan/prettier-fix@main
         with:
-          #node-version: "20"
           commit-changes: true
+          #debug: true
+          #node-version: "20"

CHANGELOG.md

@@ -19,6 +19,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### `Security` in case of vulnerabilities
 
+## [1.1.4] - 2025-05-31
+
+chore: outputs `changed-files`
+
+### Added
+
+- outputs `changed-files` with a comma-separated list of files changed by phpcbf
+- `prettier-config-path` as an optional path to a custom Prettier config file
+
+### Changed
+
+- list of branches if `debug` is `true`
+
 ## [1.1.3] - 2025-03-01
 
 Fix pull request issues
@@ -85,7 +98,8 @@ Fix pull request issues
 
 - This GitHub Action automates Prettier formatting across your project, ensuring consistent code styling by creating a new branch for review when necessary. It simplifies integrating Prettier into your workflow, although updates to workflow YAML files in `.github/workflows/` must be done manually.
 
-[Unreleased]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.3...HEAD
+[Unreleased]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.4...HEAD
+[1.1.4]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.3...v1.1.4?w=1
 [1.1.3]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.2...v1.1.3?w=1
 [1.1.2]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.1...v1.1.2?w=1
 [1.1.1]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.0...v1.1.1?w=1

README.md

@@ -34,16 +34,18 @@ permissions:
 
 ### Inputs (all optional)
 
-| Input                | Description                                                                    | Type    | Default                                  |
-| -------------------- | ------------------------------------------------------------------------------ | ------- | ---------------------------------------- |
-| `commit-changes`     | If `true`, commits changes to the current branch instead of creating a new one | Boolean | `false`                                  |
-| `commit-message`     | Commit message for the changes                                                 | String  | `"Prettier fixes applied automatically"` |
-| `node-version`       | Node.js version to use                                                         | String  | `"20"`                                   |
-| `skip-package-setup` | If `true`, skips `npm init` and dependency installation steps                  | Boolean | `false`                                  |
+| Input                  | Description                                                                    | Type    | Default                                  |
+| ---------------------- | ------------------------------------------------------------------------------ | ------- | ---------------------------------------- |
+| `commit-changes`       | If `true`, commits changes to the current branch instead of creating a new one | Boolean | `false`                                  |
+| `commit-message`       | Commit message for the changes                                                 | String  | `"Prettier fixes applied automatically"` |
+| `debug`                | Enable extra debug output (list of branches).                                  | Boolean | `false`                                  |
+| `node-version`         | Node.js version to use                                                         | String  | `"20"`                                   |
+| `prettier-config-path` | Optional path to a custom Prettier config file                                 | String  | `""`                                     |
+| `skip-package-setup`   | If `true`, skips `npm init` and dependency installation steps                  | Boolean | `false`                                  |
 
 Note: it would be possible to use `git-user-name` and `git-user-email` as inputs to set-up the info about the author of the commits, but for clarity [actions/checkout](https://github.com/actions/checkout?tab=readme-ov-file#push-a-commit-using-the-built-in-token) recommends
 
-```
+```bash
   git config user.name "github-actions[bot]"
   git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
 ```
@@ -52,9 +54,10 @@ Btw: GitHub displays the author's name according to a known email.
 
 ### Outputs
 
-| Output        | Description                         |
-| ------------- | ----------------------------------- |
-| `branch-name` | The name of the branch created/used |
+| Output          | Description                                       |
+| --------------- | ------------------------------------------------- |
+| `branch-name`   | The name of the branch created/used               |
+| `changed-files` | Comma-separated list of files changed by Prettier |
 
 ## Important Note for Workflow YAMLs
 

action.yml

@@ -20,10 +20,19 @@ inputs:
     description: "Commit message for the changes"
     type: string
     default: "Prettier fixes applied automatically"
+  debug:
+    description: "Enable extra debug output"
+    type: boolean
+    default: false
   node-version:
     description: "Node.js version to use"
     type: string
     default: "20"
+  prettier-config-path:
+    description: "Optional path to a custom Prettier config file"
+    type: string
+    required: false
+    default: ""
   skip-package-setup:
     description: "If true, skip npm initialization and installation"
     type: boolean
@@ -32,6 +41,8 @@ inputs:
 outputs:
   branch-name:
     description: "The branch where changes were committed"
+  changed-files:
+    description: "Comma-separated list of files changed by Prettier"
 
 runs:
   using: "composite"
@@ -72,7 +83,11 @@ runs:
 
         echo "Running Prettier..."
         npx prettier -v
-        npx prettier --write .
+        if [ -n "${{ inputs.prettier-config-path }}" ]; then
+          npx prettier --config "${{ inputs.prettier-config-path }}" --write .
+        else
+          npx prettier --write .
+        fi
 
         if [ "$CREATED_PACKAGE_JSON" == "true" ]; then
           echo "Cleaning up temporary files..."
@@ -85,6 +100,17 @@ runs:
     - name: Determine Branch Name
       id: set-branch
       run: |
+        if [ "${{ inputs.debug }}" = "true" ]; then
+          echo "Debug 1. List All Local Branches"
+          git branch
+          echo "Debug 2. List All Remote Branches"
+          git branch -r
+          echo "Debug 3. List All References (Including Detached HEADs)"
+          git show-ref
+          echo "Debug 4. Check Your Current Checked-out Reference"
+          git status
+        fi
+
         if [ "${{ inputs.commit-changes }}" == "true" ]; then
           BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD 2>/dev/null)
           if [ "$BRANCH_NAME" == "HEAD" ] || [ -z "$BRANCH_NAME" ]; then
@@ -104,32 +130,26 @@ runs:
           NOTICE_MESSAGE="A Prettier commit was added to the new branch: $BRANCH_NAME"
         fi
 
-        #debug error: src refspec notest/2502 does not match any
-        echo "Debug 1. List All Local Branches"
-        git branch
-        echo "Debug 2. List All Remote Branches"
-        git branch -r
-        echo "Debug 3. List All References (Including Detached HEADs)"
-        git show-ref
-        echo "Debug 4. Check Your Current Checked-out Reference"
-        git status
-        #/debug
-
         echo "Branch Determined::Using branch $BRANCH_NAME"
         echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV
         echo "NOTICE_MESSAGE=$NOTICE_MESSAGE" >> $GITHUB_ENV
       shell: bash
 
     - name: Commit and Push Changes if Any
+      id: commit-push
       run: |
+        CHANGED_FILES=""
         if [ -z "$(git status --porcelain)" ]; then
           echo "No changes detected by Prettier. Exiting gracefully."
+          # This sets the output named branch-name to an empty value. Which is useful to signal “no branch was created” in a way that downstream steps can detect reliably.
+          echo "branch-name=" >> $GITHUB_OUTPUT
+          echo "changed-files=" >> $GITHUB_OUTPUT
           exit 0
           # The rest of the script must be within the same step to really stop the execution
         fi
 
-        # Stage only non-workflow files
-        git add $(git diff --name-only | grep -vE '^.github/workflows/')
+        # Only add changed non-workflow files, safe for spaces
+        git status --porcelain | awk '{print $2}' | grep -vE '^.github/workflows/' | while IFS= read -r file; do git add "$file"; done
 
         # Check for changes in workflow files (unstaged changes) - to be fixed manually
         for file in .github/workflows/*.yml; do
@@ -143,12 +163,16 @@ runs:
         # Re-check after exclusions
         if [ -z "$(git status --porcelain)" ]; then
           echo "No editable changes detected by Prettier. Exiting gracefully."
+          echo "branch-name=" >> $GITHUB_OUTPUT
+          echo "changed-files=" >> $GITHUB_OUTPUT
           exit 0
           # The rest of the script must still be within the same step to really stop the execution
         fi
 
         if [ -z "${{ env.BRANCH_NAME }}" ]; then
           echo "::error title=Detached HEAD::No valid branch found, skipping commit."
+          echo "branch-name=" >> $GITHUB_OUTPUT
+          echo "changed-files=" >> $GITHUB_OUTPUT
           exit 1
         fi
 
@@ -158,12 +182,18 @@ runs:
 
         # Commit and push changes with custom message
         git commit -m "${{ inputs.commit-message }} on $(date +'%Y-%m-%d %H:%M:%S') UTC"
+
         echo "::notice title=Prettier commit adding::${{ env.NOTICE_MESSAGE }}"
         git push origin "${{ env.BRANCH_NAME }}"
 
         COMMIT_URL=${{ github.server_url }}/${{ github.repository }}/commit/$(git rev-parse HEAD)
         echo "::notice title=View the Prettier commit::${COMMIT_URL}"
 
-        # Set branch name as output
+        # Set outputs
+        CHANGED_FILES=$(git diff-tree --no-commit-id --name-only -r HEAD | tr '\n' ',' | sed 's/,$//')
         echo "branch-name=${{ env.BRANCH_NAME }}" >> $GITHUB_OUTPUT
+        echo "changed-files=${CHANGED_FILES}" >> $GITHUB_OUTPUT
+        if [ "${{ inputs.debug }}" = "true" ]; then
+          echo "changed-files=${CHANGED_FILES}"
+        fi
       shell: bash