mteu/docblock-rules

PHPStan 的几个附加规则

维护者

详情

github.com/mteu/docblock-rules

源代码

问题

安装次数: 9,886

依赖项: 3

建议者: 0

安全性: 0

星级: 0

关注者: 2

分支: 0

开放问题: 2

类型:phpstan-extension

0.3.1 2024-08-19 08:03 UTC

Requires

Requires (Dev)

GPL-3.0-or-later 9e4958a5bd07e60b6d2d261a2f2288b2ba4709a4

This package is auto-updated.

Last update: 2024-09-19 13:41:59 UTC

README

CGL Tests

DocBlock 规则

DocBlock 规则 是一个简单的 PHPStan 规则扩展，用于验证 PHP 文件是否包含某些预定义的字符串。

⚡ 使用方法

需要安装此包，并确保根据您的需求配置 PHPStan，在项目中放置一个配置文件（例如，在包根目录中作为 phpstan.neon 文件）。

composer require --dev mteu/docblock-rules

如果您使用的是 phpstan/extension-installer，则一切正常。

配置

此包包含需要额外配置的自定义规则

RequireCopyrightInformationInFirstCommentRule

此规则检查是否存在包含由 PHPStan 配置中标识的针字符串的版权信息的 PHPDoc 注释块。

示例配置

# phpstan.neon

parameters:
    docblock:
        copyrightIdentifier: 'Copyright (C) 2023'

RequireLicenseInformationInFirstCommentRule

此规则检查是否存在包含许可证信息的 PHPDoc 注释块。您可以使用预定义的许可证检查值或定义一个要查找的自定义字符串。

示例配置

# phpstan.neon

parameters:
    docblock:
        # Pre-configured checks when applying 'GPL-2.0' or 'GPL-3.0' as value.
        # Alternatively, use a custom string to look for in the file.
        requiredLicenseIdentifier: 'GPL-3.0'

💛 致谢

我要感谢创建、维护和赞助 PHPStan 的好人。谢谢 Ondřej 和所有贡献者！

⭐ 许可证

本项目采用 GNU 通用公共许可证 3.0（或更高版本） 许可。