Skip to content

Commit

Permalink
Merge pull request #15 from CivicActions/feature/PGOV-300-PHPCS
Browse files Browse the repository at this point in the history
Configure PHPCS for code quality checking
  • Loading branch information
vauxia authored Nov 1, 2024
2 parents 08895a2 + a15d573 commit 8f7d4eb
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .ddev/commands/web/phpcbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash

# Run the PHP Code Fixer against the codebase. See phpcs.xml in the project
# root for configuration settings.

phpcbf --standard=phpcs.xml "$@"
6 changes: 6 additions & 0 deletions .ddev/commands/web/phpcs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash

# Run the PHP Code Sniffer against the codebase. See phpcs.xml in the project
# root for configuration settings.

phpcs --standard=phpcs.xml "$@"
3 changes: 3 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
"url": "https://packages.drupal.org/8"
}
],
"scripts": {
"phpcs": "phpcs --standard=phpcs.xml"
},
"require": {
"composer/installers": "^2.0",
"cweagans/composer-patches": "^1.7",
Expand Down
28 changes: 28 additions & 0 deletions phpcs.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="drupal">
<description>PHP CodeSniffer configuration for development.</description>
<!-- Specify folders. -->
<file>web/modules/custom</file>
<!-- <file>web/profiles/custom</file> -->
<!-- <file>web/themes/custom</file> -->

<arg name="extensions" value="php,module,inc,install,test,profile,theme,css,info,txt,md,yml"/>
<!-- Change this value to 7 if you want to check Drupal 7 code. -->
<config name="drupal_core_version" value="10"/>

<!-- If you have Coder installed locally then you can reference the Drupal
standards with relative paths. Otherwise simply use "Drupal" and
"DrupalPractice. -->
<rule ref="vendor/drupal/coder/coder_sniffer/Drupal">
<!-- Example how you would disable a rule you are not compliant with yet:
<exclude name="Drupal.Commenting.Deprecated"/>
-->
</rule>
<rule ref="vendor/drupal/coder/coder_sniffer/DrupalPractice"/>

<!-- Example how you would disable an external rule you do not like:
<rule ref="PEAR.Functions.ValidDefaultValue.NotAtEnd">
<severity>0</severity>
</rule>
-->
</ruleset>

0 comments on commit 8f7d4eb

Please sign in to comment.