Merge pull request #20 from joaorobertopb/add-php-cs-fixer

Add php-cs-fixer support

Author: BrainMaestro

.gitattributes

@@ -3,5 +3,6 @@
 .gitattributes     export-ignore
 .gitignore         export-ignore
 .travis.yml        export-ignore
+CONTRIBUTING.md    export-ignore
 Dockerfile         export-ignore
 phpunit.xml        export-ignore

.gitignore

@@ -1,3 +1,4 @@
 /vendor/
 /.idea/
 /test-git-dir/
+.php_cs.cache

.travis.yml

@@ -8,12 +8,18 @@ matrix:
         - php: 7.2
     fast_finish: true
 
+cache:
+  directories:
+    - $HOME/.composer/cache
+
 before_install:
-  - composer self-update
+  - phpenv config-rm xdebug.ini || return 0
+  - travis_retry composer self-update
 
 install:
-  - composer update --no-interaction
+  - travis_retry composer update --no-interaction
 
 script:
   - composer validate --strict --no-check-lock
+  - ./vendor/bin/php-cs-fixer fix . -v --dry-run --using-cache=no
   - ./vendor/bin/phpunit

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+
+Contributions are **welcome**!
+
+We accept contributions via Pull Requests on [Github](https://github.com/BrainMaestro/composer-git-hooks/pulls).
+
+## Pull Requests
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** -  The easiest way to apply the conventions is run command:
+ ```sh
+composer fix-style
+```
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the [README.md](README.md) and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+## Running Tests
+
+```sh
+phpunit
+```
+
+**Happy coding**!

README.md

@@ -1,7 +1,10 @@
 # composer-git-hooks
-[![Travis](https://img.shields.io/travis/BrainMaestro/composer-git-hooks.svg?style=flat-square)](https://travis-ci.org/BrainMaestro/composer-git-hooks)
-[![Packagist](https://img.shields.io/packagist/v/brainmaestro/composer-git-hooks.svg?style=flat-square)](https://packagist.org/packages/brainmaestro/composer-git-hooks)
-[![Packagist](https://img.shields.io/packagist/dt/brainmaestro/composer-git-hooks.svg?style=flat-square)](https://packagist.org/packages/brainmaestro/composer-git-hooks)
+
+[![Software License][badge-license]](LICENSE)
+[![Travis][badge-travis]][link-travis]
+[![Packagist][badge-packagist]][link-packagist]
+[![Download][badge-downloads]][link-packagist]
+
 > Manage git hooks easily in your composer configuration. This package makes it easy to implement a consistent project-wide usage of git hooks. Specifying hooks in the composer file makes them available for every member of the project team. This provides a consistent environment and behavior for everyone which is great.
 
 ## Install
@@ -45,7 +48,7 @@ Add a `cghooks` script to the `scripts` section of your `composer.json` file. Th
 
 #### Composer Events
 
-Add the following events to your `composer.json` file. The `cghooks` commands will be run every time the events occur. Go to [Composer Command Events](https://getcomposer.org/doc/articles/scripts.md#command-events) for more details about composer's event system.
+Add the following events to your `composer.json` file. The `cghooks` commands will be run every time the events occur. Go to [Composer Command Events][link-composer-events] for more details about composer's event system.
 
 ```json
 {
@@ -107,9 +110,31 @@ Option | Description | Command
 
 Hooks can be tested with `cghooks ${hook}` before adding them. Example `cghooks pre-commit` runs the `pre-commit` hook.
 
-## Related
-- [husky](https://github.com/typicode/husky)
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Credits
 
+- [Ezinwa Okpoechi][link-author]
+- [All Contributors][link-contributors]
+
+## Related
+- [husky][link-husky]
 
 ## License
-MIT © Ezinwa Okpoechi
+
+The MIT License (MIT). Please see [License File](LICENSE) for more information.
+
+[badge-downloads]: https://img.shields.io/packagist/dt/brainmaestro/composer-git-hooks.svg?style=flat-square
+[badge-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg
+[badge-packagist]: https://img.shields.io/packagist/v/brainmaestro/composer-git-hooks.svg?style=flat-square
+[badge-stable]: https://poser.pugx.org/your-app-rocks/eloquent-uuid/v/stable
+[badge-travis]: https://img.shields.io/travis/BrainMaestro/composer-git-hooks.svg?style=flat-square
+
+[link-author]: https://github.com/BrainMaestro
+[link-composer-events]: https://getcomposer.org/doc/articles/scripts.md#command-events
+[link-contributors]: ../../contributors
+[link-husky]: https://github.com/typicode/husky
+[link-packagist]: https://packagist.org/packages/brainmaestro/composer-git-hooks
+[link-travis]: https://travis-ci.org/BrainMaestro/composer-git-hooks

composer.json

@@ -16,8 +16,13 @@
         }
     ],
     "require": {
+        "php": "^5.6 || >=7.0 <7.3",
         "symfony/console": "^3.2 || ^4.0"
     },
+    "require-dev": {
+        "phpunit/phpunit": "^5.7",
+        "friendsofphp/php-cs-fixer": "^2.9"
+    },
     "autoload": {
         "psr-4": {
             "BrainMaestro\\GitHooks\\": "src/"
@@ -29,10 +34,9 @@
         }
     },
     "bin": ["cghooks"],
-    "require-dev": {
-        "phpunit/phpunit": "^5.7"
-    },
     "scripts": {
+        "check-style": "php-cs-fixer fix --using-cache=no --diff --dry-run .",
+        "fix-style": "php-cs-fixer fix --using-cache=no .",
         "pre-commit": "echo about to commit",
         "post-commit": "echo just committed"
     }