Merge pull request #221 from mlocati/fix-composer-scripts

Fix composer scripts and check composer files

Author: mlocati

.gitattributes

@@ -0,0 +1,6 @@
+/features/ export-ignore
+/tests/ export-ignore
+/.* export-ignore
+/behat.yml export-ignore
+/box.json.dist export-ignore
+/MAINTAINERS.md export-ignore

.github/workflows/create-draft-release.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       RELEASE_NAME: ""
-      PATHS_FOR_RELEASE_NOTES: "box.json composer.json src/"
+      PATHS_FOR_RELEASE_NOTES: "box.json.dist composer.json src/"
     steps:
       - name: Check tag format
         if: github.event_name == 'create' && github.event.ref_type == 'tag'

.github/workflows/test.yml

@@ -34,11 +34,13 @@ jobs:
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
+      - name: Check validity of composer files
+        run: composer valid --strict --ansi --no-interaction
       - name: Install Composer dependencies (including dev, preferring source)
         run: composer install --prefer-source --optimize-autoloader --ansi --no-interaction
       - name: Check coding style
         if: matrix.os == 'ubuntu-latest' && matrix.php-version == '7.2'
-        run: ./vendor/bin/php-cs-fixer fix --path-mode=intersection --config=./.php_cs.dist --dry-run --using-cache=no --diff --diff-format=udiff --ansi --no-interaction .
+        run: composer run cs-check -- --using-cache=no --no-interaction
       - name: Run Atoum
         run: php ./vendor/atoum/atoum/scripts/coverage.php --format xml --output clover.xml
       - name: Install Composer dependencies (excluding dev)

.gitignore

@@ -1,7 +1,6 @@
-composer.phar
-pickle*.phar
-vendor/
-*.test
-/clover.xml
-/ocular.phar
+/vendor/
+/*.phar
+/.php_cs
 /.php_cs.cache
+/box.json
+/clover.xml

README.md

@@ -136,10 +136,16 @@ To ensure a consistent code base, you should make sure the code follows
 the [PSR-1](http://www.php-fig.org/psr/psr-1/) and
 [PSR-2](http://www.php-fig.org/psr/psr-2/) coding standards.
 
-To avoid CS issues, you should use [php-cs-fixer](http://cs.sensiolabs.org/):
+To check CS issues, you can use the `cs-check` composer command:
 
 ```sh
-$ php-cs-fixer fix src/
+$ composer run cs-check
+```
+
+To automatically fix CS issues, you can use the `cs-fix` composer command:
+
+```sh
+$ composer run cs-fix
 ```
 
 Support

bin/pickle.bat

@@ -0,0 +1 @@
+@php "%~dpn0" %*

box.json

@@ -52,8 +52,9 @@
         "discard-changes": true
     },
     "scripts": {
-        "cs": "vendor/bin/php-cs-fixer --ansi fix --config=sf23",
-        "test": "vendor/bin/atoum --force-terminal && vendor/bin/behat --suite pickle --colors"
+        "cs-fix": "php-cs-fixer fix --path-mode=intersection --config=./.php_cs.dist --ansi .",
+		"cs-check": "php-cs-fixer fix --path-mode=intersection --config=.php_cs.dist --ansi --dry-run --diff --diff-format=udiff .",
+        "test": "atoum --force-terminal && ./vendor/bin/behat --suite pickle --colors"
     },
     "extra": {
         "patches": {