phpcs calisthenics rules下载phpcs calisthenics rules源代码下载

php_codesniffer的对象校准规则

弃用：php_codesniffer非常适合处理空间和char位置。然而，这些规则是关于代码架构和结构的。在2020年，有一些非常适合这一点的工具 - phpstan 。

话虽如此，在symplify/phpstan-rules软件包中将对象的健美操作为PHPSTAN规则实现。改用它？

 includes:
    - vendor/symplify/phpstan-rules/packages/object-calisthenics/config/object-calisthenics-rules.neon
    - vendor/symplify/phpstan-rules/packages/object-calisthenics/config/object-calisthenics-services.neon

对象健美操是面向对象的代码中的一组规则，其重点是可维护性，可读性，可检验性和可理解性。我们首先是务实的- 它们易于一起使用或一个一个一个。

为什么要在项目中使用它？

阅读威廉·杜兰德（William Durand）的帖子，或查看Guilherme Blanco的演讲。

安装

composer require object-calisthenics/phpcs-calisthenics-rules --dev

用法

如果您知道想要什么，请直接跳到特定规则：

1。每方法仅x缩进水平
2。请勿使用“ else”关键字
5。每个语句仅使用一个对象操作员（ - >）
6。不要缩写
7.让您的课程小
9。请勿使用Getters和Setter

如何快速检查1规则？

在php_codesniffer中

vendor/bin/phpcs src tests -sp 
--standard=vendor/object-calisthenics/phpcs-calisthenics-rules/src/ObjectCalisthenics/ruleset.xml 
--sniffs=ObjectCalisthenics.Classes.ForbiddenPublicProperty

在EasyCodingStandard中

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsClassesForbiddenPublicPropertySniff : ~

然后

vendor/bin/ecs check src

实施规则嗅探

1。每方法仅`X`缩进水平

 foreach ( $ sniffGroups as $ sniffGroup ) {
    foreach ( $ sniffGroup as $ sniffKey => $ sniffClass ) {
        if (! $ sniffClass instanceof Sniff) {
            throw new InvalidClassTypeException ;
        }
    }
}

？

 foreach ( $ sniffGroups as $ sniffGroup ) {
    $ this -> ensureIsAllInstanceOf ( $ sniffGroup , Sniff::class);
}

// ...
private function ensureIsAllInstanceOf ( array $ objects , string $ type )
{
    // ...
}

仅使用此规则？

在php_codesniffer中：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Metrics.MaxNestingLevel

在ECS中：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsMetricsMaxNestingLevelSniff : ~

？可配置

在php_codesniffer中：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.Metrics.MaxNestingLevel " >
        < properties >
            < property name = " maxNestingLevel " value = " 2 " />
        </ properties >
    </ rule >
</ ruleset >

在ECS中：

 services :
    ObjectCalisthenicsSniffsMetricsMaxNestingLevelSniff :
        maxNestingLevel : 2

2。请勿使用“ else”关键字

 if ( $ status === self :: DONE ) {
    $ this -> finish ();
} else {
    $ this -> advance ();
}

？

 if ( $ status === self :: DONE ) {
    $ this -> finish ();
    return ;
}

$ this -> advance ();

仅使用此规则？

在php_codesniffer中：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.ControlStructures.NoElse

在ECS中：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsControlStructuresNoElseSniff : ~

5。每个语句仅使用一个对象操作员（ `->` ）

 $ this -> container -> getBuilder ()-> addDefinition (SniffRunner::class);

？

 $ containerBuilder = $ this -> getContainerBuilder ();
$ containerBuilder -> addDefinition (SniffRunner::class);

仅使用此规则？

在php_codesniffer中：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.CodeAnalysis.OneObjectOperatorPerLine

在ECS中：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsCodeAnalysisOneObjectOperatorPerLineSniff : ~

？可配置

在php_codesniffer中：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.CodeAnalysis.OneObjectOperatorPerLine " >
        < properties >
            < property name = " variablesHoldingAFluentInterface " type = " array " value = " $queryBuilder,$containerBuilder " />
            < property name = " methodsStartingAFluentInterface " type = " array " value = " createQueryBuilder " />
            < property name = " methodsEndingAFluentInterface " type = " array " value = " execute,getQuery " />
        </ properties >
    </ rule >
</ ruleset >

在ECS中：

 services :
    ObjectCalisthenicsSniffsCodeAnalysisOneObjectOperatorPerLineSniff :
        variablesHoldingAFluentInterface : ["$queryBuilder", "$containerBuilder"]
        methodsStartingAFluentInterface : ["createQueryBuilder"]
        methodsEndingAFluentInterface : ["execute", "getQuery"]

6。不要缩写

这与类，性状，界面，常数，功能和可变名称有关。

 class EM
{
    // ...
}

？

 class EntityMailer
{
    // ...
}

仅使用此规则？

在php_codesniffer中：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.NamingConventions.ElementNameMinimalLength

在ECS中：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsElementNameMinimalLengthSniff : ~

？可配置

在php_codesniffer中：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.NamingConventions.ElementNameMinimalLength " >
        < properties >
            < property name = " minLength " value = " 3 " />
            < property name = " allowedShortNames " type = " array " value = " i,id,to,up " />
        </ properties >
    </ rule >
</ ruleset >

在ECS中：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsElementNameMinimalLengthSniff :
        minLength : 3
        allowedShortNames : ["i", "id", "to", "up"]

7.让您的课程小

 class SimpleStartupController
{
    // 300 lines of code
}

？

 class SimpleStartupController
{
    // 50 lines of code
}

 class SomeClass
{
    public function simpleLogic ()
    {
        // 30 lines of code
    }
}

？

 class SomeClass
{
    public function simpleLogic ()
    {
        // 10 lines of code
    }
}

 class SomeClass
{
    // 20 properties
}

？

 class SomeClass
{
    // 5 properties
}

 class SomeClass
{
    // 20 methods
}

？

 class SomeClass
{
    // 5 methods
}

仅使用此规则？

在php_codesniffer中：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Files.ClassTraitAndInterfaceLength,ObjectCalisthenics.Files.FunctionLength,ObjectCalisthenics.Metrics.MethodPerClassLimit,ObjectCalisthenics.Metrics.PropertyPerClassLimit

在ECS中：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsFilesClassTraitAndInterfaceLengthSniff : ~
    ObjectCalisthenicsSniffsFilesFunctionLengthSniff : ~
    ObjectCalisthenicsSniffsMetricsMethodPerClassLimitSniff : ~
    ObjectCalisthenicsSniffsMetricsPropertyPerClassLimitSniff : ~

？可配置

在php_codesniffer中：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.Files.ClassTraitAndInterfaceLength " >
        < properties >
            < property name = " maxLength " value = " 200 " />
        </ properties >
    </ rule >
    < rule ref = " ObjectCalisthenics.Files.FunctionLength " >
        < properties >
            < property name = " maxLength " value = " 20 " />
        </ properties >
    </ rule >
    < rule ref = " ObjectCalisthenics.Metrics.PropertyPerClassLimit " >
        < properties >
            < property name = " maxCount " value = " 10 " />
        </ properties >
    </ rule >
    < rule ref = " ObjectCalisthenics.Metrics.MethodPerClassLimit " >
        < properties >
            < property name = " maxCount " value = " 10 " />
        </ properties >
    </ rule >
</ ruleset >

在ECS中：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsFilesClassTraitAndInterfaceLengthSniff :
        maxLength : 200
    ObjectCalisthenicsSniffsFilesFunctionLengthSniff :
        maxLength : 20
    ObjectCalisthenicsSniffsMetricsPropertyPerClassLimitSniff :
        maxCount : 10
    ObjectCalisthenicsSniffsMetricsMethodPerClassLimitSniff :
        maxCount : 10

9。请勿使用Getters和Setter

该规则与域驱动的设计部分相关。

课程不应包含公共属性。
方法应表示行为，而不是设置值。

 class ImmutableBankAccount
{
    public $ currency = ' USD ' ;

    private $ amount ;

    public function setAmount ( int $ amount )
    {
        $ this -> amount = $ amount ;
    }
}

？

 class ImmutableBankAccount
{
    private $ currency = ' USD ' ;

    private $ amount ;

    public function withdrawAmount ( int $ withdrawnAmount )
    {
        $ this -> amount -= $ withdrawnAmount ;
    }
}

仅使用此规则？

在php_codesniffer中：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Classes.ForbiddenPublicProperty,ObjectCalisthenics.NamingConventions.NoSetter

在ECS中：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsClassesForbiddenPublicPropertySniff : ~
    ObjectCalisthenicsSniffsNamingConventionsNoSetterSniff : ~

？可配置

在php_codesniffer中：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.NamingConventions.NoSetter " >
        < properties >
            < property name = " allowedClasses " type = " array " value = " *DataObject " />
        </ properties >
    </ rule >
</ ruleset >

在ECS中：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsNoSetterSniff :
        allowedClasses : 
            - ' *DataObject '

没有实施规则 - 太严格，模糊或烦人

在实践中使用时，我们发现这些规则太严格，模糊甚至烦人，而不是帮助编写更清洁和更务实的代码。它们也与域驱动的设计密切相关。

3。包装原始类型和字符串- 自PHP 7以来，您可以使用define(strict_types=1)和标量类型提示。对于其他情况，例如电子邮件，您可以通过价值对象在域中处理。

4.使用头等舱收藏- 此规则很有意义，但是太严格了，无法在实践中有用。甚至我们的代码根本没有通过它。

8。请勿使用具有两个以上实例变量的类- 这取决于每个项目的各个域。为此制定规则是没有意义的。

3个贡献规则

每公关1个功能
每个新功能都必须涵盖测试
所有测试和样式检查必须通过
```
composer complete-check
```

然后，我们很乐意合并您的功能。

展开

phpcs calisthenics rules

php_codesniffer的对象校准规则

为什么要在项目中使用它？

安装

用法

如何快速检查1规则？

实施规则嗅探

1。每方法仅X缩进水平

仅使用此规则？

？可配置

2。请勿使用“ else”关键字

仅使用此规则？

5。每个语句仅使用一个对象操作员（ -> ）

仅使用此规则？

？可配置

6。不要缩写

仅使用此规则？

？可配置

7.让您的课程小

仅使用此规则？

？可配置

9。请勿使用Getters和Setter

仅使用此规则？

？可配置

没有实施规则 - 太严格，模糊或烦人

3个贡献规则

1。每方法仅`X`缩进水平

5。每个语句仅使用一个对象操作员（ `->` ）