https://github.com/alco/mix-erlang-tasks

Common tasks for Erlang projects that use Mix
https://github.com/alco/mix-erlang-tasks

Last synced: about 2 months ago
JSON representation

Common tasks for Erlang projects that use Mix

• Host: GitHub
• URL: https://github.com/alco/mix-erlang-tasks
• Owner: alco
• License: mit
• Created: 2014-08-22T00:01:33.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-06-27T12:54:17.000Z (over 6 years ago)
• Last Synced: 2024-10-08T13:54:02.507Z (2 months ago)
• Language: Elixir
• Size: 205 KB
• Stars: 20
• Watchers: 2
• Forks: 13
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Common tasks for Erlang projects that use Mix. (Testing)
• fucking-awesome-elixir - mix_erlang_tasks - Common tasks for Erlang projects that use Mix. (Testing)
• awesome-elixir - mix_erlang_tasks - Common tasks for Erlang projects that use Mix. (Testing)

README

        
Erlang tasks for Mix

====================

This project provides a few Mix tasks that make it more convenient to use Mix as a build tool and

package manager when developing applications in Erlang.

Mix automates and simplifies a lot of development tasks: adding and fetching dependencies,

compilation, running test suites, generating documentation from source code, etc. It integrates with

Hex to be able to push and fetch packages from https://hex.pm and it also supports custom tasks. A

few good examples of the latter would be [dialyze](http://github.com/fishcakez/dialyze) and

[release](https://github.com/bitwalker/exrm).

You can get Mix by installing [Elixir](http://elixir-lang.org) or by downloading a standalone `mix`

escript from https://hex.pm (see section `Using with Erlang`) and putting it in your `PATH`.

Once installed, create a new project for your Erlang application.

Choose how you'd like to install the custom tasks:

  1. As an archive:

     ```

     mix archive.install https://github.com/alco/mix-erlang-tasks/releases/download/v0.1.0/mix_erlang_tasks-0.1.0.ez

     ```

     This will make the custom tasks available to `mix` regardless of where it is invoked, just like

     the builtin tasks are.

  2. Add `mix_erlang_tasks` as a dependency to your project:

     ```elixir

     # in your mix.exs

     defp deps do

       [{:mix_erlang_tasks, "0.1.0"}]

     end

     ```

     This will make the new tasks available only in the root directory of your Mix project.

Once installed, you'll have the following tasks available:

```sh

$ mix eunit          # run EUnit tests

$ mix ct             # run Common Test suites

$ mix edoc           # generate HTML documentation from the source

```

See example project at https://github.com/alco/erlang-mix-project.

## License

This software is licensed under [the MIT license](LICENSE).