allocine/twigcs

Checkstyle automation for Twig

Twigcs

The missing checkstyle for twig !, _(*1)

Twigcs aims to be what phpcs is to php. It checks your codebase for violations on coding standards., _(*2)

Please note that the project is still in early development stage and is subject to heavy changes., _(*3)

How to install

composer global require allocine/twigcs

How to run

Basically, just run :, _(*4)

twigcs /path/to/views

On Symfony projects, you can run, for instance :, _(*5)

twigcs /project/dir/app/Resources/views

You will get a summary of the violations in the console. The exit code of the command is based on the severity of any violation found. By default, twigcs won't even tolerate a notice, this can be changed at run time :, _(*6)

twigcs /path/to/views --severity warning # Allow notices

With the example above, notices are still displayed but not altering the exit code., _(*7)

Continuous Integration

Twigcs can be used with your favorite CI server. The command itself will return a consistent exit code telling the CI job if it failed or succeeded. You can also have a nice xml report (checkstyle format) :, _(*8)

twigcs /path/to/views --reporter checkstyle > /path/to/report.xml

Coding standard

At the moment the only available standard is the official one from twig., _(*9)

Custom coding standard

You can create a class implementing RulesetInterface and supply it as a --ruleset option to the CLI script:, _(*10)

twigcs /path/to/views --ruleset \MyApp\TwigCsRuleset

Note: twigcs needs to be used via composer and the ruleset class must be reachable via composer's autoloader for this feature to work., _(*11)

Coming features

• Indentation checking
• Configurable coding standards

Contributing

The master is the development branch, if you find any bug or false positive during style checking, please open an issue or submit a pull request., _(*12)

When creating or changing a class, don't forget to add you as an @author at the top of the file., _(*13)