code-standards.yml

name: PHP Code Standards

on:
  workflow_call:
    inputs:
      version:
        type: string
        default: "^3.0"
      config:
        type: string
        default: ""
      path:
        type: string
        default: "."
      rules:
        type: string
        default: |
          {
            "@PSR2": true,
            "array_syntax": {"syntax":"short"},
            "concat_space": {"spacing":"one"},
            "new_with_parentheses": true,
            "no_unused_imports": true,
            "ordered_imports": true,
            "return_type_declaration": {"space_before": "none"},
            "single_quote": true,
            "single_space_around_construct": true,
            "cast_spaces": true,
            "whitespace_after_comma_in_array": true,
            "no_whitespace_in_blank_line": true,
            "binary_operator_spaces": {"default": "at_least_single_space"},
            "no_extra_blank_lines": true,
            "nullable_type_declaration_for_default_null_value": true
          }
      add-rules:
        type: string
        default: "{}"
      exclude-patterns:
        type: string
        default: ""

permissions:
  contents: read

jobs:
    php_code_standards:
      runs-on: ubuntu-latest
      name: PHP Code Standards
      env:
        CONFIG: ${{ inputs.config }}
        CONFIG_PATH: ${{ inputs.path }}
      steps:
      - uses: actions/checkout@v4
      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.2'
      # install Google Cloud Tools if a config is provided which starts with "GoogleCloudPlatform/php-tools/"
      - if: ${{ startsWith(inputs.config, 'GoogleCloudPlatform/php-tools/') }}
        name: Install Google Cloud Tools
        run: |
          BRANCH=${CONFIG#GoogleCloudPlatform/php-tools/}
          composer global require google/cloud-tools:dev-${BRANCH#*@} -q
          echo "CONFIG=$HOME/.composer/vendor/google/cloud-tools/${BRANCH%@*}" >> $GITHUB_ENV
      - name: 'Setup jq'
        uses: dcarbone/install-jq-action@v2
      - name: Install PHP CS Fixer
        run: composer global require friendsofphp/php-cs-fixer:${INPUTS_VERSION}
        env:
          INPUTS_VERSION: ${{ inputs.version }}
      - name: Run PHP CS Fixer
        run: |
          # set environment variables in script
          export RULES=$(echo ${INPUTS_RULES} ${INPUTS_ADD_RULES}|tr -d '\n\t\r '|jq -s '.[0] * .[1]' -crM)
          export EXCLUDE_PATTERNS=$(echo ${INPUTS_EXCLUDE_PATTERNS}|tr -d '\n\t\r ')

          # use config path only if EXCLUDE_PATTERN is empty
          CMD_PATH=$([ "$EXCLUDE_PATTERNS" = "" ] && echo "$CONFIG_PATH" || echo "")
          CONFIG_OR_RULES=$([ ! -z "$CONFIG" ] && echo "--config=$CONFIG" || echo --rules=$RULES)

          # do not fail if php-cs-fixer fails (so we can print debugging info)
          set +e

          ~/.composer/vendor/bin/php-cs-fixer fix \
            $CMD_PATH \
            $CONFIG_OR_RULES \
            --dry-run --diff

          if [ "$?" -ne 0 ]; then
            echo "Run this script locally by executing the following command" \
                 "from the root of your ${{ github.repository }} repo:"
            echo ""
            echo "    composer global require google/cloud-tools"
            echo "    ~/.composer/vendor/bin/php-tools cs-fixer ${{ github.repository }} --ref ${{ github.head_ref || github.ref_name }}"
            echo ""
            exit 1
          fi
        env:
          INPUTS_RULES: ${{ inputs.rules }}
          INPUTS_ADD_RULES: ${{ inputs.add-rules }}
          INPUTS_EXCLUDE_PATTERNS: ${{ inputs.exclude-patterns }}