action.yml

name: "StructLint"
description: "Validate and enforce directory structure and file naming patterns"
author: "AxeForging"
inputs:
  config:
    description: "Path to .structlint.yaml config file"
    required: false
    default: ".structlint.yaml"
  path:
    description: "Directory to validate"
    required: false
    default: "."
  json-output:
    description: "Path to write JSON report (empty = no report)"
    required: false
  log-level:
    description: "Log level: debug, info, warn, error"
    required: false
    default: "info"
  silent:
    description: "Silent mode - only exit code, no output"
    required: false
    default: "false"
  version:
    description: "Version of structlint to use (e.g. v0.2.0). Defaults to latest."
    required: false
  comment-on-pr:
    description: "Post validation results as a PR comment (requires pull_request event and GITHUB_TOKEN)"
    required: false
    default: "false"
  GITHUB_TOKEN:
    description: "GitHub token for PR comments (required if comment-on-pr is true)"
    required: false

runs:
  using: "composite"
  steps:
    - name: Download StructLint
      shell: bash
      run: |
        OS="linux"
        ARCH="amd64"
        if [[ "${{ runner.os }}" == "macOS" ]]; then OS="darwin"; fi
        if [[ "${{ runner.arch }}" == "ARM64" ]]; then ARCH="arm64"; fi

        VERSION="${{ inputs.version }}"
        if [ -z "$VERSION" ]; then
          VERSION="${{ github.action_ref }}"
        fi
        if [ -z "$VERSION" ] || [ "$VERSION" == "main" ]; then
          # Fetch latest release tag
          VERSION=$(curl -sS -o /dev/null -w '%{redirect_url}' \
            "https://github.com/AxeForging/structlint/releases/latest" | grep -oP '[^/]+$')
          echo "Resolved latest version: ${VERSION}"
        fi

        URL="https://github.com/AxeForging/structlint/releases/download/${VERSION}/structlint-${OS}-${ARCH}.tar.gz"
        echo "Downloading structlint ${VERSION} from ${URL}..."
        curl -sSL "$URL" -o /tmp/structlint.tar.gz
        tar -xzf /tmp/structlint.tar.gz -C /tmp
        chmod +x /tmp/structlint
        echo "structlint ${VERSION} installed successfully"

    - name: Run StructLint
      id: validate
      shell: bash
      run: |
        ARGS="validate --config ${{ inputs.config }} --json-output /tmp/structlint-report.json"

        if [ "${{ inputs.path }}" != "." ]; then
          ARGS="${ARGS} --path ${{ inputs.path }}"
        fi

        if [ "${{ inputs.log-level }}" != "info" ]; then
          ARGS="${ARGS} --log-level ${{ inputs.log-level }}"
        fi

        if [ "${{ inputs.silent }}" == "true" ]; then
          ARGS="${ARGS} --silent"
        fi

        EXIT_CODE=0
        /tmp/structlint ${ARGS} || EXIT_CODE=$?

        # Copy to user-specified path if requested
        if [ -n "${{ inputs.json-output }}" ]; then
          cp /tmp/structlint-report.json "${{ inputs.json-output }}"
        fi

        echo "exit_code=${EXIT_CODE}" >> "$GITHUB_OUTPUT"

    - name: Generate Summary
      if: always()
      shell: bash
      env:
        CONFIG_PATH: ${{ inputs.config }}
        RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
      run: |
        REPORT="/tmp/structlint-report.json"
        if [ ! -f "$REPORT" ]; then
          echo "No report file found, skipping summary."
          exit 0
        fi

        SUCCESSES=$(jq -r '.successes' "$REPORT")
        FAILURES=$(jq -r '.failures' "$REPORT")
        TOTAL=$((SUCCESSES + FAILURES))

        {
          if [ "$FAILURES" -eq 0 ]; then
            echo "## StructLint — All checks passed"
            echo ""
            echo "**${SUCCESSES}** rules validated against \`${CONFIG_PATH}\`. No violations found."
          else
            echo "## StructLint — ${FAILURES} violation(s) found"
            echo ""
            echo "**${SUCCESSES}**/${TOTAL} rules passed · **${FAILURES}** violation(s) detected against \`${CONFIG_PATH}\`."
            echo ""

            # Render each violation category
            jq -r '.summary.violations[]? | @json' "$REPORT" | while IFS= read -r v; do
              DESC=$(echo "$v" | jq -r '.description')
              COUNT=$(echo "$v" | jq -r '.count')
              EXAMPLES=$(echo "$v" | jq -r '.examples[]?')
              EXAMPLE_COUNT=$(echo "$v" | jq -r '.examples | length')

              echo "<details>"
              echo "<summary><strong>${DESC}</strong> (${COUNT})</summary>"
              echo ""
              echo "$EXAMPLES" | while IFS= read -r ex; do
                echo "- \`${ex}\`"
              done
              if [ "$COUNT" -gt "$EXAMPLE_COUNT" ]; then
                REMAINING=$((COUNT - EXAMPLE_COUNT))
                echo "- _…and ${REMAINING} more_"
              fi
              echo ""
              echo "</details>"
              echo ""
            done
          fi

          echo "---"
          echo "<sub><a href=\"${RUN_URL}\">View full run</a> · Powered by <a href=\"https://github.com/AxeForging/structlint\">StructLint</a></sub>"
        } > /tmp/structlint-md.tmp

        MD=$(cat /tmp/structlint-md.tmp)

        # Write to job summary
        echo "$MD" >> "$GITHUB_STEP_SUMMARY"

        # Save for PR comment step
        echo "$MD" > /tmp/structlint-comment.md

    - name: Comment on PR
      if: always() && inputs.comment-on-pr == 'true' && github.event_name == 'pull_request'
      shell: bash
      env:
        GH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
      run: |
        if [ ! -f /tmp/structlint-comment.md ]; then
          echo "No comment file found, skipping."
          exit 0
        fi

        PR_NUMBER="${{ github.event.pull_request.number }}"
        REPO="${{ github.repository }}"
        COMMENT_TAG="<!-- structlint-report -->"
        BODY="$(printf '%s\n%s' "$COMMENT_TAG" "$(cat /tmp/structlint-comment.md)")"

        # Check for existing structlint comment to update
        EXISTING_COMMENT_ID=$(gh api "repos/${REPO}/issues/${PR_NUMBER}/comments" \
          --jq ".[] | select(.body | startswith(\"${COMMENT_TAG}\")) | .id" 2>/dev/null | head -1)

        if [ -n "$EXISTING_COMMENT_ID" ]; then
          gh api "repos/${REPO}/issues/comments/${EXISTING_COMMENT_ID}" \
            -X PATCH -f body="$BODY"
          echo "Updated existing PR comment."
        else
          gh api "repos/${REPO}/issues/${PR_NUMBER}/comments" \
            -X POST -f body="$BODY"
          echo "Created new PR comment."
        fi

    - name: Exit with validation result
      if: always()
      shell: bash
      run: exit ${{ steps.validate.outputs.exit_code }}