Define custom prefixes for creating new migrations #585
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
mmkal
reviewed
Feb 3, 2023
| async create(options: { | ||
| name: string; | ||
| folder?: string; | ||
| prefix?: 'TIMESTAMP' | 'DATE' | 'NONE'; | ||
| prefix?: MigrationPrefix; |
There was a problem hiding this comment.
It's a bit confusing having two places to setup the prefix. Can we deprecate this one with a warning message?
| * A function for generating custom prefixes for migration files when using `create`. If this is not specified the default date formats will | ||
| * be used ("1970.01.01T00.00.00" for TIMESTAMP, "1970.01.01" for DATE and "" for NONE) | ||
| */ | ||
| prefix?: (prefix: MigrationPrefix) => string; |
There was a problem hiding this comment.
Suggested change
| prefix?: (prefix: MigrationPrefix) => string; | |
| prefix?: (params: {name: string}) => string; |
I like this approach but we can go further. The MigrationPrefix type isn't really useful anymore. Let's deprecate it and just pass the name in and let the user define a function that does whatever they need. The default can still be the dot-separated date format that's currently used.
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 allows the user to specify a custom format for the filename prefix used when creating new migrations. This is currently only possible by returning a different filename from the
templatecallback, but this doesn't happen until after ordering is resolved and so can easily lead to "confusing ordering" issues. This is primarily motivated by wanting to avoid dots in the filename timestamp, but could be useful for other reasons too such as using a counter instead of a timestamp.