-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from fokosun/v1.0.0
Add readme
- Loading branch information
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| ### Chain Commands Artisan Command | ||
| This package helps to chain multiple artisan commands using a simple, easy to understand syntax. | ||
|
|
||
| ### Example | ||
| ```text | ||
| php artisan chain-commands "make:controller TestController,make:event TestEvent" | ||
| ``` | ||
|
|
||
| This will run the make:controller and make:event artisan commands consecutively and displays the output in a table. | ||
|
|
||
|
|
||
| ## How to install | ||
| Run the following artisan command in the root of your Laravel project. | ||
| ```text | ||
| composer require fokosun/artisan-chain-commands | ||
| ``` | ||
|
|
||
| ## How to use | ||
| You can chain multiple artisan commands with ease but there are a few commands that are not supported. See list below. | ||
|
|
||
| ```text | ||
| 'chain-commands' => 'Not allowed', | ||
| 'db' => "This opens a REPL (Read, Evaluate, Print and Loop) environment.\nYou should not run this command with chain commands.", | ||
| 'docs' => "This opens the Laravel documentation page in a browser window.\nYou should not run this command with chain commands.", | ||
| 'docs 1' => "This opens the Laravel documentation page in a browser window.\nYou should not run this command with chain commands.", | ||
| 'docs 2' => "This opens the Laravel documentation page in a browser window.\nYou should not run this command with chain commands.", | ||
| 'docs -- search query' => "This opens the Laravel documentation page in a browser window.\nYou should not run this command with chain commands.", | ||
| 'docs -- search query here' => "This opens the Laravel documentation page in a browser window.\nYou should not run this command with chain commands.", | ||
| 'help' => "Displays help for a command.\nYou should not run this command with chain commands.", | ||
| 'serve' => 'Not allowed', | ||
| 'test' => 'Not allowed.', | ||
| 'tinker' => "This opens a REPL (Read, Evaluate, Print and Loop) environment.\nYou should not run this command with chain commands.", | ||
| 'vendor:publish' => "This is an interactive command.\nYou should not run this command with chain commands.", | ||
| 'schedule:work' => "Starts the schedule worker.\nYou should not run this command with chain commands.", | ||
| 'queue:work' => "Starts processing jobs on the queue as a daemon.\nYou should not run this command with chain commands.", | ||
| 'queue:restart' => "Restarts queue worker daemons after their current job.\nYou should not run this command with chain commands.", | ||
| 'queue:listen' => "Listens to a given queue.\nYou should not run this command with chain commands." | ||
| ``` | ||
|
|
||
| Artisan chain command will ignore these commands for the reasons outlined in the table above. | ||
|
|
||
| ## Contributing | ||
| This is opensource and contributions are highly welcome. | ||
|
|
||
| ## License | ||
| MIT |