ramsey/coding-standard

Ramsey PHP 库的共同编码标准。

支持包维护!
ramsey

安装次数: 58,296

依赖: 28

建议者: 0

安全: 0

星标: 8

关注者: 3

分支: 3

开放问题: 0

类型:phpcodesniffer-standard

2.2.0 2023-03-18 01:41 UTC

README

这是为 @ramsey 的 PHP 库提供的共同编码标准。

Source Code Download Package PHP Programming Language Read License Build Status

关于

这是一个为 PHP_CodeSniffer 定制的编码标准。它从 Slevomat Coding StandardPHPCSExtra 中借鉴了许多嗅探器,并将它们合并为单个统一、共同的编码标准,适用于 @ramsey's PHP 库。

本项目遵循 行为准则。通过参与本项目及其社区,您应遵守此准则。

安装

使用 Composer 将此包作为开发依赖项安装。

composer require --dev ramsey/coding-standard

使用方法

要使用此编码标准,请将 <rule ref="Ramsey"/> 添加到您的 phpcs.xml 配置文件中。

以下是您可以将示例 phpcs.xml.dist 文件放置在存储库根目录的内容

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

    <arg name="extensions" value="php"/>
    <arg name="colors"/>
    <arg value="sp"/>

    <file>./src</file>
    <file>./tests</file>

    <rule ref="Ramsey"/>

</ruleset>

然后,运行 PHP_CodeSniffer

./vendor/bin/phpcs

贡献

欢迎贡献!要贡献,请熟悉 CONTRIBUTING.md

协调披露

确保用户信息的安全和保密是我们的首要任务,我们欢迎外部安全研究人员做出贡献。如果您认为在维护在本存储库中的软件中发现了一个安全问题,请阅读 SECURITY.md 了解提交漏洞报告的说明。

版权和许可

ramsey/coding-standard 库的版权所有 © Ben Ramsey,并许可在 MIT 许可协议(MIT)的条款下使用。有关更多信息,请参阅 LICENSE