Merge pull request #6 from basz/feature/header-comment

header comment

Author: prolic

.docheader

@@ -1,8 +1,6 @@
-/**
- * This file is part of the prooph/php-cs-fixer-config.
- * (c) 2016-%year% prooph software GmbH <contact@prooph.de>
- * (c) 2016-%year% Sascha-Oliver Prolic <saschaprolic@googlemail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
+This file is part of `%package%`.
+(c) 2016-%year% prooph software GmbH <contact@prooph.de>
+(c) 2016-%year% Sascha-Oliver Prolic <saschaprolic@googlemail.com>
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.

.php_cs

@@ -1,17 +1,21 @@
 <?php
+
 /**
- * This file is part of the prooph/php-cs-fixer-config.
- * (c) 2016-2016 prooph software GmbH <contact@prooph.de>
- * (c) 2016-2016 Sascha-Oliver Prolic <saschaprolic@googlemail.com>
+ * This file is part of `prooph/php-cs-fixer-config`.
+ * (c) 2016-2018 prooph software GmbH <contact@prooph.de>
+ * (c) 2016-2018 Sascha-Oliver Prolic <saschaprolic@googlemail.com>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
+declare(strict_types=1);
+
 $config = new Prooph\CS\Config\Prooph();
 $config->getFinder()->in(__DIR__);
+$config->getFinder()->append(['.php_cs']);
 
-$cacheDir = getenv('TRAVIS') ? getenv('HOME') . '/.php-cs-fixer' : __DIR__;
+$cacheDir = \getenv('TRAVIS') ? \getenv('HOME') . '/.php-cs-fixer' : __DIR__;
 
 $config->setCacheFile($cacheDir . '/.php_cs.cache');
 

.travis.yml

@@ -32,7 +32,6 @@ before_script:
 script:
   - if [[ $TEST_COVERAGE == 'true' ]]; then php -dzend_extension=xdebug.so ./vendor/bin/phpunit --coverage-text --coverage-clover ./build/logs/clover.xml; else ./vendor/bin/phpunit; fi
   - ./vendor/bin/php-cs-fixer fix -v --diff --dry-run
-  - ./vendor/bin/docheader check src/ tests/
 
 after_success:
   - if [[ $TEST_COVERAGE == 'true' ]]; then php vendor/bin/coveralls -v; fi

README.md

@@ -14,6 +14,18 @@ Run
 ```
 $ composer require --dev prooph/php-cs-fixer-config
 ```
+
+Add to composer.json;
+
+```json
+"scripts": {
+  "check": [
+    "@cs",
+  ],
+  "cs": "php-cs-fixer fix -v --diff --dry-run",
+  "cs-fix": "php-cs-fixer fix -v --diff",
+}
+```
 
 ## Usage
 
@@ -26,6 +38,7 @@ Create a configuration file `.php_cs` in the root of your project:
 
 $config = new Prooph\CS\Config\Prooph();
 $config->getFinder()->in(__DIR__);
+$config->getFinder()->append(['.php_cs']);
 
 $cacheDir = getenv('TRAVIS') ? getenv('HOME') . '/.php-cs-fixer' : __DIR__;
 
@@ -34,6 +47,21 @@ $config->setCacheFile($cacheDir . '/.php_cs.cache');
 return $config;
 ```
 
+#### Header
+
+When you create a `.docheader` in the root of your project it will be used as header comment.
+
+It is recommended to use the following template but you may use anything you want.
+
+```
+This file is part of `%package%`.
+(c) 2016-%year% prooph software GmbH <contact@prooph.de>
+(c) 2016-%year% Sascha-Oliver Prolic <saschaprolic@googlemail.com>
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+```
+
 ### Git
 
 Add `.php_cs.cache` (this is the cache file created by `php-cs-fixer`) to `.gitignore`:
@@ -67,7 +95,7 @@ script:
 If you need to fix issues locally, just run
 
 ```
-$ ./vendor/bin/php-cs-fixer fix -v
+$ composer cs-fix
 ```
 
 ### Pre-commit hook

composer.json

@@ -20,8 +20,7 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^6.0",
-    "satooshi/php-coveralls": "^1.0",
-    "malukenho/docheader": "^0.1.4"
+    "satooshi/php-coveralls": "^1.0"
   },
   "autoload": {
     "psr-4": {
@@ -32,5 +31,14 @@
     "psr-4": {
       "ProophTest\\CS\\Config\\": "test"
     }
+  },
+  "scripts": {
+    "check": [
+      "@cs",
+      "@test"
+    ],
+    "cs": "php-cs-fixer fix -v --diff --dry-run",
+    "cs-fix": "php-cs-fixer fix -v --diff",
+    "test": "phpunit"
   }
 }

src/Prooph.php

@@ -1,6 +1,7 @@
 <?php
+
 /**
- * This file is part of the prooph/php-cs-fixer-config.
+ * This file is part of `prooph/php-cs-fixer-config`.
  * (c) 2016-2018 prooph software GmbH <contact@prooph.de>
  * (c) 2016-2018 Sascha-Oliver Prolic <saschaprolic@googlemail.com>
  *
@@ -25,7 +26,7 @@ public function __construct()
 
     public function getRules(): array
     {
-        return [
+        $rules = [
             '@PSR2' => true,
             'array_syntax' => ['syntax' => 'short'],
             'binary_operator_spaces' => [
@@ -47,7 +48,12 @@ public function getRules(): array
             'function_declaration' => true,
             'function_typehint_space' => true,
             'hash_to_slash_comment' => true,
-            'header_comment' => false,
+            'header_comment' => [
+                'commentType' => 'PHPDoc',
+                'header' => 'Prooph was here at `%package%` in `%year%`! Please create a .docheader in the project root and run `composer cs-fix`',
+                'location' => 'after_open',
+                'separate' => 'both',
+            ],
             'include' => true,
             'indentation_type' => true,
             'linebreak_after_opening_tag' => true,
@@ -111,5 +117,32 @@ public function getRules(): array
             'visibility_required' => true,
             'whitespace_after_comma_in_array' => true,
         ];
+
+        $rules['header_comment'] = $this->headerComment($rules['header_comment']);
+
+        return $rules;
+    }
+
+    private function headerComment(array $rules): array
+    {
+        if (\file_exists('.docheader')) {
+            $header = \file_get_contents('.docheader');
+        } else {
+            $header = $rules['header'];
+        }
+
+        // remove comments from existing .docheader or crash
+        $header = \str_replace(['/**', ' */', ' * ', ' *'], '', $header);
+        $package = 'unknown';
+
+        if (\file_exists('composer.json')) {
+            $package = \json_decode(\file_get_contents('composer.json'))->name;
+        }
+
+        $header = \str_replace(['%package%', '%year%'], [$package, (new \DateTime('now'))->format('Y')], $header);
+
+        $rules['header'] = \trim($header);
+
+        return $rules;
     }
 }

tests/ProophTest.php

@@ -1,6 +1,7 @@
 <?php
+
 /**
- * This file is part of the prooph/php-cs-fixer-config.
+ * This file is part of `prooph/php-cs-fixer-config`.
  * (c) 2016-2018 prooph software GmbH <contact@prooph.de>
  * (c) 2016-2018 Sascha-Oliver Prolic <saschaprolic@googlemail.com>
  *
@@ -50,11 +51,10 @@ public function it_has_rules(): void
     /**
      * @test
      */
-    public function it_does_not_have_header_comment_fixer_by_default(): void
+    public function it_does_have_header_comment_fixer_by_default(): void
     {
         $config = new Prooph();
         $rules = $config->getRules();
         $this->assertArrayHasKey('header_comment', $rules);
-        $this->assertFalse($rules['header_comment']);
     }
 }