README.md

PHP Static Analysis in Github Actions for WordPress.

PHPStan finds bugs in your code without writing tests by using running static analysis on your project's code. This fork of the official phpstan action uses the WordPress extension for PHPStan by Viktor Szépe.

This package was forked from the original phpstan action.

Usage

Create your GitHub Workflow configuration in .github/workflows/ci.yml or similar.

name: CI

on: [push]

jobs:
  build-test:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: ramsey/composer-install@v2 # or alternative dependency management
    - uses: dingo-d/phpstan-wp-action@v2
    # ... then your own project steps ...

Commands

By default, adding - uses: dingo-d/phpstan-wp-action@v2 into your workflow will run phpstan analyse, as analyse is the default command name.

You can issue custom commands by passing a command input, like so:

jobs:
  phpstan:

    ...

    - name: PHPStan
      uses: dingo-d/phpstan-wp-action@v2
      with:
        command: your-command-here

Inputs

The following configuration options are available:

• configuration Path to the project configuration file
• level Level of rule options - the higher the stricter
• paths_file Path to a file with a list of paths to run analysis on
• autoload_file Project's additional autoload file path
• error_format Format in which to print the result of the analysis
• generate_baseline Path to a file where the baseline should be saved
• memory_limit Memory limit for analysis

The syntax for passing in a custom input is the following:

...

jobs:
  phpstan:

    ...

    - name: PHPStan Static Analysis
      uses: dingo-d/phpstan-wp-action@v2
      with:
        configuration: custom/path/to/phpstan.neon
        memory_limit: 256M