Allow --repo option & --migration-dir for phx.gen.schema #4905
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
MikaAK
force-pushed
the
repo-for-gen-schema
branch
4 times, most recently
from
792263c to
2a1c686
Compare
MikaAK
changed the title
MikaAK
force-pushed
the
repo-for-gen-schema
branch
from
2a1c686 to
51acddd
Compare
josevalim
reviewed
Oct 4, 2023
lib/mix/tasks/phx.gen.schema.ex
Outdated
Comment on lines
98
to
99
| Generated migrations can be added to a specific `migration-dir` which sets the | ||
| migration folder path |
There was a problem hiding this comment.
Suggested change
| Generated migrations can be added to a specific `migration-dir` which sets the | |
| migration folder path | |
| Generated migrations can be added to a specific `--migration-dir` which sets the | |
| migration folder path: |
josevalim
reviewed
Oct 4, 2023
lib/mix/tasks/phx.gen.schema.ex
Outdated
| ## repo | ||
|
|
||
| Generated migration can use `repo` to set the migration repository | ||
| folder with option `--repo`. |
There was a problem hiding this comment.
Suggested change
| folder with option `--repo`. | |
| folder with option `--repo`: |
Gazler
force-pushed
the
repo-for-gen-schema
branch
from
51acddd to
661cf51
Compare
josevalim
reviewed
Oct 4, 2023
lib/mix/tasks/phx.gen.schema.ex
Outdated
Comment on lines
212
to
222
| case Map.new(opts) do | ||
| %{migration_dir: migration_dir} -> | ||
| migration_dir | ||
|
|
||
| %{repo: _} -> | ||
| repo_name = repo |> Module.split() |> List.last() |> Macro.underscore() | ||
| Mix.Phoenix.context_app_path(ctx_app, "priv/#{repo_name}/migrations/") | ||
|
|
||
| _ -> | ||
| Mix.Phoenix.context_app_path(ctx_app, "priv/repo/migrations/") | ||
| end |
There was a problem hiding this comment.
Not sure converting to a map for this is worth it, but this code is not perf critical anyway. But in case you want something else:
Suggested change
| case Map.new(opts) do | |
| %{migration_dir: migration_dir} -> | |
| migration_dir | |
| %{repo: _} -> | |
| repo_name = repo |> Module.split() |> List.last() |> Macro.underscore() | |
| Mix.Phoenix.context_app_path(ctx_app, "priv/#{repo_name}/migrations/") | |
| _ -> | |
| Mix.Phoenix.context_app_path(ctx_app, "priv/repo/migrations/") | |
| end | |
| cond do | |
| migration_dir = opts[:migration_dir] -> | |
| migration_dir | |
| opts[:repo] -> | |
| repo_name = repo |> Module.split() |> List.last() |> Macro.underscore() | |
| Mix.Phoenix.context_app_path(ctx_app, "priv/#{repo_name}/migrations/") | |
| true -> | |
| Mix.Phoenix.context_app_path(ctx_app, "priv/repo/migrations/") | |
| end |
The `repo` and `migration-dir` options change the location of the migrations directory, either to the specified directory or one that matches the repo name (underscored). The default is explicitly set to "repo" if neither option is set, to ensure backwards compatability even if the repo has a different name than the typical `MyApp.Repo`.
Gazler
force-pushed
the
repo-for-gen-schema
branch
from
661cf51 to
05c83f4
Compare
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 allows us to provide a
--repoflag tomix phx.gen.schemaIt seems support is already built in for this with
Mix.Phoenix.Schemaso I simply added it to theoptsin the format it seems is expected and made it utilise thatrepofor the migration path as wellThrough options i've also added a
--migration_dirwhich is passed in and used instead of the generated repo pathIf this is wanted lemme know and I'll add tests to get it merged