clivern/phpcs

PHP 编码规范。

1.0.2 2021-06-27 20:57 UTC

This package is auto-updated.

Last update: 2024-09-19 03:32:45 UTC


README

phpcs logo

PHP 编码规范

文档

安装

要通过 composer 安装此包,请使用以下命令

$ composer require clivern/phpcs --dev

在项目的根目录放置一个名为 .php-cs-fixer.dist.php 的文件,该文件包含以下内容。

<?php

declare(strict_types=1);

use Clivern\CodingStandards\Rules;
use PhpCsFixer\Config;
use PhpCsFixer\Finder;


$fileHeaderComment = <<<COMMENT
This file is part of Clivern/phpcs - PHP Coding Standards
(c) Clivern <hello@clivern.com>
COMMENT;

$finder = Finder::create()
    ->name('.php_cs.dist')
    ->in(__DIR__)
    ->exclude('vendor');

$overrides = [
    'declare_strict_types' => true,
];

return (new Config())
    ->setFinder($finder)
    ->setRiskyAllowed(true)
    ->setRules(Rules::PHP72($fileHeaderComment, $overrides));

版本控制

为了提高发布周期的透明度并努力保持向下兼容性,phpcs 依据 语义化版本控制指南 维护,发布流程是可预测的并且对企业友好。

请查看我们 GitHub 项目的 发布部分 以获取 phpcs 每个版本发布版本的变化日志。它包含了对每个发布版本中做出的最重要更改的总结。

错误追踪器

如果您有任何建议、错误报告或不满,请通过我们的 问题跟踪器 报告,链接:https://github.com/clivern/phpcs/issues

安全问题

如果您在 phpcs 中发现任何安全漏洞,请发送电子邮件至 hello@clivern.com

贡献

我们是一个开源、社区驱动的项目,因此请随时加入我们。有关更多详细信息,请参阅 贡献指南

许可证

© 2021, clivern. 在 MIT 许可证 下发布。

phpcs@clivern 编写和维护。