ExFactor is a refactoring helper. Given a module, function name, and arity, it will locate all uses of that function, change the callers to a new module and/or function name, and move the function from the original location to a new file/module. At this time, ExFactor cannot change the function arity.
ExFactor is still in active development and the API can and may change frequently!
Use at your peril, for now.
mix ex_factor --module TestModule.Here --function my_func --arity 1 --target NewModule.There
- Write a mix task to invoke the Refactorer
- dry-run option
- CLI output, list files changed and created.
- format changes
- github actions, run test suite
- Add Mix.Task tests
- Add CLI tests
- Support opt-out of format-ing
- Option to only change the module name throughout the project
- update code to rely on compilation tracers, instead of XREF
- With module-only option, ensure we remove changed aliases
- Add and configure CHANGELOG tracking.
- defdelegate
- [] require as:
- [] find private functions references in refactored fn bodies.
- [] Add test for one file containing more than one
defmodule
- [] Add test for nested defmodules.
- [] update test file refs by CLI option
- [] find dead functions
- [] find module attrs and also move them?
- [] find types referenced in the moved specs
- [] git stage all changes?
- [] How does this work with macro code? Does that even make sense as a case to handle?
- [] Write tests to ensure we can find modules across umbrella apps.
- [] Add configuration hooks?
- [] ElixirLS integration for VSCode?
- [] Write the module code to rename usages of the refactored function
See CHANGELOG.md
Updating the changelog. (Uses auto-changelog
)
https://github.com/cookpete/auto-changelog
auto-changelog --breaking-pattern "BREAKING CHANGE"
git tag `egrep '@version \"\d\.\d\.\d\".*' mix.exs | awk '{gsub(/"/, "", $2); print $2}'`
Hex, the package can be installed
by adding ex_factor
to your list of dependencies in mix.exs
:
def deps do
[
{:ex_factor, "~> 0.3", only: [:dev]}
]
end
Documentation is published on HexDocs. The docs can be found at https://hexdocs.pm/ex_factor.
Alternate name: REFACTORY, just in case.
See LICENSE
- https://dorgan.netlify.app/posts/2021/04/the_elixir_ast/
- https://www.educative.io/courses/metaprogramming-elixir/7DXEpKlj3Rr
- https://elixirforum.com/t/is-there-a-complete-elixir-ast-reference/38923/3
- https://www.botsquad.com/2019/04/11/the-ast-explained/
- https://elixirforum.com/t/getting-each-stage-of-elixirs-compilation-all-the-way-to-the-beam-bytecode/1873/8
- http://gomoripeti.github.io/beam_by_example/
- https://en.wikipedia.org/wiki/BEAM_(Erlang_virtual_machine)