Skip to content

Latest commit

 

History

History
115 lines (69 loc) · 1.48 KB

README.md

File metadata and controls

115 lines (69 loc) · 1.48 KB

Grump PHP config for Drupal Projects

Install

composer req shaquer/grumphp-config --dev

Add following to your composer.json

  "extra": {
    "grumphp": {
            "config-default-path": "vendor/shaquer/grumphp-config/grumphp.yml"
        }
  }

Twig CS

Whitelist

/^(docroot|web)\/modules\/custom\/(.*)/

/^(docroot|web)\/themes\/custom\/(.*)/

/^(docroot|web)\/themes\/patternlab\/(.*)/

Json lint

Ignore

'/^(?!docroot\/modules\/custom).*/'

'/^(?!web\/modules\/custom).*/'

Git commit messages

No empty messages allowed.

Suffix must be in commit messaged.

Allowed suffixes (Type scope conventions)

  • build
  • ci
  • chore
  • docs
  • feat
  • fix
  • new
  • upd
  • perf
  • refactor
  • revert
  • style
  • test
  • chg

PHP Stan

Ignore all contrib code.

Whitelist

'/^(?!docroot\/modules\/custom).*/'

'/^(?!web\/modules\/custom).*/'

Yaml lint

Check all yamls.

Whitelist

/^(docroot|web)\/modules\/custom\/(.*)/

/^(docroot|web)\/themes\/custom\/(.*)/

Git blacklist

Following code is not allowed

  • "die("
  • "dsm("
  • "print_r("
  • "var_dump("
  • "exit;"

Whitelist

/^(docroot|web)\/modules\/custom\/(.*)/

/^(docroot|web)\/themes\/custom\/(.*)/

PHP CS

Check for Drupal and DrupalPractice.

Ignore folders

config/

docroot/libraries/

docroot/themes/custom/*/components

web/libraries/

web/themes/custom/*/components

Whitelist

/^(docroot|web)\/modules\/custom\/(.*)/

/^(docroot|web)\/themes\/custom\/(.*)/