├── .gitignore
├── .php_cs
├── README.md
├── composer.json
├── config
    └── config.php
├── phpunit.xml.dist
├── src
    └── LaravelPackageTemplateProvider.php
└── tests
    ├── ExampleTest.php
    └── TestCase.php


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | composer.lock
3 | .php_cs.cache
4 | .phpunit.result.cache
5 | 


--------------------------------------------------------------------------------
/.php_cs:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $finder = PhpCsFixer\Finder::create()
 4 |     ->in(__DIR__ . DIRECTORY_SEPARATOR . 'tests')
 5 |     ->in(__DIR__ . DIRECTORY_SEPARATOR . 'src')
 6 |     ->append(['.php_cs']);
 7 | 
 8 | $rules = [
 9 |     '@Symfony'               => true,
10 |     'phpdoc_no_empty_return' => false,
11 |     'array_syntax'           => ['syntax' => 'short'],
12 |     'yoda_style'             => false,
13 |     'binary_operator_spaces' => [
14 |         'operators' => [
15 |             '=>' => 'align',
16 |             '='  => 'align',
17 |         ],
18 |     ],
19 |     'concat_space'            => ['spacing' => 'one'],
20 |     'not_operator_with_space' => false,
21 | ];
22 | 
23 | $rules['increment_style'] = ['style' => 'post'];
24 | 
25 | return PhpCsFixer\Config::create()
26 |     ->setUsingCache(true)
27 |     ->setRules($rules)
28 |     ->setFinder($finder);
29 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Laravel Package Repository Template
 2 | A bare bones respository template for developing Laravel packages.
 3 | ### How To Use
 4 | Use the green "Use this template" button above to create a new repository based on this repo. You'll get a fresh repository reflecting the code as it is right now in this repo, but with a fresh commit history.
 5 | 
 6 | After you've done that, you have some editing / refactoring to do. Depending on your IDE the instructions and difficulty of this will vary a bit. But however you accomplish them, here are your steps:
 7 | 
 8 | 1. Edit composer.json to change the vendor/packagename line, the description, the author name, and the author email. Also update the autoload blocks to reflect your vendor namespace and package name.
 9 | 
10 | 2. Rename LaravelPackageTemplateProvider.php to be {YourPackageName}Provider.php and change the class name inside to match. Change the namespace to match your vendor namespace.
11 | 
12 | 3. Go to tests/TestCase and change the name of the loaded service provider to match your package name.
13 | 
14 | 4. Run the tests. There should be one test and it should pass. If that happens, you know you at least haven't broken the test setup and should be ready to start building something great.
15 | 
16 | ### Linting and Testing
17 | 
18 | ```shell script
19 | composer test:unit # Runs PHPUnit
20 | composer lint # Runs php-cs-fixer to fix your coding style
21 | composer test # Runs lint and then test:unit 
22 | ```
23 | 
24 | ### Acknowledgements
25 | 
26 | I started off writing packages with the help of Marcel Pociot's excellent [Laravel Package Boilerplate](https://laravelpackageboilerplate.com/#/) and I purchased and used his course on package development. Without those two things I'd never have gotten to be nearly as proficient in package develpment as I am. If you are just starting out, I strongly recommend using those vs using this template or starting from scratch.
27 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "grosv/laravel-package-template",
 3 |     "description": "A repository template for Laravel packages",
 4 |     "type": "library",
 5 |     "license": "MIT",
 6 |     "authors": [
 7 |         {
 8 |             "name": "Ed Grosvenor",
 9 |             "email": "ed.grosvenor@wickedviral.com"
10 |         }
11 |     ],
12 |     "minimum-stability": "dev",
13 |     "prefer-stable": true,
14 |     "require": {
15 |         "php": "^7.3",
16 |         "illuminate/support": "^7.0|^8.0"
17 |     },
18 |     "require-dev": {
19 |         "orchestra/testbench": "^5.0",
20 |         "friendsofphp/php-cs-fixer": "^2.16"
21 |     },
22 |     "autoload": {
23 |         "psr-4": {
24 |             "Grosv\\LaravelPackageTemplate\\": "src/"
25 |         }
26 |     },
27 |     "autoload-dev": {
28 |         "psr-4": {
29 |             "Tests\\": "tests/",
30 |             "App\\": "vendor/orchestra/testbench-core/laravel/app"
31 |         }
32 |     },
33 |     "extra": {
34 |         "laravel": {
35 |             "providers": "Grosv\\LaravelPackageTemplate\\LaravelPackageTemplateProvider"
36 |         }
37 |     },
38 |     "scripts": {
39 |         "lint": "php-cs-fixer fix -v",
40 |         "test:unit": "phpunit",
41 |         "test": [
42 |             "@lint",
43 |             "@test:unit"
44 |         ]
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/config/config.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | return [
4 | 
5 | ];


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit bootstrap="vendor/autoload.php"
 3 |          backupGlobals="false"
 4 |          backupStaticAttributes="false"
 5 |          colors="true"
 6 |          verbose="true"
 7 |          convertErrorsToExceptions="true"
 8 |          convertNoticesToExceptions="true"
 9 |          convertWarningsToExceptions="true"
10 |          processIsolation="false"
11 |          stopOnFailure="true">
12 |     <testsuites>
13 |         <testsuite name="Test Suite">
14 |             <directory>tests</directory>
15 |         </testsuite>
16 |     </testsuites>
17 |     <filter>
18 |         <whitelist>
19 |             <directory suffix=".php">src/</directory>
20 |         </whitelist>
21 |     </filter>
22 |     <php>
23 |         <env name="APP_ENV" value="testing"/>
24 |         <env name="APP_DEBUG" value="true"/>
25 |     </php>
26 | </phpunit>


--------------------------------------------------------------------------------
/src/LaravelPackageTemplateProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Grosv\LaravelPackageTemplate;
 4 | 
 5 | use Illuminate\Support\ServiceProvider;
 6 | 
 7 | class LaravelPackageTemplateProvider extends ServiceProvider
 8 | {
 9 |     public function boot(): void
10 |     {
11 |     }
12 | 
13 |     public function register(): void
14 |     {
15 |         $this->mergeConfigFrom(__DIR__ . '/../config/config.php', 'laravel-package-template');
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/tests/ExampleTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Tests;
 4 | 
 5 | class ExampleTest extends TestCase
 6 | {
 7 |     /** @test */
 8 |     public function can_run_tests()
 9 |     {
10 |         $this->assertTrue(true);
11 |     }
12 | }
13 | 


--------------------------------------------------------------------------------
/tests/TestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Tests;
 4 | 
 5 | use Grosv\LaravelPackageTemplate\LaravelPackageTemplateProvider;
 6 | use Orchestra\Testbench\TestCase as BaseTestCase;
 7 | 
 8 | abstract class TestCase extends BaseTestCase
 9 | {
10 |     public function setUp(): void
11 |     {
12 |         parent::setUp();
13 |     }
14 | 
15 |     public function tearDown(): void
16 |     {
17 |         parent::tearDown();
18 |     }
19 | 
20 |     protected function getPackageProviders($app)
21 |     {
22 |         return [LaravelPackageTemplateProvider::class];
23 |     }
24 | 
25 |     protected function getEnvironmentSetUp($app)
26 |     {
27 |         $app['config']->set('database.default', 'testing');
28 |         $app['config']->set('app.key', 'base64:r0w0xC+mYYqjbZhHZ3uk1oH63VadA3RKrMW52OlIDzI=');
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------