feat(default-path): change the default path to project's root #131
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
Currently, the library uses the app or src folders as the default path from the root path However, in Laravel projects, for example, there are many PHP files that are outside the app folder, such as migrations, seeders, factories, configurations file, the bootstrap folder, etc. This way, the user is forced to always use the path option, overriding the default path This commit changes the default path to the project root directly
c0nst4ntin
approved these changes
Feb 22, 2025
There was a problem hiding this comment.
@julio-cavallari I think this is a great pull request. Thanks a lot for taking this from our discussion to this feature.
It would need some changes to the documentation, and probably also some further things added to the base stub (eg. editorconfig etc.). But those are things the community and I can add after we get this merged!
I will try to get @nunomaduro to take a look at this.
|
@julio-cavallari I will merge this now. However before I tag the next version, I will try this in one or two of my larger projects to see what other words we might need to whitelist by default! Feel free to also experiment with this |
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.
What:
Description:
Currently, the library uses the app or src folders as the default path from the root path
However, in Laravel projects, for example, there are many PHP files that are outside the app folder, such as migrations, seeders, factories, configurations file, the bootstrap folder, etc. This way, the user is forced to always use the path option, overriding the default path
This PR changes the default path to the project root directly, and if the user wants a specific path, then he uses the
--pathoption to force the library to check that path.PS: Since peck now checks all project files, I needed to add some words to the base stub that made sense to me to be there, and add tests path to ignore on
peck.jsonRelated:
#130