Merge pull request #1 from typesetsh/feature/upgrade-typeset

chore: add package auto-discovery, update readme, code style

Author: jsiefer

.php_cs.dist

@@ -1,6 +1,7 @@
 <?php
 
 $finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__ . '/config')
     ->in(__DIR__ . '/src')
 ;
 

README.md

@@ -12,28 +12,13 @@ in your laravel project. Typeset.sh is a printcss layout and rendering engine wr
 
 Make sure you have access to a valid composer token from typeset.sh.
 
-Add typeset.sh packages repository to composer.
+Add typeset.sh package repository to composer and install the package via composer:
 
     composer config repositories.typesetsh composer https://packages.typeset.sh
     composer require typesetsh/laravel-wrapper
 
+The package will be automatically discovered in your application thanks to [package auto-discovery](https://laravel.com/docs/8.x/packages#package-discovery).
 
-Then add the following line to register provider in `config/app.php`
-```php
-'providers' => [
-
-    // ...
-    
-    App\Providers\AppServiceProvider::class,
-    App\Providers\AuthServiceProvider::class,
-    App\Providers\EventServiceProvider::class,
-    App\Providers\RouteServiceProvider::class,
-[+] Typesetsh\LaravelWrapper\ServiceProvider::class,
-
-],
-```  
-    
-    
 ## Usage
 
 The wrapper works similar to the view. Technically it wraps the view and uses its html output

composer.json

@@ -7,6 +7,10 @@
         {
             "name": "Jacob Siefer",
             "email": "jacob@typeset.sh"
+        },
+        {
+            "name": "Rouven Alexander Rieker",
+            "email": "therouv@googlemail.com"
         }
     ],
     "minimum-stability": "stable",
@@ -15,21 +19,25 @@
         "typesetsh/typesetsh": "^0.14"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2.17@dev",
-        "phan/phan": "dev-master"
+        "friendsofphp/php-cs-fixer": "^2.16"
     },
     "autoload": {
         "psr-4": {
             "Typesetsh\\LaravelWrapper\\": "src/"
         },
-        "files": ["src/helper.php"]
+        "files": [
+            "src/helper.php"
+        ]
     },
-    "autoload-dev": {
-        "psr-4": {
-            "Typesetsh\\LaravelWrapper\\": "tests/unit/"
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Typesetsh\\LaravelWrapper\\TypesetServiceProvider"
+            ]
         }
     },
-    "repositories": [{
+    "repositories": [
+        {
             "type": "composer",
             "url": "https://packages.typeset.sh"
         }

config/typesetsh.php

@@ -12,7 +12,9 @@
     |
     */
 
-    'allowed_directories' => [public_path()],
+    'allowed_directories' => [
+        public_path(),
+    ],
 
     /*
     |--------------------------------------------------------------------------

src/Facades/Pdf.php

@@ -1,16 +1,17 @@
 <?php
 /**
- * @copyright Copyright (c) 2020 Jacob Siefer
- *
- * @see LICENSE
+ * Copyright (c) 2020 Jacob Siefer
+ * See LICENSE bundled with this package for license details.
  */
 
+declare(strict_types=1);
+
 namespace Typesetsh\LaravelWrapper\Facades;
 
-use Typesetsh\LaravelWrapper\PdfView;
+use Typesetsh\LaravelWrapper\Pdf\View;
 
 /**
- * @method static PdfView make($view, array $data = [], array $mergeData = [])
+ * @method static View make($view, array $data = [], array $mergeData = [])
  */
 class Pdf extends \Illuminate\Support\Facades\Facade
 {

src/Pdf/Factory.php

@@ -1,9 +1,9 @@
 <?php
 /**
- * @copyright Copyright (c) 2020 Jacob Siefer
- *
- * @see LICENSE
+ * Copyright (c) 2020 Jacob Siefer
+ * See LICENSE bundled with this package for license details.
  */
+
 declare(strict_types=1);
 
 namespace Typesetsh\LaravelWrapper\Pdf;

src/Pdf/View.php

@@ -1,16 +1,17 @@
 <?php
 /**
- * @copyright Copyright (c) 2020 Jacob Siefer
- *
- * @see LICENSE
+ * Copyright (c) 2020 Jacob Siefer
+ * See LICENSE bundled with this package for license details.
  */
+
 declare(strict_types=1);
 
 namespace Typesetsh\LaravelWrapper\Pdf;
 
 use Illuminate\Contracts\Support\Renderable;
 use Illuminate\Contracts\Support\Responsable;
 use Illuminate\Contracts\View\View as HtmlView;
+use Illuminate\Http\Request;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 use Typesetsh\LaravelWrapper\Typesetsh;
 
@@ -54,7 +55,7 @@ public function render(): string
     /**
      * Create an HTTP response that represents the object.
      *
-     * @param \Illuminate\Http\Request $request
+     * @param Request $request
      */
     public function toResponse($request): StreamedResponse
     {

src/ServiceProvider.php

@@ -1,9 +1,9 @@
 <?php
 /**
- * @copyright Copyright (c) 2020 Jacob Siefer
- *
- * @see LICENSE
+ * Copyright (c) 2020 Jacob Siefer
+ * See LICENSE bundled with this package for license details.
  */
+
 declare(strict_types=1);
 
 namespace Typesetsh\LaravelWrapper;

src/Typesetsh.php

@@ -1,9 +1,9 @@
 <?php
 /**
- * @copyright Copyright (c) 2020 Jacob Siefer
- *
- * @see LICENSE
+ * Copyright (c) 2020 Jacob Siefer
+ * See LICENSE bundled with this package for license details.
  */
+
 declare(strict_types=1);
 
 namespace Typesetsh\LaravelWrapper;

src/helper.php

@@ -1,8 +1,7 @@
 <?php
 /**
- * @copyright Copyright (c) 2020 Jacob Siefer
- *
- * @see LICENSE
+ * Copyright (c) 2020 Jacob Siefer
+ * See LICENSE bundled with this package for license details.
  */
 
 namespace typesetsh;