Git Product home page Git Product logo

mix-erlang-tasks's Introduction

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 and release.

You can get Mix by installing Elixir 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:

    # 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:

$ 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.

mix-erlang-tasks's People

Contributors

alco avatar svc-scm avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

t0ha

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.