valkyrja/phpstan

PHPStan for the Valkyrja Project.

Maintainers

Package info

github.com/valkyrjaio/phpstan

Homepage

Type:project

pkg:composer/valkyrja/phpstan

Statistics

Installs: 121

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v26.1.1 2026-04-17 03:50 UTC

Requires

MIT f3b678de9c71620572278d9bc09030d5812f00c4

  • Melech Mizrachi <melechmizrachi.woop@gmail.com>

ciPHPStanvalkyrja

This package is auto-updated.

Last update: 2026-04-17 03:52:12 UTC

README

Valkyrja PHPStan

PHPStan configuration for the Valkyrja project.

PHP Version Require Latest Stable Version License Scrutinizer Coverage Status Psalm Shepherd Maintainability Rating

Build Status

Linting PHP Code Sniffer Build Status PHP CS Fixer Build Status
Coding Rules PHPArkitect Build Status Rector Build Status
Static Analysis PHPStan Build Status Psalm Build Status
Testing PHPUnit Build Status

Usage

Run via the root Composer script:

composer phpstan

This delegates to vendor/bin/phpstan --memory-limit=-1 inside the CI directory, using the phpstan.neon configuration.

Configuration

The CI directory ships with a phpstan.neon that serves as the reference configuration. Key settings:

Setting Value Effect
level 9 Strictest level — all rule categories enabled
treatPhpDocTypesAsCertain false PHPDoc types are not blindly trusted; prevents false negatives

Scanned Paths

Path Included
src/ Yes

Baseline

Known issues are tracked in phpstan-baseline.neon. Regenerate it with:

vendor/bin/phpstan --generate-baseline

Bootstrap

An autoload.php is required in the CI directory to bootstrap the project autoloader before PHPStan analyses the source.

Workflows

The _workflow-call.yml reusable workflow runs PHPStan against the calling repository's source. It is designed to be called from other repositories via workflow_call.

Inputs

Input Type Default Description
paths string — Required. YAML filter spec with two keys: ci (CI config files that trigger a base-branch fetch) and files (all files that trigger the check).
post-pr-comment boolean true Post a PR comment on failure and remove it on success. Disable when the calling workflow handles its own reporting.
composer-options string '' Extra flags passed to every composer install step (e.g. --ignore-platform-req=ext-openswoole).
php-version string '8.4' PHP version to use.
ci-directory string '.github/ci/phpstan' Path to the CI directory containing composer.json and the tool config.
extensions string 'mbstring, intl' PHP extensions to install via shivammathur/setup-php.
additional-directory string '' Path to an additional Composer dependencies directory to install before running PHPStan. Leave empty to skip.

Usage

jobs:
  phpstan:
    uses: valkyrjaio/phpstan/.github/workflows/_workflow-call.yml@26.x
    permissions:
      pull-requests: write
      contents: read
    with:
      php-version: '8.4'
      paths: |
        ci:
          - '.github/ci/phpstan/**'
          - '.github/workflows/phpstan.yml'
        files:
          - '.github/ci/phpstan/**'
          - '.github/workflows/phpstan.yml'
          - 'src/**/*.php'
          - 'composer.json'
    secrets: inherit

secrets: inherit is required to pass the VALKYRJA_GHA_APP_ID and VALKYRJA_GHA_PRIVATE_KEY org secrets used for PR comments.