dngbphalcon-coding-standard

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

dev-master 2018-08-15 13:46 UTC

This package is not auto-updated.

Last update: 2024-09-29 05:48:33 UTC


README

一个用于检查Phalcon编码标准的编码规范(略有修改)。

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

项目分支自:(https://github.com/karen-nalbandian/phalcon-coding-standard)+排除NamingConventions.ValidVariableName.NotCamelCaps

差异

以下标准已被修改

  • 添加了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
  • 删除了Zend.NamingConventions.ValidVariableName.NotCamelCaps
  • 删除了Generic.Files.LineEndings.InvalidEOLChar

安装

Composer

此标准可以通过Composer依赖管理器安装。

  1. 安装Composer

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

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

     vendor/bin/phpcs --config-set installed_paths vendor/dngb/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/dngb/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