https://github.com/sebastiw/rebar3_idl_compiler

https://github.com/sebastiw/rebar3_idl_compiler

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sebastiw/rebar3_idl_compiler
• Owner: sebastiw
• License: mit
• Created: 2015-06-30T05:04:53.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-01-26T16:47:08.000Z (almost 8 years ago)
• Last Synced: 2024-11-23T13:06:48.511Z (2 months ago)
• Language: Erlang
• Size: 346 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Erlang - This is a plugin for compiling Erlang IDL files using Rebar3. (Build Tools)
• fucking-awesome-elixir - rebar3_idl_compiler - This is a plugin for compiling Erlang IDL files using Rebar3. (Build Tools)
• awesome-elixir - rebar3_idl_compiler - This is a plugin for compiling Erlang IDL files using Rebar3. (Build Tools)

README

        
rebar3_idl_compiler

=====

This is a plugin for compiling Erlang IDL files using Rebar3.

Use

---

Add the plugin to your rebar config:

```erlang

    {plugins, [

        {idl, ".*",

         {git,

          "[email protected]:sebastiw/rebar3_idl_compiler.git",

          {branch, "master"}}}

    ]}.

```

Then just call your plugin directly in an existing application:

    $ rebar3 idl compile

    ===> Fetching idl ({git ...})

    ===> Compiling idl

    

There are two options that can be specified in your rebar.config:

```erlang

    {idl_paths, [Paths]}.

            Path = {file, FilePath, Options} | {file, FilePath} |

                   {dir, Directory, Options} | {dir, Directory}

    {idl_opts, [Options]}.

            Options: Options specified by the ic module, check

                     http://www.erlang.org/doc/man/ic.html for more info.

```

If the options is not given with the path tuple, then the idl_opts option

is used.

Example:

```erlang

    {idl_opts, [{'Wall', true}]}.

    {idl_paths, [{file, "idl/system.idl", [{outdir, "generated"}]},

                 {dir, "idlfiles"}]}.

```

In the given example, all *.idl-files found under the path

"app_root/idlfiles" would be compiled with the 'Wall' option, while the

file "app_root/idl/system.idl" would be compiled into the directory

"generated".