galsd/courierist-coding-standard

Courierist代码的通用编码规范。

安装: 70

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 3

开放问题: 0

类型:phpcodesniffer-standard

dev-main 2024-03-14 18:29 UTC

This package is not auto-updated.

Last update: 2024-09-26 16:26:47 UTC


README

针对Courierist PHP代码的通用编码规范。

Source Code Download Package PHP Programming Language Read License Build Status

关于

这是一个从ramsey/coding-standard分支出来的项目。该项目被采纳并专门用于Courierist团队。

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

安装

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

composer require --dev galsd/courierist-coding-standard dev-main

使用方法

要使用此编码规范,请将 <rule ref="Courierist"/> 添加到您的 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="Courierist"/>

</ruleset>

然后运行PHP_CodeSniffer

./vendor/bin/phpcs

贡献

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

版权和许可证

galsd/courierist-coding-standard库的版权属于Courierist团队,并按照MIT许可证(MIT)的条款授权使用。有关更多信息,请参阅LICENSE