valkyrja/phpstan
Composer 安装命令：
composer create-project valkyrja/phpstan
包简介
PHPStan for the Valkyrja Project.
关键字：
README 文档
README
Valkyrja PHPStan
Shared PHPStan configuration for Valkyrja PHP projects — a reference configuration and reusable workflow that enforce consistent static analysis across consuming repositories.
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/ci-phpstan-php/.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.
Contributing
See CONTRIBUTING.md for the submission process and
VOCABULARY.md for the terminology used across Valkyrja.
Security Issues
If you discover a security vulnerability, please follow our disclosure procedure.
License
Licensed under the MIT license. See
LICENSE.md.
统计信息
- 总下载量： 2.29k
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 0
- 点击次数： 2
- 依赖项目数： 0
- 推荐数： 0
其他信息
- 授权协议： MIT
- 更新时间： 2026-04-16