Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikeerickson/laravel-craftsman
Laravel Craftsman CLI for easily crafting Laravel assets for any project (artisan make on steroids)
https://github.com/mikeerickson/laravel-craftsman
artisan craft craftsman generator hacktoberfest hacktoberfest2020 laravel
Last synced: 12 days ago
JSON representation
Laravel Craftsman CLI for easily crafting Laravel assets for any project (artisan make on steroids)
- Host: GitHub
- URL: https://github.com/mikeerickson/laravel-craftsman
- Owner: mikeerickson
- License: mit
- Created: 2019-03-19T18:29:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-09T00:28:23.000Z (almost 4 years ago)
- Last Synced: 2024-08-04T01:18:24.184Z (3 months ago)
- Topics: artisan, craft, craftsman, generator, hacktoberfest, hacktoberfest2020, laravel
- Language: PHP
- Homepage:
- Size: 48.5 MB
- Stars: 230
- Watchers: 7
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-laravel-zero - Laravel Craftsman
README
# Laravel Craftsman
## Description
Laravel Craftsman (written using the awesome [Laravel-Zero](https://www.laravel-zero.com) CLI builder) provides a suite of crafting assets using a project agnostic CLI.
You can quickly create `class`, `command`, `controller`, `event`, `factory`, `form-request`, `listener`, `migration`, `model`, `resource`, `rule`, `seed`, `test` and `view` assets.
In addition, you can create all assets with a single command, allowing you to quickly craft a new resource in seconds!
📝 [Laravel News Article](https://laravel-news.com/laravel-craftsman-cli)
📦 [Packagist](https://packagist.org/packages/codedungeon/laravel-craftsman)
## Table Of Conents
- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [Tips](#tips)
- [Custom Templates](#custom-templates)
- [License](#license)
- [Credits](#credits)
## Installation
### Using Composer
```bash
> composer global require codedungeon/laravel-craftsman
```
### Using curl/wget
```bash
> curl -o laravel-craftsman https://github.com/mikeerickson/laravel-craftsman/archive/master.zip
or
> wget https://github.com/mikeerickson/laravel-craftsman/archive/master.zip
```
## Usage
```bash
> laravel-craftsman [options] [arguments]
> laravel-craftsman interactive
> laravel-craftsman interactive --silent
> laravel-craftsman publish
> laravel-craftsman publish --overwrite
> laravel-craftsman craft:all Post --model App/Models/Post --tablename posts --rows 50 --extends layouts.app --section content
> laravel-craftsman craft:api --model App/TestClass --overwrite
> laravel-craftsman craft:class App/TestClass --constructor
> laravel-craftsman craft:controller PostController --model App/Models/Post
> laravel-craftsman craft:event ContactCreated
> laravel-craftsman craft:event ContactCreated --no-broadcast
> laravel-craftsman craft:factory PostFactory --model App/Models/Post
> laravel-craftsman craft:migration create_posts_table --table posts
> laravel-craftsman craft:model App/Models/Post --table posts
> laravel-craftsman craft:model App/Models/Post --table posts --migration
> laravel-craftsman craft:request CustomerRequest --rules "title?required|unique|posts,body?required"
> laravel-craftsman craft:rule Uppercase
> laravel-craftsman craft:seed PostTableSeeder --model App/Models/Post --rows 100
> laravel-craftsman craft:views authors --extends partials.master --section content
```
## Commands
The following commands are available in any Laravel project. You can use the individual crafting routines which are similar to the Artisan commands, but the `craft:all` command is the most powerful of the bunch.
Using `craft:all` you can easily generate all assets (controller, factory, migration, model, and seed) for a given resource (ie Post, Customer, etc)
```bash
laravel-craftsman craft:all Contact \
--model App/Models/Contact \
--tablename contacts \
--rows 50 \
--fields "first_name:string@30:nullable,last_name:string@50:nullable,email:string@80:nullable:unique"
```
🚩Required Parameter / Option
| Command | Name / Option | Description |
| -------------------- | --------------------- | ----------------------------------------------------------------------------------- |
| **interactive** | | **Run Interactive Mode (uses wizard to craft resources** |
| | --silent, -s | Skips Wizard Instructions |
| **publish** | | **Publish templates to project diretory** |
| | | _==> all craft:xxx commands will use project template if it exists_ |
| | --skip-config, -c | Skip publishing craftsman configuration file |
| | --overwrite, -o | Overwrites published templates directory |
| **craft:api** | | **Craft API Resources (create model, controller, factory, migration, seed)** |
| | **🚩 base name** | Based resource name for all assets (example Contact) |
| | **🚩 --model, -m** | Path to model (eg App/Models/Post) |
| | --table, -t | Tablename used in database (will set \$tablename in Model) |
| | | _If not supplied, default table will be pluralized model name_ |
| | --rows, -r | Number of rows used by seed when using Factory |
| | --current, -u | Use --useCurrent for timestamps when creating migration |
| | --no-model, -o | Do not create model |
| | --no-controller, -c | Do not create controller |
| | --no-factory, -f | Do not create factory |
| | --no-migration, -g | Do not create migration |
| | --no-seed, -s | Do not create seed |
| | --overwrite, -w | Overwrite existing class |
| **craft:all** | | **Creates all assets (Controller, Factory, Migration, Model, Seed)** |
| | **🚩 base name** | Based resource name for all assets |
| | **🚩 --model, -m** | Path to model (eg App/Models/Post) |
| | --tablename, -t | Tablename used in database (will set \$tablename in Model) |
| | | _If not supplied, default table will be pluralized model name_ |
| | --rows, -r | Number of rows used by seed when using Factory |
| | --extends, -x | View extends block (optional) |
| | --section, -i | View section block (optional) |
| | --no-controller, -c | Do not create controller |
| | --no-factory, -a | Do not create factory |
| | --no-migration, -g | Do not create migration |
| | --no-model, -o | Do not create model |
| | --no-seed, -s | Do not create seed |
| | --no-views, -e | Do not create seed |
| **craft:class** | | **Creates empty class** |
| | **🚩 class name** | Class path (eg App/Services/MyService) |
| | --constructor, -c | Include constructor method |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:command** | | **Creates Artisan Command class** |
| | **🚩 command name** | Command name |
| | --signature, -s | Command Signature |
| | --description, -d | Command Description |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:controller** | | **Create controller using supplied options** |
| | **🚩 controller name** | Controller Name |
| | --model, -m | Path to model (eg App/Models/Post) |
| | --validation, -l | Create validation blocks where appropriate |
| | --api, -a | Create API controller (skips create and update methods) |
| | --binding, -b | Include route / model binding (requires model property) |
| | --empty, -e | Create empty controller |
| | --resource, -r | Create resource controller |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:event** | | **Creates event class** |
| | **🚩 event name** | Event Name |
| | --listener, -l | Generate Listener |
| | --no-broadcast, -b | Skips broadcast code when event class created |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:factory** | | **Creates factory using supplied options** |
| | **🚩 factory name** | Factory Name |
| | --model, -m | Path to model (eg App/Models/Post) |
| **craft:listener** | | **Creates listener class** |
| | **🚩 listener name** | Listener Name |
| | --event, -e | The event class be listener for |
| | --queued | Indicates the event listener should be queued |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:migration** | | **Creates migration using supplied options** |
| | **🚩 migration name** | Migration Name (eg create\*contacts_table) |
| | **--model, -m** | Path to model (required) |
| | --table, -t | Tablename used in database (will set \$tablename in Model) |
| | | \_If not supplied, default table will be pluralized model name\* |
| | --fields, -f | List of fields (option) _see syntax below_ |
| | | **🚨 If you have spaces separating fields, you must surround fields list in quotes** |
| | --foreign, -r | Add foreign key constraint (foreign info) _see syntax below_ |
| | --current, -u | Use --useCurrent for timestamps (skipped by default) |
| | --down, -d | Include down methods (skipped by default) |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:model** | | **Creates model using supplied options** |
| | **🚩 model name** | Model Name (eg Contact or App/Models/Contact) |
| | | _See below about defining alternate model path_ |
| | --all, -a | Generate a migration, factory, and controller for the model |
| | --table, -t | Tablename used in database (will set \$tablename in Model) |
| | | _If not supplied, default table will be pluralized model name_ |
| | --template, -m | Path to custom template (override config file) |
| | --controller, -c | Create a new controller |
| | --factory, -f | Create factory |
| | --migration, -m | Create a new migration file file |
| | --seed, -s | Create a new seed file file |
| | --overwrite, -w | Overwrite existing class |
| **craft:request** | | **Creates form request using supplied options** |
| | **🚩 request name** | Request Name |
| | | _See below about defining alternate model path_ |
| | --rules, -r | List of rules (optional) |
| | | **🚨 If you have spaces separating fields, you must surround rules lists in quotes** |
| | --template, -m | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:rule** | | **Creates validation rule** |
| | **🚩 Rule Name** | Rule Name (eg Uppercase) |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:seed** | | **Creates seed file using supplied options** |
| | **🚩 Seed Name** | Seed Name (eg ContactTableSeeder) |
| | **🚩 --model, -m** | Path to model (eg App/Models/Post) |
| | --factory, -f | Create Factory (if it does not already exists) |
| | --rows, -r | Number of rows to use in factory call (Optional) |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:test** | | **Creates seed file using supplied options** |
| | **🚩 Test Name** | Test Name (eg CreateFileTest) |
| | --setup, -s | Include setUp method |
| | --teardown, -d | Include tearDown method |
| | --unit, -u | Create unit test (default will be Feature test) |
| | --pest, -p | Create Pest test |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:views** | **🚩 base resource** | **Seed name** |
| | --setup, -s | Include setup block |
| | --teardown, -d | Include tearDown block |
| | --unit, -u | Create unit test |
| | --template, -t | Path to custom template (override config file) |
| | --overwrite, -w | Overwrite existing class |
| **craft:views** | **🚩 base resource** | **Creates view files** |
| | --extends, -x | Includes extends block using supplied layout |
| | --section, -s | Includes section block using supplied name |
| | --no-create, -c | Exclude create view |
| | --no-edit, -d | Exclude edit view |
| | --no-index, -i | Exclude index view |
| | --no-show, -w | Exclude show view |
### Defining Class Path
When crafting resources which are not automatically created in their assigned directories, you can define the location to the path where asset is created as follows:
```bash
> laravel-craftsman craft:class App/Services/Sync ...
```
This will create a class in the `App/Services` path, with filename `Sync.php`. Directories (including nested directories) will be created if they do not already exists.
#### Supported Commands
The following commands support defining class path
- craft:class
- craft:event
- craft:factory
- craft:listener
- craft:model
- craft:seed
- craft:test
- craft:views
### 📝 Template Access
Laravel Craftsman will use sensible default templates which are located in the `laravel-craftsman` installation location. If you wish to have greater control over templates, you can publish (see `laravel-craftsman publish` command) default templates into the project directory (`/templates`).
Subsequent `laravel-craftsman craft:xxx` commands will first look in the project templates directory, if template not found, then it will use the application templates.
#### Single Use Templates
In addition to the standard templates, you may also define a single use template which is only used during command execution. Single use templates are designed to reference project specific templates, and you use the `` keyword when executing the desire command.
```bash
> laravel-craftsman craft:class App/Services/SyncService --template "/templates/service.mustache" ...
```
### oh-my-zsh Conflict
If you have `oh-my-zsh` installed, make sure you wrap template value in quotes, otherwise you may receive an error
```bash
laravel-craftsman craft:class TestService --template /templates/custom.mustache --overwrite
zsh: no such file or directory: project
```
### Foreign Key Syntax
When using the `--foreign` option when building migrations, you should use the following syntax:
```bash
format:
foreignKey:primaryId,primaryTable
example:
--foreign=post_id:id,posts
-r=post_id:id,posts
```
Alternatively, you can supply just the foreign key part (using table_key format) and it will be used to extract the primary table and key.
The primary table will be a plural version of the first part, followed by the primary key id.
```bash
--foreign=post_id
```
will be translated internally to use the full `--foreign` format
```bash
--foreign=post_id:id,posts
```
#### Automatic foreign key field creation
When using the `--foreign` flag, the appropriate field will be added automatically in migration file.
For example, if the `--foreign post_id` flag is supplied, the following will be added to new migration
```php
...
Schema::create('comments', function (Blueprint $table) {
$table->bigIncrements('id');
$table->unsignedBigInteger('post_id');
...
$table->foreign('post_id')->references('id')->on('posts');
});
...
```
### Field Option Syntax
When using the `--fields` option when building migrations, you should use the following syntax:
Note: If you have used teh `--foreign` flag as outlined above, the foreign key field will be added automatically
```bash
format:
fieldName:fieldType@fieldSize:option1:option2:option3
example:
email:string@80:nullable:unique
--fields "fname:string@25:nullable,lname:string@50:nullable,email:string@80:nullable:unique,dob:datetime,notes:text,deleted_at:timezone"
Schema::create('contacts', function (Blueprint $table) {
$table->bigIncrements('id');
$table->timestamps();
$table->string('fname', 25)->nullable();
$table->string('lname', 50)->nullable();
$table->string('email', 80)->nullable()->unique();
$table->datetime('dob');
$table->text('notes');
$table->timezone('deleted_at');
});
```
### Rules Option Syntax
When using the `--rules` option when building form requests, you should use the following syntax:
```bash
format:
ruleName?rule1|rule2|rule3,ruleName2?rule1|rule2
```
```bash
> laravel-craftsman craft:request CustomerRequest --rules "title?required|unique|posts,body?required"
```
Produces the following
```php
public function rules()
{
return [
"title" => "required|unique|posts",
"body" => "required",
];
}
```
## Tips
💡 **Boolean Option Shortcut**
When executing any of the `laravel-craftsman` commands, if you wish to apply one or more switches (those options which do not require a corresponding value), you can use the standard CLI shorthands (this tip can be used in any CLI based tool, not just `laravel-craftsman` (well assuming the CLI actually supports shorthand).
For example:
Lets assume you wish to wish to create `views`, you can use the following command to skip creation of the create (-c), edit (-d) and show (-w) views (only creating the index view). The combination of `-cdw` is shorthand for `--no-create --no-edit --no-show`
```bash
> laravel-craftsman craft:views --extends layouts.app --section content -cdw
```
is same as
```bash
> laravel-craftsman craft:views --extends layouts.app --section content --no-create --no-edit --no-show
> laravel-craftsman craft:views --extends layouts.app --section content -c -d -w
```
💡 **Defining Nested Paths**
Any command can store assets within tested folders within default path by separating `name` argument with forward slash
For example, the following command will define the path for model asset in the `App/Models/` path
```bash
> laravel-craftsman App/Models/Customer ...
```
## Custom Templates
Laravel Craftsman provides support for creating custom templates if you wish to change the syntax to match your personal style. The default templates use the standard Laravel syntax, but we like to allow ou have your own flair (see `laravel-craftsman publish` for greater template control).
📝 **User Custom Templates**
If you wish to create derivatives of the supported templates, you can customize the `config.php` located in the `laravel-craftsman` directory.
By default, this will be `~/.composer/vendor/codedungeon/laravel-craftsman`, but may be different depending on the method you chose to install laravel-craftsman.
```php
'templates' => [
'class' => 'user_templates/class.mustache',
'api-controller' => 'user_templates/api-controller.mustache',
'binding-controller' => 'user_templates/binding-controller.mustache',
'empty-controller' => 'user_templates/empty-controller.mustache',
'command' => 'user_templates/command.mustache',
'controller' => 'user_templates/controller.mustache',
'events' => 'user_templates/event.mustache',
'factory' => 'user_templates/factory.mustache',
'listener' => 'user_templates/listener.mustache',
'migration' => 'user_templates/migration.mustache',
'model' => 'user_templates/model.mustache',
'request' => 'user_templates/request.mustache',
'rule' => 'user_templates/rule.mustache',
'seed' => 'user_templates/seed.mustache',
'test' => 'user_templates/tested.mustache',
'view-create' => 'user_templates/view-create.mustache',
'view-edit' => 'user_templates/view-edit.mustache',
'view-index' => 'user_templates/view-index.mustache',
'view-show' => 'user_templates/view-show.mustache',
],
```
📝 **Single Use Template**
In addition to creating templates and configuring the `config.php` file, you may optionally supply a template to be used as single use (not stored) from all command execution
For example, if you wish to create a standard class asset, you can use a single use template as follows:
Placeholder to represent current project directory
./ Placeholder to represent current project directory
Placeholder to computer root directory
```bash
> laravel-craftsman craft:class App/Services/Syncronize --template "/templates/service.mustache"
> laravel-craftsman craft:class App/Services/Syncronize --template "./templates/model.mustache"
> laravel-craftsman craft:class App/Services/Syncronize --template "/templates/model.mustache"
```
📝 **Template Variables**
The following variables can be used in any of the supported templates (review the `templates` directory for a basis of how to create custom templates)
| Variable Name | Templates which variable is used |
| ------------- | ------------------------------------------------------------------------------------------- |
| `binding` | Used by `binding controller` |
| `fields` | Used by `migration` |
| `model` | Used by `api-controller`, `class`, `controller`, `factory`, `migration`, `model` and `seed` |
| `model_path` | Used by `api-controller`, `controller`, `factory`, `migration`, `seed` |
| `name` | Used by `event`, `listener`, `rule`, `api-controller`, `controller` and `empty-controller` |
| `namespace` | Used by `class`, `model` |
| `num_rows` | Used by `seed` |
| `rules` | Used by `request` |
| `tablename` | Used by `controller`, `migration`, `model` |
| `extends` | Used by `views` |
| `section` | Used by `views` |
| `foreign` | Used by `migration` |
| `current` | Used by `migration` |
## License
Copyright © 2019-2020 Mike Erickson
Released under the MIT license
## Credits
laravel-craftsman written by Mike Erickson
E-Mail: [[email protected]](mailto:[email protected])
Twitter: [@codedungeon](http://twitter.com/codedungeon)
Website: [codedungeon.io](http://codedungeon.io)