Repository navigation
docs(readme): align the readme with the code - #54
Merged
Merged
Conversation
This file contains hidden or 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
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.
I checked the README line by line against the commands, the traits and the stubs. Docs only, no code changes.
Wrong, now fixed
getStub()only reads the stubs of the package, so published ones have no effect. The section is removed, the config tag is still documented further down.clean-arch:make-domain Userwas the running example. On a Laravel app theUsermodel, its factory and theusersmigration already exist. The example is nowProduct, with a pointer to--user-in-domain.make-controllerandmake-serviceamong the commands that read it. Their stubs never import the model.--user-in-domain:bootstrap/was missing from the rewritten folders, the rule for removingapp/Modelsandapp/Httpwas imprecise, and the third refusal case (noUserto move) was missing.clean-arch:installrestores theApp\entry when it is missing.clean-arch:generate-packagehas a--path=option that was not listed.Userinto the Domain in an existing app".Added
make-*command writes, plus the naming rules the README never stated (suffixes are not doubled,make-listenerwrites*EventListener.php,make-controllerdefaults to API).make-domainwrites outsideapp/.Anchors
Two anchors changed (
configuration-1and the generated structure heading). Hidden anchors keep the old ones working, checked against GitHub's markdown renderer.CHANGELOG not touched.