Skip to main content

Custom Project

If your project is not using rebar3 or buck2 as a build system, you can still configure ELP to load the project configuration from a JSON file. This section describes the format of such a file.

The build_info.json format​

tip

You can generate an example to customize for your own configuration by using the following command on a configured rebar3 project, in the directory where the rebar.config file exists.

elp build-info --project . --json --to build_info.json

The .json file should be structured in this way:

{
  "apps": [app list],
  "deps": [app list],      // 3rd party dependencies (not type-checked), defaults to []
}

where an app is a map structured as such:

{
  "name": "app_name",
  "dir": "path/to/app",                         // Relative to project root
  "src_dirs": ["path/to/src", ...],             // Relative to app dir, defaults to ["src"]
  "extra_src_dirs": ["path/to/extra_src", ...], // Relative to app dir, defaults to []
  "ebin": "path/to/ebin",                       // Relative to app dir, defaults to "ebin"
  "include_dirs": ["include", ...],             // Relative to app dir, defaults to []
  "macros": ["MACRO", ...],                     // Defaults to []
}