Enhance --model-dir to support glob patterns
#213
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
Allows the `model_dir` option to accept glob patterns, enabling more flexible model directory specification. It also improves error messages when specified files are not found in the matched directories. The changes ensure correct file path resolution when using glob patterns and relative paths.
|
OMG... I worked on the same task without knowing there was a PR #198 😂 |
|
@ether-moon I just merged in #198, and will by deploying a new version soon. Please test it and let me know if this needs to be reviewed after |
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 PR enhances the
--model-diroption in themodelscommand to support glob patterns, providing more flexibility in specifying model directories.Problem:
Currently, the
--model-diroption only accepts a comma-separated list of explicit directory paths. This can be cumbersome in projects with complex or non-standard directory structures, such as Packwerk-style modular monoliths or other setups using multiple directories under anapps/orcomponents/folder. Users cannot easily target multiple model directories scattered across different components using wildcard patterns without listing each one individually.Solution:
This PR modifies the
AnnotateRb::ModelAnnotator::ModelFilesGetterclass to:--model-diras a potential glob pattern.Dir.globto find all directories matching the provided patterns..rbfiles within each of the matched directories (respecting the--ignore-model-subdirectsoption).This allows users to specify directories like
components/*/app/modelsorapps/**/modelsto include models from various locations within the project structure, significantly simplifying configuration for modular applications.Changes Included:
lib/annotate_rb/model_annotator/model_files_getter.rbto implement glob pattern handling.spec/lib/annotate_rb/model_annotator/model_files_getter_spec.rbspecifically covering various glob pattern scenarios (simple star, recursive glob, combination with regular paths, interaction with--ignore-model-subdirects, handling non-matching patterns, and interaction with specified file arguments).README.mdto document the new glob pattern support for the--model-diroption.Testing:
All existing and newly added RSpec tests for
ModelFilesGetterpass, ensuring the new functionality works as expected and does not break existing behavior.