Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soyhuce/laravel-somake
An opinionated package to generate classes in your Laravel project
https://github.com/soyhuce/laravel-somake
hacktoberfest laravel stubs
Last synced: about 2 months ago
JSON representation
An opinionated package to generate classes in your Laravel project
- Host: GitHub
- URL: https://github.com/soyhuce/laravel-somake
- Owner: Soyhuce
- License: mit
- Created: 2022-03-09T10:03:37.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T08:00:39.000Z (2 months ago)
- Last Synced: 2024-11-21T08:28:33.328Z (2 months ago)
- Topics: hacktoberfest, laravel, stubs
- Language: PHP
- Homepage:
- Size: 196 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# An opinionated package to generate classes in your Laravel project
[](https://packagist.org/packages/soyhuce/laravel-somake)
[](https://github.com/soyhuce/laravel-somake/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/soyhuce/laravel-somake/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://github.com/soyhuce/laravel-somake/actions?query=workflow%3A"PHPStan"+branch%3Amain)
[](https://packagist.org/packages/soyhuce/laravel-somake)
A set of commands to easily generate classes on the right place.
## Installation
You can install the package via composer:
```bash
composer require --dev soyhuce/laravel-somake
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="somake-config"
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="somake-views"
```
## Usage
The commands of this package do not offer options, or the options are designed to be used internally only.
The configuration of generated classes is done via interactive questions.
### App
| Commande | Description | Generation path |
|---------------------|-------------|--------------------------------------------------|
| `somake:command` | Commande | `app/App/Commands` |
| `somake:controller` | Controller | `app/App/[application]/Controllers/[namespace?]` |
| `somake:middleware` | Middleware | `app/App/[application]/Middleware/[namespace?]` |
| `somake:request` | Request | `app/App/[application]/Requests/[namespace?]` |
| `somake:resource` | Resource | `app/App/[application]/Resources/[model domain]` |
### Domain
| Commande | Description | Generation path |
|-----------------------|------------------|-------------------------------------|
| `somake:action` | Action | `app/Domain/[domain]/Actions` |
| `somake:builder` | Eloquent Builder | `app/Domain/[domain]/Builders` |
| `somake:data` | Data | `app/Domain/[domain]/Data` |
| `somake:enum` | Enum | `app/Domain/[domain]/Enums` |
| `somake:event` | Event | `app/Domain/[domain]/Events` |
| `somake:listener` | Listener | `app/Domain/[domain]/Listeners` |
| `somake:model` | Model | `app/Domain/[domain]/Models` |
| `somake:notification` | Notification | `app/Domain/[domain]/Notifications` |
| `somake:policy` | Policy | `app/Domain/[domain]/Policies` |
### Support
| Commande | Description | Generation path |
|---------------------|------------------|--------------------------------------------|
| `somake:enum` | Enum | `app/Support/Enums` |
| `somake:middleware` | Middleware | `app/Support/Http/Middleware/[namespace?]` |
| `somake:provider` | Service Provider | `app/Support/Providers` |
### Other
| Commande | Description | Generation path |
|--------------------|-----------------|---------------------------------------------|
| `somake:factory` | Model factory | `database/factories/[modelDomain]` |
| `somake:migration` | Migration | `database/migrations/[migration]` |
| `somake:test` | Test - contract | `tests/Contract/[application]/[controller]` |
| `somake:test` | Test - feature | `tests/Feature/[application]/[controller]` |
| `somake:test` | Test - unit | `tests/Unit/[classDomain]` |
### Open created files in your IDE
To open created files in your IDE, you can just need to define the `somake.ide_path` config with the binary path of your IDE.
You can also define the `IDE` environment variable (in your `.env` file for exemple).
```bash
IDE=/usr/bin/phpstorm
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Bastien Philippe](https://github.com/bastien-phi)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.