mirror of
https://github.com/fluencelabs/aqua.git
synced 2024-12-12 17:55:33 +00:00
b9af20339b
* Module and Use expressions * UseFromExpr * ImportFromExpr * PubExpr * Export, declares * Collecting all the needed info WIP * Got all the needed data * Tests fixed * HeaderSem * HeaderSem wip * Everything except `export`/`declares` should be working * Compile bug fixed * Fix readme: cli/assembly * Handle declares, exports * Compile only exports in AquaRes * Call services imported from modules * Import consts, types, services from modules * Resolve arrows from modules * Bugfix
44 lines
2.1 KiB
Markdown
44 lines
2.1 KiB
Markdown
## Aqua
|
||
|
||
[](https://github.com/fluencelabs/aqua/actions/workflows/release.yml)
|
||
|
||
Aqua is a new-gen language for distributed systems.
|
||
|
||
Aqua programs are executed on many peers, sequentially
|
||
or in parallel, forming a single-use coordination network.
|
||
|
||
Aqua's runtime is heterogeneous: it includes browsers, servers, devices, all involved in solving a single task.
|
||
Therefore, Aqua scripts are compiled into several targets at once, with AIR and Typescript as a default.
|
||
|
||
## Using Aqua
|
||
|
||
Please refer to [Aqua Book](https://doc.fluence.dev/aqua-book/) to learn how to use Aqua.
|
||
|
||
## Compiler CLI
|
||
|
||
To build the Aqua compiler, clone the repo & run `sbt cli/assembly`,
|
||
or simply download the latest JAR file from the [releases](https://github.com/fluencelabs/aqua/releases) page.
|
||
|
||
It requires `java` to run Aqua compiler from the command line:
|
||
|
||
```commandline
|
||
java -jar aqua-cli-%version_number%.jar -i path/to/input/dir -o path/to/output/dir
|
||
```
|
||
|
||
Input directory should contain files with `aqua` scripts.
|
||
|
||
## Repository structure
|
||
|
||
- **[types](./types)** – data types, arrows, stream types definitions and variance
|
||
- **[parser](./parser)** - parser, takes source text and produces a source AST
|
||
- **[model](./model)** - middle-end, internal representation of the code, optimizations and transfromations
|
||
- **[model/transform](./model/transform)** - optimizations and transfromations, converting model to the result, ready to be rendered
|
||
- **[model/test-kit](./model/test-kit)** - tests and test helpers for the model and transformations
|
||
- **[semantics](./semantics)** - rules to convert source AST into the model
|
||
- **[linker](./linker)** - checks dependencies between modules, builds and combines an abstract dependencies tree
|
||
- **[backend](./backend)** - compilation backend interface
|
||
- **[compiler](./compiler)** - compiler as a pure function made from _linker_, _semantics_ and _backend_
|
||
- **[backend/air](./backend/air)** – generates AIR code from the middle-end model
|
||
- **[backend/ts](./backend/ts)** - generates AIR code and Typescript wrappers for use with Fluence JS SDK
|
||
- **[cli](./cli)** - CLI interface
|