Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 1.47 KB

twigcs.md

File metadata and controls

64 lines (40 loc) · 1.47 KB
Raw

TwigCs

Check Twig coding standard based on FriendsOfTwig/TwigCs .

Composer

composer require --dev "friendsoftwig/twigcs:>=4"

Config

The task lives under the twigcs namespace and has following configurable parameters:

# grumphp.yml
grumphp:
    tasks:
        twigcs:
            path: '.'
            severity: 'warning'
            display: 'all'
            ruleset: 'FriendsOfTwig\Twigcs\Ruleset\Official'
            triggered_by: ['twig']
            exclude: []

path

Default: null

By default . (current folder) will be used. On precommit the path will not be used, changed files will be passed as arguments instead. You can specify an alternate location by changing this option. If the path doesn't exist or is not accessible an exception will be thrown.

severity

Default: 'warning'

Severity level of sniffing (possibles values are : 'IGNORE', 'INFO', 'WARNING', 'ERROR').

display

Default: 'all'

The violations to display (possibles values are : 'all', 'blocking').

ruleset

Default: 'FriendsOfTwig\Twigcs\Ruleset\Official'

Ruleset used, default ruleset is based on official one from twig

triggered_by

Default: [twig]

This option will specify which file extensions will trigger this task.

exclude

Default: []

This option will specify which relative subfolders or files will be excluded from this task.