Validate name when instantiating template #740
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
Signed-off-by: itowlson <[email protected]>
fibonacci1729
approved these changes
Sep 7, 2022
kate-goldenring
approved these changes
Sep 7, 2022
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.
Fixes #739.
Output:
Notes for reviewers:
This validates in the CLI, rather than in the template crate itself. Is this reasonable or should we push the validation into that shared core?
This makes no consideration for language-specific naming rules. E.g. if a language used the name only for directory and component names, this restriction would be unnecessary. Is this okay or should we move the validation somewhere that understands per-language or per-template constraints?
This forbids problematic names. An alternative approach would be to transform them into legal ones, which could be done via Liquid filters in the templates (again allowing more language-specific understanding) - e.g. transform
34tospinapp34. What do we prefer?Signed-off-by: itowlson [email protected]