https://github.com/thewalkingcoder/maker-bundle
Wrap maker bundle to introduce "context option" to change destination template
https://github.com/thewalkingcoder/maker-bundle
maker symfony
Last synced: 16 days ago
JSON representation
Wrap maker bundle to introduce "context option" to change destination template
- Host: GitHub
- URL: https://github.com/thewalkingcoder/maker-bundle
- Owner: thewalkingcoder
- Created: 2020-04-21T08:32:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-26T16:46:42.000Z (about 1 year ago)
- Last Synced: 2026-03-04T09:27:14.685Z (22 days ago)
- Topics: maker, symfony
- Language: PHP
- Homepage:
- Size: 85 KB
- Stars: 14
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TwcMakerBundle
When your symfony architecture is different like (ddd, cqrs, adr, custom architecture) you lost the powerfull of makerBundle,
because directory structure is not at the same place.
TwcMakerBundle try to revolve that, to wrap maker command and introduce "context" option.
## Installation
```bash
composer require twc/maker-bundle --dev
```
## Basic Usage
### Generic configuration
```yaml
#config/packages/dev/twc_maker.yaml
twc_maker:
componentName:
- { context: 'contextName', target: 'Your\SpecificNamespace' }
- { context: 'contextName1', target: 'Your\SpecificNamespace' }
- ...
```
### Specific configuration
#### Component entity
for entity component you must use ***target_entity*** and ***target_repository*** instead ***target***
```yaml
#config/packages/dev/twc_maker.yaml
twc_maker:
entity:
- { context: 'contextName', target_entity: 'Your\SpecificEntityNamespace', target_repository: 'Your\SpecificRepositoryNamespace' }
```
#### Component controller
for controller you can specific ***dir*** to change generation folder (default contextName)
```yaml
#config/packages/dev/twc_maker.yaml
twc_maker:
controller:
- { context: 'contextName', target: 'Your\SpecificNamespace', dir: 'my/custom/directory/template' }
```
### Console
TwcMakerBundle wrap maker command and add new option ***--context*** (shortcut -c)
### Sample with CQRS concept
```yaml
#config/packages/dev/twc_maker.yaml
twc_maker:
message:
- { context: 'post.command', target: 'App\Post\Application\Command' }
- { context: 'post.query', target: 'App\Post\Application\Query' }
```
in your console
```bash
php bin/console make:twc:message NewPost --context=post.command
php bin/console make:twc:message AllPostsArchivedQuery --context=post.query
```
```bash
#shortcut version
php bin/console make:twc:message NewPost -c post.command
php bin/console make:twc:message AllPostsArchivedQuery -c post.query
```
results
```bash
created: src/Post/Application/Command/NewPost.php
created: src/Post/Application/Command/NewPostHandler.php
created: src/Post/Application/Query/AllPostArchivedQuery.php
created: src/Post/Application/Query/AllPostArchivedQueryHandler.php
```
### Sample with DDD concept
```yaml
#config/packages/dev/twc_maker.yaml
twc_maker:
entity:
- { context: 'membership', target_entity: 'App\MemberShip\Domain\Entity', target_repository: 'App\MemberShip\Infrastructure\Doctrine\Repository' }
controller:
- { context: 'membership', target: 'App\MemberShip\Presenter\Controller' }
form:
- { context: 'membership', target: 'App\MemberShip\Presenter\Form' }
```
in your console
```bash
php bin/console make:twc:entity UserMembership -c membership
```
result
```bash
created: src/Membership/Domain/Entity/UserMemberShip.php
created: src/Membership/Infrastructure/Doctrine/Repository/UserMemberShipRepository.php
```
## Troubleshooting
### Specific directory not created
If your specific directory not created, clean cache and retry.
```bash
php bin/console c:c
```
### Could not determine where to locate the new class
If you have error message like
```bash
Could not determine where to locate the new class "xxx" maybe try with a full namespace like
```
Check your composer.json with PSR-4 config, maybe you need to add your namespace, or try with ` App\ `
## Support
Actually TwcMakerBundle wrap 9 components
| components |
|------------|
| controller |
| validator |
| form |
| message |
| messenger-middleware |
| voter |
| command |
| fixtures |
| entity |