init

Author: CyberPunkCodes

.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+.idea
+.vscode
+/vendor
+composer.lock
+/phpunit.xml
+.phpunit.result.cache
+*.log
+_notes.txt
+_notes.md
+bak__*

README.md

@@ -0,0 +1,128 @@
+# Laravel Extended Commands
+
+Extends the Laravel artisan commands for developers.
+
+With all of the helpful commands that Laravel comes out of the box with, there are a few that are missing. Hopefully one day Laravel will add them officially. Until then, let's fill the gap.
+
+## Installation
+
+Install as a dev dependency:
+
+```bash
+composer require cyberpunkcodes/laravel-extended-commands --dev
+```
+
+## Usage
+
+This package is only usable via the command line. Refer to the commands list below for supported commands and how to use them.
+
+## Commands
+
+The make commands will generate files in the corresponding directories within the `app` directory and the `App` namespace.
+
+**For example:** Actions will be generated in the `app/Actions` directory and will be within the `App\Actions` namespace. Enums will be generated in `app/Enums` with the `App\Enums` namespace. Contracts will be generated in `app/Contracts` with the `App\Contracts` namespace. And so on.
+
+Using double backslashes in the name will generate sub-directories. ie, running `php artisan make:action User\\AddBlogComment` will create `app/Actions/User/AddBlogComment.php` with the namespace of `App\Actions\User`.
+
+All of the "make" commands follow this convention.
+
+This does not force any naming conventions on you. What you enter is what you get. If you want your contracts to end with `Contract` then you must enter it as the name, ie: `CreatesNewBlogPostContract`. If you want Enums to end with "Enum", name it like `BlogPostStatusEnum`. Personally, I don't think it's necessary to add "Contract" or "Enum" or anything to the end of most of these, as they are already included in the path and namespace and Laravel doesn't seem to do it themselves. I do like to add "Service" to the end of my services, but to each their own :)
+
+The following list of actions/commands are supported:
+
+### Clear Logs
+
+Delete all of the `*.log` files found in the `storage/logs` directory:
+
+`php artisan clear:logs`
+
+### Make Action
+
+`php artisan make:action SomeAction`
+
+**Example:** `php artisan make:action AddBlogPost`
+
+By default, this will generate "invokable actions", which allows you to typhint the action in your method and use it's parameter as a function/method. I find this the best use-case for actions and Laravel Fortify uses them mostly like this as well, which is why it's the default.
+
+```php
+public function store(Request $request, AddBlogPost $addBlogPostAction)
+{
+    $blogPost = $addBlogPostAction($request, $user);
+
+    // ...
+}
+```
+
+If you don't want invokable actions, you can pass a `--handle` option which creates a `handle()` method instead of the `__invoke()` magic method. This is ideal for when your actions are being used within Pipelines, which is why it automatically has the `$request` and `$next` params.
+
+### Make Contract
+
+`php artisan make:contract SomeContract`
+
+**Example:** `php artisan make:contract BlogSystem`
+
+### Make Enum
+
+`php artisan make:enum SomeEnum`
+
+**Example:** `php artisan make:enum BlogPostStatus`
+
+**Enums require PHP version 8.1 or higher.**
+
+**Note:** The generated enum is just an example of a basic active/inactive status using an integer. It will cast the status as 1 or 0 in/out of the database and includes a label method for converting it to a string representation (ie: for a dropdown in your view). It can be any valid enum type, integer is just provided as a starting example.
+
+### Make Service
+
+`php artisan make:service SomeService`
+
+**Example:** `php artisan make:service BlogPostService`
+
+**What is a service?** Services are basically a fancy name for a specialized helper class. This isn't to be confused with a Service Provider. It allows you to get a lot of your code out of the controller, improving readability, and allows you to write more fine-grained tests without repeating code. If an Action or Job isn't applicable, you may want to use a Service.
+
+### Make Trait
+
+`php artisan make:trait SomeTrait`
+
+**Example:** `php artisan make:trait BlogPost`
+
+### Make View
+
+`php artisan make:view some-name`
+
+The name can be nested in sub-directories relative to the views directory.
+
+`php artisan make:view user/settings` will generate `/resources/views/user/settings.blade.php`
+
+The name will be converted to kebab case. So a name of `someName` will be generate `some-name.blade.php`. It will not convert the path (if passed), just the name. ie: `somePath/someName` will generate `somePath/some-name.blade.php`.
+
+#### View Layouts
+
+The `make:view` command does, in a way, support layouts. Since there are a few ways to use layouts in Laravel (ie: the old `@extend` method and new components), I thought it would be better to rely on stubs for your various needs. This way it not only handles layouts, but any number of alternate view file variations.
+
+Passing the `--stub` option allows you to define the stub to use:
+
+```bash
+php artisan make:view some-name --stub=some-stub
+```
+
+The stub option supports nested paths, relative to the `app/Console/stubs` directory. So passing `--stub=views/admin-layout` will use the `app/Console/stubs/views/admin-layout.stub` stub file. This allows you to keep the view stubs separate from the other make command stubs that you will read about in the "Custom Stubs" section below.
+
+**Note:** If you don't pass the `--stub` option, the default `make-stub.stub` file is used. To override it, you must create your own `make-view.stub` file in `app/Console/stubs`. If you want all of your view stubs organized separately in `app/Console/stubs/views` but it drives you mad that the default stub is outside of that in the `stubs` directory, you could create `default.stub` in the `stubs/views` directory. However, you would always have to pass `--stub=default`. If you don't, it uses the default `make-view.stub`, whether it be the one included in this package or an overrode one.
+
+## Custom Stubs
+
+You can override the stubs and use your own for file generation. Refer to the stubs included in this project's source code.
+
+It will first look in `/app/Console/stubs/` to see if the stub exists. If not, it will use the default ones provided by this package. So simply copy the stub from this package to `/app/Console/stubs/` and modify it to your liking.
+
+## Requirements
+
+This package requires Laravel 8 or higher. It should work with whatever PHP version you are running that satisfies your Laravel version, which is most likely PHP v7.3 or higher.
+
+Enums, however, require PHP 8.1 or higher.
+
+## Contributing
+
+Contributions are welcome. Keep in mind, the goal of this package is to add additional commands that Laravel should come out of the box with, but for some reason, doesn't. I don't want to over complicate this and add all kinds of extra features.
+
+Laravel has many "make" commands already... but why does it still not make traits, actions, or contracts? They are all used in their official packages.

composer.json

@@ -0,0 +1,31 @@
+{
+    "name": "cyberpunkcodes/laravel-extended-commands",
+    "description": "Extends the Laravel commands for developers",
+    "keywords": ["laravel", "extended", "commands", "artisan", "make"],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "CyberPunkCodes"
+        }
+    ],
+    "minimum-stability": "dev",
+    "require": {
+        "php": "^7.3|^8.0",
+        "laravel/framework": "^8.0|^9.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "CyberPunkCodes\\ExtendedCommands\\": "src"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "CyberPunkCodes\\ExtendedCommands\\Providers\\ExtendedCommandsServiceProvider"
+            ]
+        }
+    }
+}

src/Console/Commands/ClearLogs.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace CyberPunkCodes\ExtendedCommands\Console\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\File;
+
+class ClearLogs extends Command
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'clear:logs';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Delete all log files in the storage/logs directory';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    public function handle()
+    {
+        if (! File::delete(File::glob(storage_path(('logs/*.log'))))) {
+            $this->error("Error deleting one or more log files!");
+        }
+
+        $this->info("Log files have been deleted!");
+    }
+}

src/Console/Commands/MakeAction.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace CyberPunkCodes\ExtendedCommands\Console\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+use Symfony\Component\Console\Input\InputOption;
+
+class MakeAction extends GeneratorCommand
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'make:action';
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'make:action {name} {--handle : Use a handle method instead of an invokable action}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new action class';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Action';
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return $this->option('handle')
+            ? $this->resolveStubPath('make-action-handle.stub')
+            : $this->resolveStubPath('make-action.stub');
+    }
+
+    /**
+     * Resolve the fully-qualified path to the stub.
+     *
+     * @param  string  $stub
+     * @return string
+     */
+    protected function resolveStubPath($stub)
+    {
+        return file_exists($customPath = $this->laravel->basePath(trim('/app/Console/stubs/' . $stub, '/')))
+            ? $customPath
+            : __DIR__ . '/../../../stubs/' . $stub;
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace . '\Actions';
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return [
+            ['handle', null, InputOption::VALUE_NONE, 'Create an action with a handle method instead'],
+        ];
+    }
+}

src/Console/Commands/MakeContract.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace CyberPunkCodes\ExtendedCommands\Console\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+
+class MakeContract extends GeneratorCommand
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'make:contract';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new contract class';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Contract';
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return $this->resolveStubPath('make-contract.stub');
+    }
+
+    /**
+     * Resolve the fully-qualified path to the stub.
+     *
+     * @param  string  $stub
+     * @return string
+     */
+    protected function resolveStubPath($stub)
+    {
+        return file_exists($customPath = $this->laravel->basePath(trim('/app/Console/stubs/' . $stub, '/')))
+            ? $customPath
+            : __DIR__ . '/../../../stubs/' . $stub;
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace . '\Contracts';
+    }
+}