https://github.com/nooqta/laravel-kodyfire
A code generation tool to Laravel artisans using kodyfire-cli
https://github.com/nooqta/laravel-kodyfire
generator kody kodyfire laravel templates
Last synced: about 1 month ago
JSON representation
A code generation tool to Laravel artisans using kodyfire-cli
- Host: GitHub
- URL: https://github.com/nooqta/laravel-kodyfire
- Owner: nooqta
- License: mit
- Created: 2022-12-07T03:54:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-17T00:20:55.000Z (almost 2 years ago)
- Last Synced: 2025-03-31T04:51:23.174Z (2 months ago)
- Topics: generator, kody, kodyfire, laravel, templates
- Language: TypeScript
- Homepage:
- Size: 365 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Laravel-kodyfire
[](https://github.com/nooqta/kodyfire#install-a-kody)
[](https://github.com/nooqta/kodyfire/blob/main/LICENSE)
> Generate Laravel models, migrations and more using [Kodyfire](https://github.com/nooqta/kodyfire).
### [Homepage](https://github.com/nooqta/kodyfire)
## Requirements
laravel-kodyfire requires the [kodyfire-cli](https://github.com/nooqta/kodyfire) to be installed
```sh
npm install -g kodyfire-cli
```
## Install
```sh
npm i laravel-kodyfire
```
## Usage
### Method 1: As a generator
In order to generate your artifacts, run the `generate` command. The syntax is `kody generate|g [kody] [concept]`. If you ommit `kody` and `concept` the assistant will prompt you to select them. As an example, run the following command from your terminal:
```sh
kody generate laravel model
```
or you can you the shorthand generation command
```sh
kody g laravel:model YourModelName
```
The shorthand will execute without prompting if no additional arguments are required
You can also create related artifacts by providing the `--includes` option with a list of comma seperated artifacts
```sh
kody g laravel:model YourModelName --includes migration,seeder,factory
```
In order to list available concepts, run the following command:
```sh
kody ls laravel
```
To list available templates run:
```sh
kody ls laravel -s templates
```
To use a different template run
```sh
kody g laravel:model YourModelName --overwrites template:templateName
```
When providing a template name ommit the prefix and extension part of the template name. For example if the template name is `controller.api.php.template`, You should overwrite the template as follow:
```sh
kody g laravel:controller YourControllerlName --overwrites template:api
```
`--overwrites` are the concept arguments. In order to list available arguments of all concepts run the following command:
```sh
kody ls laravel -s overwrites
```
### Method 2: As an importer
You can use a source containing the definition of the artifacts you want to create at once. Available sources: yaml, plantuml(class diagram). As an example, A declaration for the yaml laravel source import file might look like the following
```yaml
models:
user:
fields:
name: string
email: string nullable unique
status: enum:active,inactive default:active
password,phone,role: string nullable
email_verified_at: timestamp nullable
hidden: password
relations:
belongsTo: Company
...
```
After adding your definitions, run the following command to import your assets.
```sh
kody import laravel migration,model -s import.yaml
```
### Using your own templates
Since every project has its specificity, you can always overwrite the default templates provided by the package.
In order to start using your own templates, you must publish the default templates into your root project under `.kody/laravel-kodyfire`.
To do so run
```sh
kody publish laravel
```
or
```sh
kody publish laravel templateName
```
if you want to overwrite a single template
After updating the published template content. Test drive your template by running
```sh
kody g model yourModelName
```
## Available concepts TODO
#### `concept` (default)
> Generates a generic concept
#### `model`
> Generates a model class
#### `controller`
> Generates a controller class
#### `request`
> Generates a request class
#### `resource`
> Generates a resource class
#### `collection`
> Generates a collection class
#### `event`
> Generates an event class
#### `listener`
> Generates a listener class
#### `subscriber`
> Generates a subscriber class
#### `observer`
> Generates a observer class
#### `policy`
> Generates a policy class
#### `factory`
> Generates a factory class
#### `seeder`
> Generates a seeder class
#### `test`
> Generates a test class
#### `testUnit`
> Generates a unit test class
#### `middleware`
> Generates a middleware class
#### `repository`
> Generates a repository class
##### Usage
```bash
kody g laravel yourConcept
```
##### Arguments
- `kody` _string_ - The name of the kody. Laravel in our case. You can also use the `kody:concept` syntax. You can have multiple kodies installed. To list your installed kodies within your project run `kody list`
- `concept` _string_ - The name of the concept you want to execute. if you've used the kody:concept syntax this argument will be considered the `name` argument and the command will not prompt you for additional arguments if there is no other required parameters. To list the concepts of your installed kody (laravel), run `kody list laravel`
- `name` _string_ - The name that will be used to generate your artifact.
##### Options
- `-i,--include ` Comma separated list of concepts to include. (e.g. -i concept1,concept2).
To list available concepts use the list command (e.g. kody list kodyname)
- `-o,--overwrites ` Overwrite some default schema like the template name you want to use
- `-m,--multiple` Generate multiple artifacts
- `-p,--persist` Persist the generated artifact
- `-h, --help` Display help for command
## 📅 Future Features
- ~~Incorporate Laravel default stubs as base templates~~
- ~~Generate migration: allow adding fields and relations~~
- ~~Import and generate models from a plantuml class diagram~~
## Author
Anis Marrouchi
* Website: https://noqta.tn
* Twitter: [@anis\_marrouchi](https://twitter.com/anis\_marrouchi)
* GitHub: [@anis-marrouchi](https://github.com/anis-marrouchi)
* LinkedIn: [@marrouchi](https://linkedin.com/in/marrouchi)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/nooqta/laravel-kodyfire/issues).
## Show your support
Give a ⭐️ if this project helped you!
## Credits
- [kodyfire](https://github.com/nooqta/kodyfire) by [nooqta](https://github.com/nooqta) The kodyfire generator.
## 📝 License
Copyright © 2022 [Anis Marrouchi](https://github.com/anis-marrouchi).
This project is [MIT](https://github.com/nooqta/kodyfire/blob/main/LICENSE) licensed.
***
_This README was generated with ❤️ by [readme-kodyfire](https://github.com/nooqta/readme-kodyfire)_