ExFactor

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.

BETA Warning

ExFactor is still in active development and the API can and will change frequently!

Use at your peril, for now.

Example

 mix ex_factor --module TestModule.Here --function my_func --arity 1 --target NewModule.Test

Roadmap TODO

• [] Update .exs files too?
• [] Write tests to ensure we can find modules within and across umbrella apps.
• [] Add configuration hooks?
• [] find dead functions
• [] find module attrs and also move them?
• [] find types referenced in the moved specs
• [] find private functions references in refactored fn bodies.
• [] update test file refs by CLI option
• [] ElixirLS integration for VSCode?
• [] Write the module code to rename usages of the refactored function
• [] guthub actions, run test suite

Roadmap TODONE

• Write a mix task to invoke the Refactorer
• dry-run option
• CLI output, list files changed and created.
• format changes

Installation

If available in Hex, the package can be installed by adding ex_factor to your list of dependencies in mix.exs:

def deps do
  [
    {:ex_factor, "~> 0.1.0", only: [:dev]}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/ex_factor.

REFACTORY, just in case.