karen-nalbandian/phalcon-coding-standard

Phalcon编码标准(PCG Cube风味)的CodeSniffer规则集

1.0.2 2018-08-01 08:24 UTC

This package is not auto-updated.

Last update: 2024-09-19 15:09:14 UTC


README

一个检查Phalcon编码标准(https://github.com/framgia/coding-standards/blob/master/eng/php/phalcon.md)的编码标准,略有修改。

重要提示:请谨慎使用这个库,因为它仅供内部使用,并且可能不会得到维护。

差异

以下标准已被修改

  • 添加了Phalcon.Commenting.FunctionComment.MissingParamType
  • 移除了Phalcon.Commenting.FunctionComment.SpacingAfterParamType
  • 移除了Phalcon.Commenting.Annotations.Invalid
  • 移除了Phalcon.Functions.Arguments.Invalid
  • 移除了Squiz.Strings.ConcatenationSpacing.PaddingFound
  • 移除了PSR2.Classes.PropertyDeclaration.Underscore
  • 移除了Zend.NamingConventions.ValidVariableName.ContainsNumbers
  • 移除了Zend.NamingConventions.ValidVariableName.MemberVarContainsNumbers

安装

Composer

可以使用Composer依赖管理器安装此标准。

  1. 安装Composer

  2. 将编码标准作为您项目的依赖项安装

     composer require --dev karen-nalbandian/phalcon-coding-standard:dev-master
    
  3. 将编码标准添加到PHP_CodeSniffer的安装路径

     vendor/bin/phpcs --config-set installed_paths vendor/karen-nalbandian/phalcon-coding-standard
    
  4. 检查已安装的编码标准中的"Phalcon"

     vendor/bin/phpcs -i
    
  5. 完成!

     vendor/bin/phpcs /path/to/code
    

### 独立安装

  1. 安装PHP_CodeSniffer

  2. 检出此仓库

     git clone https://github.com/karen-nalbandian/phalcon-coding-standard.git
    
  3. 将编码标准添加到PHP_CodeSniffer的安装路径

     phpcs --config-set installed_paths /path/to/phalcon-coding-standard
    

    或将此仓库的"Phalcon"-文件夹复制/符号链接到phpcs的Standards目录内

  4. 检查已安装的编码标准中的"Phalcon"

     phpcs -i
    
  5. 完成!

     phpcs /path/to/code