Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

484: Add warning about Psalm baseline to readme + functional test #489

Open
wants to merge 11 commits into
base: 1.35.x
Choose a base branch
from
Open
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@
vendor/bin/roave-infection-static-analysis-plugin
```

Do not use this tool if your project has a

Check failure on line 28 in README.md

View workflow job for this annotation

GitHub Actions / QA Checks (README Linting [8.1, locked], ubuntu-latest, laminas/laminas-continuous-integration-ac...

Trailing spaces [Expected: 0 or 2; Actual: 1]
[Psalm baseline](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file) file. In that
case issues that are ignored due to being present in the baseline will be reported as killed, spuriously inflating your

Check failure on line 30 in README.md

View workflow job for this annotation

GitHub Actions / QA Checks (README Linting [8.1, locked], ubuntu-latest, laminas/laminas-continuous-integration-ac...

Trailing spaces [Expected: 0 or 2; Actual: 1]
mutation score indicator. See [issue #484](https://github.com/Roave/infection-static-analysis-plugin/issues/484).

### Configuration

The `roave-infection-static-analysis-plugin` binary accepts all of `infection` flags and arguments, and an additional `--psalm-config` argument.
Expand Down
1 change: 1 addition & 0 deletions test/asset/ProjectWithPsalmBaseline/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.phpunit.cache
25 changes: 25 additions & 0 deletions test/asset/ProjectWithPsalmBaseline/composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "acme/project-with-psalm-baseline",
"description": "Example hellow world app that uses a Psalm baseline",
"type": "project",
"autoload": {
"psr-4": {
"Acme\\ProjectWithPsalmBaseline\\": "src/"
}

},
"_comment": "Depending on the published version of ISAP is not great here, we should be testing against the version that exists locally. I had trouble getting that to work.",
"require-dev": {
"vimeo/psalm": "^5.16",
"phpunit/phpunit": "^10.5.1",
"roave/infection-static-analysis-plugin": "*"
},
"config": {
"platform": {
"php": "8.1.99"
},
"allow-plugins": {
"infection/extension-installer": true
}
}
}