README

这个包是为了更准确地检查文件而设计的

安装

composer global require mayesto/csl

ln -s ~/.composer/vendor/bin/csl /usr/bin

使用方法

检查命令

csl check ./src --yaml=./config.yml

运行选项

--format=value      Output format. Possible values: table, json
--yaml=filepath     Select config file in yaml format
-s|--short          Short file path on result
-vvv                Debug mode

特性

• 完整的可配置规则库存
• 完整的可配置文件来源。选项：扫描目录，Git已修改文件

规则

• ClassAuthorPattern - 使用正则表达式检查类作者
• ClassAuthorRequire - 至少需要一个类作者
• ClassMethodPhpDoc - 检查方法是否有PHP文档
• ClassMethodPhpDocEmptyLineBeforeReturn - 检查方法PHP文档是否有无效的空行
• ClassPhpDoc - 检查类是否有PHP文档
• ClassPhpDocPropertyRequire - 检查类的PHP文档是否有一个属性
• InternalFunctionNamespace - 查找所有原生函数调用并检查它们是否有完全命名空间
• MethodReturnTypeRequire - 查找所有没有返回类型转换的方法
• ParserValidation - 基本解析器验证
• TooMuchEmptyLines - 扫描文件并报告过多的空行
• EmptyLineOnEndOfFile - 检查文件是否在文件末尾有空行

配置文件

目前只支持yaml格式的文件配置！

文件示例

fileIterator: Mayesto\CSL\FileIterator\Git # Name of iterator class
rules: # Array of rules
  Mayesto\CSL\Rule\ParserValidation:

  Mayesto\CSL\Rule\ClassAuthorPattern:
    arguments:
      - '.*?<name@example.com>'

  Mayesto\CSL\Rule\ParserValidation:

  Mayesto\CSL\Rule\InternalFunctionNamespace:

  Mayesto\CSL\Rule\ClassPhpDoc:

  Mayesto\CSL\Rule\MethodReturnTypeRequire:

  Mayesto\CSL\Rule\ClassAuthorRequire:

  Mayesto\CSL\Rule\TooMuchEmptyLines:
    arguments:
      - 2 # Number of empty lines generating an error. Default: 2
      
  Mayesto\CSL\Rule\ClassMethodPhpDocEmptyLineBeforeReturn:

  Mayesto\CSL\Rule\EmptyLineOnEndOfFile:
  
  TestRule:
    file: /home/user/TestRule.php # Class which implements RuleInterface

许可证

• MIT

作者

这个包是由Mayesto制作的。如果您有任何问题，请给我发送电子邮件。m@mayesto.pl