phpyh/psalm-tester

通过 phpt 文件测试 Psalm!

0.1.0 2024-01-24 17:42 UTC

This package is auto-updated.

Last update: 2024-08-25 12:26:47 UTC


README

通过 phpt 文件测试 Psalm!

Latest Stable Version Total Downloads psalm-level type-coverage

安装

composer require --dev phpyh/psalm-tester

基本用法

1. 编写一个 phpt 格式的测试

tests/array_values.phpt

--FILE--
<?php

/** @psalm-trace $_list */
$_list = array_values(['a' => 1, 'b' => 2]);

--EXPECT--
Trace on line 9: $_list: non-empty-list<1|2>

为了避免硬编码错误详情,可以使用 EXPECTF

--EXPECTF--
Trace on line %d: $_list: non-empty-list<%s>

2. 添加一个测试套件

tests/PsalmTest.php

<?php

use PHPUnit\Framework\Attributes\TestWith;
use PHPUnit\Framework\TestCase;
use PHPyh\PsalmTester\PsalmTester;
use PHPyh\PsalmTester\StaticAnalysisTest;

final class PsalmTest extends TestCase
{
    private ?PsalmTester $psalmTester = null;

    #[TestWith([__DIR__ . '/array_values.phpt'])]
    public function testPhptFiles(string $phptFile): void
    {
        $this->psalmTester ??= PsalmTester::create();
        $this->psalmTester->test(StaticAnalysisTest::fromPhptFile($phptFile));
    }
}

向 Psalm 传递不同的参数

默认情况下,PsalmTester 使用 --no-progress --no-diff --config=psalm.xml 运行 Psalm。

您可以在 PsalmTester 级别更改此设置

use PHPyh\PsalmTester\PsalmTester;

PsalmTester::create(
    defaultArguments: '--no-progress --no-cache --config=my_default_config.xml',
);

或使用 --ARGS-- 部分为每个测试单独设置

--ARGS--
--no-progress --config=my_special_config.xml
--FILE--
...
--EXPECT--
...