funivan/cs

Perform code fix and review

dev-master 2017-05-12 08:51 UTC

Requires

• php: >=5.6.0
• funivan/php-tokenizer: 0.1.2-alpha5
• symfony/console: ^2.8 | ^3.0
• symfony/finder: ^2.8 | ^3.0
• symfony/process: ^2.8 | ^3.0

Requires (Dev)

• league/commonmark: 0.15.*
• phpunit/phpunit: 5.*
• webuni/commonmark-table-extension: 0.6.*

MIT

• Ivan Scherbak

• static analysis
• review
• Code style
• coding standards
• fixer
• code review
• code fix

README

Perform code fix and review

Tools list

Fixer	Review	Link
✔	✔	Php open tags
✔	✔	Php line before class end
	✔	Php file start
	✔	Php closing tags
✔		Php return type format
✔	✔	Php redundant Null property value
✔	✔	Spaces in empty lines
✔	✔	Line ending
	✔	Composer

Install

Via Composer

composer require funivan/cs:dev-master

Usage

  # run review tool
  ./vendor/bin/cs.php review;

  # run fixer tool
  ./vendor/bin/cs.php fix;

Custom configuration

Create custom configuration file. For example cs-fix.php

<?php
  # file cs-fix.php
  require __DIR__ . '/vendor/autoload.php';


  use Funivan\Cs\Configuration\CsConfiguration;

  $configuration = CsConfiguration::createFixerConfiguration();
  // You can set custom file finder
  // $configuration->setFileFinder(new MyProjectCustomFileFinder());

  // You can add custom tools
  // $configuration->setTool(new MyProjectCustomCheckTool());

Then run fixer

  ./vendor/bin/cs.php fix --configuration=cs-fixer.php -vvv

Testing

    ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

• funivan
• All Contributors

License

The MIT License (MIT). Please see License File for more information.