fp-coding-standards/fpcs

此包已被 废弃 并不再维护。未建议替换包。

PHP_CodeSniffer 规则（嗅探器）用于强制执行 FunPlus 编码规范

维护者

详细信息

github.com/funplus/FunPlus-Coding-Standards

源代码

问题

安装: 116

依赖: 2

建议者: 0

安全: 0

星星: 1

关注者: 23

分支: 1

开放问题: 0

v1.1.1 2016-04-21 06:36 UTC

Requires

MIT 93250b113b33c5aad1d35a5edfb3236896cf92e9

  • Zhengkai
  • Junjie.Ning

standardsphpcsFunPlus

This package is not auto-updated.

Last update: 2017-01-30 07:51:26 UTC

README

Build Status

本项目是 PHP_CodeSniffer 规则（嗅探器）的集合，用于验证为 FunPlus 开发的代码。

安装

Composer

可以使用 Composer 依赖管理器安装规范

composer create-project fp-coding-standards/fpcs:dev-master --no-dev

运行此命令将

  1. 将 FunPlus 规范安装到 fpcs 目录。
  2. 安装 PHP_CodeSniffer。
  3. 在 PHP_CodeSniffer 配置中注册 FunPlus 规范。
  4. 使 phpcs 命令从 fpcs/vendor/bin 可用。

为了方便使用 phpcs 作为全局命令，您可能需要将 fpcs/vendor/bin 目录的路径添加到操作系统的 PATH 环境变量中。

独立

  1. 按照其 安装说明（通过 Composer、PEAR 或 Git 检出）安装 PHP_CodeSniffer。

    请确保，例如，如果您正在使用 VVV，则 PHP_CodeSniffer 的版本符合我们的要求（您可以在 composer.json 中检查所需版本）。

  2. 克隆 FunPlus 规范存储库

    git clone -b master https://github.com/funplus/FunPlus-Coding-Standards.git fpcs

  3. 将其路径添加到 PHP_CodeSniffer 配置

    phpcs --config-set installed_paths /path/to/fpcs

总结一下

cd ~/projects
git clone https://github.com/squizlabs/PHP_CodeSniffer.git phpcs
git clone -b master https://github.com/funplus/FunPlus-Coding-Standards.git fpcs
cd phpcs
./scripts/phpcs --config-set installed_paths ../fpcs

然后通过您的 .bashrc 将 ~/projects/phpcs/scripts 目录添加到您的 PATH 环境变量中。

然后运行 phpcs -i 时，您应该会看到 FunPlus 等等。

如何使用

命令行

在指定的文件或目录上运行 phpcs 命令行工具，例如

phpcs --standard=FunPlus somephpfile.php

标准子集

该项目包含 FunPlus 社区可能需要的嗅探器的超集。如果您使用 FunPlus 标准，您将获得所有检查。

在调用 phpcs 以选择符合您需求的嗅探器时，您可以使用以下标准名称

  • FunPlus — 项目中的所有嗅探器。

使用自定义规则集

如果您需要进一步自定义项目中嗅探器的选择，您可以创建自定义的 ruleset.xml 标准文件。请参阅 PHP_CodeSniffer 文档中的 完整注释示例。

许可证

请参阅 LICENSE（MIT）。