ExCompatible

v0.2.0

ExCompatible

Build Status Coverage Status Hex.pm version Hex.pm downloads License Docs

ExCompatible strives to make your Elixir code compatible with as many Elixir versions as possible, while reducing the number of compiler warnings.

See http://hexdocs.pm/ex_compatible/ for documentation, https://github.com/kafkaex/ex_compatible/ for code.

Have you ever wanted to use String.to_charlist/1, but then your code no longer compiles on Elixir 1.1? You switch to using String.to_char_list/1 instead, but now your compiler spits out annoying warnings on Elixir 1.5. What should you do?

ExCompatible can inspect your Elixir version, and by using the compatible macro, it will always inject the most appropriate version of a defition so your compiler stays happy.

Note: This project is still under heavy construction. Please check the to-do list further down, and we love contributors!

Usage

To add ExCompatible to your Elixir application, change the deps definition in your mix.exs file:

defp deps do
  [
    {:ex_compatible, "~> 0.2"}
  ]
end

Then you will need to import the compatible/1 macro inside any modules in which you would like to use it. For example:

defmodule MyModule do
  import ExCompatible, only: [compatible: 1]

  def my_def do
    IO.puts compatible(String.to_char_list("Hello world!"))

    compatible do
      Enum.partition([5, 4, 3, 2], fn(x) -> rem(x, 2) == 0 end)
    end
  end
end

Performance

ExCompatible is implemented using macros, which always inject the most appropriate version of a given definition directly into the AST. This happens at compile time, so at runtime there should be zero performance impact by using ExCompatible.

To-do

There are lots of different types of deprecations, ranging from simple renames, to spec changes, complete removal, or splits into multiple functions. The goal is to be able to handle all of these different types, and to do that we’ll need a checklist.

Elixir 1.6 Deprecations

Elixir 1.5 Deprecations

Elixir 1.4 Deprecations

Elixir 1.3 Deprecations

Elixir 1.2 Deprecations

  • [ ] Dict behaviour

Elixir 1.1 Deprecations