twc/maker-bundle

Wrap maker bundle to introduce context option to change destination template

v1.1.3 2023-05-09 13:09 UTC

Requires

• php: ^7.2|^8.0
• doctrine/annotations: ^1.13|^2.0
• symfony/maker-bundle: ^1.0

Requires (Dev)

• doctrine/doctrine-fixtures-bundle: ^3.3
• phpunit/phpunit: ^7.0|^9.5
• symfony/filesystem: ^5.0|^6.0
• symfony/finder: ^5.0|^6.0
• symfony/form: ^5.0|^6.0
• symfony/messenger: ^5.0|^6.0
• symfony/orm-pack: ^1.0|^2.3
• symfony/security-core: ^5.0|^6.0
• symfony/twig-pack: ^1.0
• symfony/validator: ^5.0|^6.0
• symfony/yaml: ^5.0|^6.0

MIT

README

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

composer require twc/maker-bundle --dev

Basic Usage

Generic configuration

#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

#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)

#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

#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

php bin/console make:twc:message NewPost --context=post.command
php bin/console make:twc:message AllPostsArchivedQuery --context=post.query

#shortcut version
php bin/console make:twc:message NewPost -c post.command
php bin/console make:twc:message AllPostsArchivedQuery -c post.query

results

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

#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

php bin/console make:twc:entity UserMembership -c membership

result

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.

php bin/console c:c 

Could not determine where to locate the new class

If you have error message like

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