https://github.com/allocine/twigcs

https://github.com/allocine/twigcs

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/allocine/twigcs
• Owner: allocine
• License: mit
• Fork: true (friendsoftwig/twigcs)
• Created: 2019-06-10T19:09:41.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-09-05T14:33:12.000Z (almost 5 years ago)
• Last Synced: 2024-05-13T23:44:40.956Z (about 1 month ago)
• Language: PHP
• Size: 94.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-twig - Twigcs - Check for violations on Twig coding standard (Twig / Tools)
• awesome-twig - Twigcs - Check for violations on Twig coding standard (Twig / Tools)

README

        
# Twigcs

The missing checkstyle for twig !

Twigcs aims to be what phpcs is to php. It checks your codebase for violations on coding standards.

Please note that the project is still in early development stage and is subject to heavy changes.

## How to install

```bash

composer global require allocine/twigcs

```

## How to run

Basically, just run :

```bash

twigcs /path/to/views

```

On Symfony projects, you can run, for instance :

```bash

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 :

```bash

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

```

With the example above, notices are still displayed but not altering the exit code.

### 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) :

```bash

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](http://twig.sensiolabs.org/doc/coding_standards.html). 

#### Custom coding standard

You can create a class implementing `RulesetInterface` and supply it as a `--ruleset` option to the CLI script: 

```bash

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.

### 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.

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