Php Codesniffer должен игнорировать заглавную букву и полный стоп - PullRequest
Новая
       59

Php Codesniffer должен игнорировать заглавную букву и полный стоп

0 голосов
/ 07 ноября 2019

Я внедряю PHPCS для существующего проекта. Я хочу проверить, есть ли в функциях докблок.

В настоящее время я использую следующие правила: 

    <rule ref="Squiz.Commenting.FunctionComment" />
    <rule ref="Squiz.Commenting.FunctionCommentThrowTag" />
    <rule ref="Squiz.Commenting.VariableComment" />
    <rule ref="Squiz.Commenting.DocCommentAlignment"/>
    <rule ref="Generic.Files.LineLength">
        <properties>
            <property name="absoluteLineLimit" value="120"/>
            <property name="lineLimit" value="120"/>
        </properties>
    </rule>
    <!-- Ban some functions -->
    <rule ref="Generic.PHP.ForbiddenFunctions">
        <properties>
            <property name="forbiddenFunctions" type="array">
                <element key="print" value="echo"/>
                <element key="var_dump" value="null"/>
                <element key="dd" value="null"/>
                <element key="dump" value="null"/>
                <element key="echo" value="null"/>
                <element key="print_r" value="null"/>
                <element key="var_export" value="null"/>
            </property>
        </properties>
    </rule>

Но я часто сталкиваюсь с тем, что комментарий к параметру должен начинаться с заглавной буквы. Письмо и конец с полной остановкой.

Как я могу сделать правила менее строгими в отношении заглавных букв и полных остановок

Редактировать: В настоящее время блок кода также хочет выровнять параметры. Это создает много уродливых пробелов между @param array и $parameter. Могу ли я удалить это правило в phpcs & phpcbf?

1 Ответ

1 голос
/ 08 ноября 2019

Запустите PHPCS с аргументом командной строки -s, чтобы вы могли видеть коды ошибок рядом с каждым сообщением. Затем вы можете исключить эти конкретные сообщения в вашем наборе правил, установив их серьезность на 0.

В этом конкретном случае вы, вероятно, захотите добавить эти 4 исключения в ваш набор правил: 

<rule ref="Squiz.Commenting.FunctionComment.ParamCommentNotCapital">
    <severity>0</severity>
</rule>
<rule ref="Squiz.Commenting.FunctionComment.ParamCommentFullStop">
    <severity>0</severity>
</rule>
<rule ref="Squiz.Commenting.FunctionComment.SpacingAfterParamType">
    <severity>0</severity>
</rule>
<rule ref="Squiz.Commenting.FunctionComment.SpacingAfterParamName">
    <severity>0</severity>
</rule>
...