worksome/pretty-pest

自动格式化你的Pest PHP测试。

维护者

详细信息

github.com/worksome/pretty-pest

源代码

问题

安装数: 354,968

依赖者: 1

建议者: 0

安全: 0

星标: 6

关注者: 15

分支: 1

开放问题: 0

类型:phpcodesniffer-standard

v0.2.2 2024-02-08 20:17 UTC

Requires

Requires (Dev)

MIT 4e54ca4f80add5829844dc62a262ccc1b9038b5c

  • Luke Downing <lukeraymonddowning.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-08 21:36:22 UTC

README

强制为你的Pest PHP测试执行一致的样式！

Tests

作为一个开发者，有很多重要的决定需要担心。你知道你不需要担心的是什么吗？测试的顺序！但是，你仍然希望你的测试看起来很漂亮，对吧？

这就是为什么我们创建了Pretty Pest。这个代码风格插件确保你的Pest测试会自动正确格式化，这样你就不必花时间手动做这件事了。

安装

你可以通过Composer安装这个包。

composer require worksome/pretty-pest --dev

PHPCBF

你可以在PHPCBF中启用Pretty Pest，通过将PrettyPest规则添加到你的phpcs.xml文件中。

<rule ref="PrettyPest"/>

Pretty Pest为PHPCBF提供了2个嗅探器

  • EnsureTestFunctionsAreOrdered
  • NewLineAfterTestFunctions

EnsureTestFunctionsAreOrdered

这个嗅探器将确保你的Pest函数在测试文件中按正确顺序排列。默认情况下，我们使用以下顺序

[
    'uses',
    'beforeAll',
    'beforeEach',
    'afterEach',
    'afterAll',
    // The array syntax indicates that `test` and `it` are to be treated as the same function.
    ['test', 'it'],
    'dataset',
]

任何顺序错误的函数都将移到文件中。当然，你可以在phpcs.xml文件中始终覆盖此顺序到你的偏好。

<rule ref="PrettyPest.Formatting.EnsureFunctionsAreOrdered">
    <properties>
        <property name="order" type="array">
            <element value="uses"/>
            <element value="beforeAll"/>
            <element value="beforeEach"/>
            <element value="test"/>
            <element value="it"/>
            <element value="dataset"/>
            <element value="afterEach"/>
            <element value="afterAll"/>
        </property>
    </properties>
</rule>

NewLineAfterTestFunctions

这个嗅探器将替换Pest函数后的所有空白为一个单独的新行，以确保你的测试文件中的间距一致。

更新日志

请参阅更新日志以获取有关最近更改的更多信息。

鸣谢

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。