Skip to content

Commit

Permalink
deploy: bfb0d09
Browse files Browse the repository at this point in the history
  • Loading branch information
facebook-github-bot committed Nov 20, 2024
1 parent 3481dbf commit e6d66d2
Show file tree
Hide file tree
Showing 519 changed files with 2,316 additions and 329,628 deletions.
15 changes: 6 additions & 9 deletions 404.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _src/get-started/configure-project/custom-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 4

# 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](./elp-toml.md#empty-section). This section describes the format of such a file.
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](./elp-toml.md#build-info). This section describes the format of such a file.

### The `build_info.json` format

Expand Down
12 changes: 6 additions & 6 deletions _src/get-started/configure-project/elp-toml.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ will not perform any upward auto-discovery for the structure of a project.
## A Sample `.elp.toml` Configuration File

Here is an example of a full `.elp.toml` file. All sections are optional. The
[build_info](#empty-section) can be used to mark the root of a project (via
[build_info](#build-info) can be used to mark the root of a project (via
the `build_info` property). The available configuration sections are described
below.

Expand All @@ -35,17 +35,17 @@ profile = "test"

## Configuration Sections

### \[build\_info\]
### \[build\_info\] {#build-info}

This section is used to configure project discovery.

| Key | Type | Description |
| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| file | String | Path to a JSON file describing the project. This is only honoured if `buck.enabled` is `false` or missing. The format of the JSON file is described in the [build_info.json](#the-build_infojson-format) section. |
| file | String | Path to a JSON file describing the project. This is only honoured if `buck.enabled` is `false` or missing. The format of the JSON file is described in the [build_info.json](custom-project.md#the-build_infojson-format) section. |
| apps | String | A string pattern used to generate the applications for the `build_info.json` configuration. Unused if `file` is specified. E.g. `apps/*`|
| deps | String | A string pattern used to generate the dependencies for the `build_info.json` configuration. Unused if `file` is specified. E.g. `deps/*`|

### \[eqwalizer\]
### \[eqwalizer\] {#eqwalizer}

ELP is integrated with the [eqWAlizer](https://github.com/whatsapp/eqwalizer)
type checker. The integration can be configured via this section.
Expand All @@ -66,7 +66,7 @@ This can be overriden per module via the following attributes:
| enabled_all | Boolean | Disable eqwalizer for all modules by default, but still honours the module-specific overrides listed above |
| max_tasks | Integer | Max number of parallel eqWAlizer tasks, defaults to 4 (eqWAlizer instances are memory intensive). This only applies to using eqWAlizer from the CLI. |

### \[buck\]
### \[buck\] {#buck}

Configure the interaction between ELP and the [Buck2](https://buck2.build/)
build tool. See [this presentation](https://youtu.be/4ALgsBqNBhQ) for details
Expand All @@ -83,7 +83,7 @@ change soon, once we tweak the tests.

:::

### \[rebar\]
### \[rebar\] {#rebar}

Configure ELP for [rebar3](https://rebar3.org/)-based projects.

Expand Down
1 change: 0 additions & 1 deletion assets/css/styles.93dc32ac.css

This file was deleted.

1 change: 1 addition & 0 deletions assets/css/styles.b2e943a4.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions assets/js/014b6b9f.2478f601.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion assets/js/014b6b9f.fd3519e3.js

This file was deleted.

1 change: 1 addition & 0 deletions assets/js/0239e75f.561ddcd5.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion assets/js/0239e75f.91af3dfc.js

This file was deleted.

Loading

0 comments on commit e6d66d2

Please sign in to comment.