Fix - Allow to use a dot_formatter config file in a different folder which imports dependencies #7328
Conversation
sascha-wolf
force-pushed
the
bug/mix-format-with-config-in-different-folder
branch
2 times, most recently
from
fae9f88
to
65167ee
Compare
…lder
The new test case builds on the "can read exported configuration from
dependencies"-test. It tests that `mix format` can be called with
`--dot-formatter ../.formatter.exs` when the `../.formatter.exs`
contains `import_deps: [:my_dep]`.
The `my_dep` dependency in turn can be found in `../deps/my_dep`.
Right now this test fails. It seems like `mix format` tries to load the
dependency from the workdir instead rather than from the same folder the
provided `.formatter.exs` resides.
TL;DR: mix format tries to load dependencies from the wrong folder, when
passing a `.formatter.exs` in another folder
…ctory This change fetches the folder from the provided dot_formatter config file, or it returns nil. Furthermore it adds a `fetch_deps_opts(formatter_opts, in_directory: formatter_dir)` function. This function then uses a non nil `formatter_dir` to wrap the actual `fetch_deps_opts/1` call in a `File.cd!` call for the provided `formatter_dir`. Fixes elixir-lang#7327
sascha-wolf
force-pushed
the
bug/mix-format-with-config-in-different-folder
branch
from
65167ee
to
c077733
Compare
sascha-wolf
force-pushed
the
bug/mix-format-with-config-in-different-folder
branch
from
fd82ecd
to
80c905f
Compare
|
I don't think this is going to work. Mix was designed to always run from the root. We shouldn't In other words, this is not a formatter bug, but it is a consequence that you are not running in the same directory as the mix.exs file and using Mix specific features (such as dependency handling). I will see if we can improve the error message though. |
|
The only logic which is executed in the dot_formatter folder is loading the dependency configuration for |
|
@zeeker i have tried your test locally and i got this error: It looks correct to me. |
It changes, because it breaks the assumption Mix is always running at the root of the project. Once you |
|
I can see your point but as a user I was never aware of the fact that mix is meant to be run in the root folder. On the other hand format does provide the option to use a dot format file from another folder , and it is possible to specify configuration which references data in this folder . What do we make of this directory bound configuration, if not load it? |
|
Well, you can move around freely. But if you are using dependencies, then you need to be in the directory that defines the mix.exs with those dependencies, otherwise we indeed won't find them. I don't think there is much for us to do here, so I will go ahead and make sure this is clear in the docs, thanks! |
|
What do you think of another option to either specify the dependency path or to enable the behaviour from this PR? |
- Set the `default-directory` to where mix.exs is located, because mix is meant to be run from the project root directory. Also, mix format looks for .formatter.exs files in subdirectories. - If mix.exs is NOT found, the original `default-directory` and default formatter are used for mix format. - Create the temp file in the current directory, because mix format uses path patterns. See: - elixir-lang/elixir#7328 (comment) - elixir-lang/elixir#7398 (comment)
This PR changes the
format.exmix task and updates the corresponding test.eval_dot_formatter/1now returns a two value tuple with the first value being the directory of the evaluateddot_formatterfile. The second value are the actualdot_formatteroptions.It then passes this
formatter_dirtofetch_deps_optswhich now has an arity two implementation. This implementation receives theformatter_optsand theformatter_diras second argument. Take a look at the header.If the directory is non nil, it wraps the call to
fetch_deps_opts/1in aFile.cd!/2call. This ensures that the dependencies are actually loaded from the same directory in which thedot_formatterresides.Fixes #7327