brzuchal/stop-the-war

PHP_CodeSniffer 规则,添加不可折叠的注释以呼吁停止战争

安装: 3

依赖项: 0

建议者: 0

安全: 0

星级: 1

关注者: 3

分支: 0

开放问题: 0

类型:phpcodesniffer-standard

v1.0.0 2022-03-06 19:08 UTC

This package is auto-updated.

Last update: 2024-09-07 10:49:52 UTC


README

Tests

给俄罗斯人的信息 🇷🇺

如果您目前居住在俄罗斯,请阅读此信息

目的

一个停止战争的嗅探器,在源代码文件中添加不可折叠的注释以呼吁停止战争。

SWUbanner

安装

composer require brzuchal/stop-the-war

用法

基本用法只是添加通用的 #StopTheWar 注释,最低配置要求是包含 StopTheWar 规则,如下所示

<?xml version="1.0"?>
<!-- phpcs.xml.dist -->
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
    <rule ref="StopTheWar"/>
</ruleset>

结果是在没有其他文本的情况下添加停止战争注释,如下所示

// Do not be silent! #StopWar 
class MyService
{
}

但是,如果您想推广任何类型的扩展注释,请定义一个名为 commentExtension 的规则属性,例如

<?xml version="1.0"?>
<!-- phpcs.xml.dist -->
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
    <rule ref="StopTheWar">
        <properties>
            <property name="commentExtension" value="🇺🇦 #StandWithUkraine #StopPutin"/>
        </properties>
    </rule>
</ruleset>

结果是在每个类、接口、特质、枚举之前添加注释,如下所示

// Do not be silent! #StopWar 🇺🇦 #StandWithUkraine #StopPutin
class MyService
{
}

许可证

MIT 许可证

版权所有 (c) 2022 Michał Marcin Brzuchalski

特此授予任何获得此软件及其相关文档副本(以下简称“软件”)的人免费使用权,不受任何限制,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件的副本,并允许向软件提供方使用软件的人这样做,前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供,不提供任何形式的保证,明示或暗示,包括但不限于适销性、适用于特定目的和非侵权性保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任负责,无论是基于合同、侵权或其他原因,无论是否与软件或软件的使用或其他方式有关。