wunderio / code-quality

List of tools that aims to help with static code quality inspection.
GNU General Public License v3.0
2 stars 5 forks source link

Adjust coding standards so that it would be possible to run phpcs with Lando + PhpStorm #86

Closed hkirsman closed 1 year ago

hkirsman commented 2 years ago

It seems it's possible to make PhpStorm run coding standards real time from Lando: https://github.com/HBFCrew/lando-docs-examples/blob/master/Drupal-PHPStorm-Lando-Setting-Code-Sniffer-Debugging.md#drupal-coding-standards-coder-codesniffer

There's some configuring in PhpStorm.

And also some adjustments need to be made to Code Quality.

Here's an example rule that seems to work ( vendor/wunderio/code-quality/rulesets/WunderDrupal/ruleset.xml ). If this works with GrumPHP then we can commit it.

<?xml version="1.0"?>
<!-- See http://pear.php.net/manual/en/package.php.php-codesniffer.annotated-ruleset.php -->
<ruleset name="WunderDrupal">
    <description>Drupal coding standard</description>

    <!-- exclude some Drupal files that contain issues -->
    <exclude-pattern>*default.settings.php</exclude-pattern>

    <!-- exclude minified files -->
    <exclude-pattern>*.min.*</exclude-pattern>

    <!-- exclude third-party node modules -->
    <exclude-pattern>node_modules/</exclude-pattern>

    <!-- exclude CSS files, where we don't usually follow Drupal standards  -->
    <exclude-pattern>*.css</exclude-pattern>

    <rule ref="../../../../slevomat/coding-standard/SlevomatCodingStandard"></rule>

    <rule ref="../../../../drupal/coder/coder_sniffer/Drupal">
        <exclude name="Drupal.Files.TxtFileLineLength" />
        <exclude name="Drupal.InfoFiles.AutoAddedKeys" />
        <exclude name="Drupal.Commenting.InlineComment.DocBlock" />
    </rule>
</ruleset>

Also it seems it's not possible to add more than 1 rule at a time, then we'd need to create 1 rule that combines WunderDrupal + WunderSecurity.

Todo:

hkirsman commented 2 years ago

We were able to make this work with Mario without making customizations to the above file. But because we can't seem to enable multiple rules, we'd need to have 1 that combines the 2. So at the moment we only would have WunderDrupal enabled.

image

hkirsman commented 2 years ago

I thought we could write the docs for this in wiki https://github.com/wunderio/code-quality/wiki/Testing-first-article---how-to-set-up-coding-standards-scanning-for-PHPStorm---Lando ?

@vermario