Allow creation of "flat" modules #13
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds the option "--flat" to the mezzio:module:create command. When present, the command will not create the nested "src" directory under the module root directory, nor will it create a "templates" directory, either. Functionality is incomplete; currently, the command proxies to laminas-composer-autoloading, which expects the nested directory when creating autoloading rules. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
The laminas-composer-autoloading package only allows the Mezzio "recommended" module structure (i.e., the version that has "src" and "templates" subdirectories). To allow flat module structures, the mezzio:module:register command needs to be able to detect the type of module present based on the directory layout, and then register it correctly with the package. Since this functionality is specific to Mezzio, I decided to inline the logic from laminas-composer-autoloading for parsing and updating the `composer.json` file, and to switch to symfony/process for executing the actual `composer` binary for running the `dump-autoload` process. To make the above testable, I created a few interfaces, as well as default implementations. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch implements the ability to create a module with a "flat" structure.
While the recommended structure for modules is still the default, the Mezzio skeleton app also allows creating "flat" modules that contain only source code (no templates, tests, assets, or other items); this is particularly of interest when creating application-specific, API-facing modules where tests may exist at the application level, and no templates are needed.
As such, this patch now adds a "--flat" option to
mezzio:module:createwhich will allow generating this simpler flat structure.In order to allow this, I needed to migrate away from consuming laminas-composer-autoloading for enabling/disabling autoloader rules for modules.
The reason is because laminas-composer-autoloading assumes a laminas-mvc structured module, which coincides with our recommended structure.
Since the flat structure is not part of the MVC ecosystem, it becomes specific to this Mezzio tooling, and thus requires "in-lining" the functionality.
In reality, it is a completely new approach to handling the tasks, and was written from the ground-up with testing in mind.
As such, this patch:
mezzio:module:registerandmezzio:module:deregistercommands to use the new functionality.Fixes #12