Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/savi-lang/savi

A fast language for programmers who are passionate about their craft.
https://github.com/savi-lang/savi

actor-model compiler concurrent-programming llvm programming-language savi

Last synced: about 2 hours ago
JSON representation

A fast language for programmers who are passionate about their craft.

Awesome Lists containing this project

README

        

Savi Logo

---

**Savi** is a **fast** language for programmers
who are **passionate about their craft**.

---

**Savi** will **change the way you think** about programming
and equip you with the skills and tools you need
to tackle **more ambitious** technical challenges,
and **have fun** doing it.

---

**Savi** is here to help you write blazing-fast,
**concurrent** software that is **memory-safe** and **data-race-free**.

---

## Background

**Savi** is an actor-oriented programming language using the [Pony](https://www.ponylang.io/) runtime. Like Pony, **Savi** has a unique type system that enforces concurrency-safety and memory-safety properties at compile time.

Like many other modern compiled languages, **Savi** uses [LLVM](https://llvm.org/) to compile to a wide variety of native targets.

Our goal is to make **Savi** approachable and fun, as well as powerful and extensible.

We are a small team of passionate volunteers working to bring this project to full fruition. If this vision sounds interesting to you, we'd love for you to [reach out in our chat](https://savi.zulipchat.com/) and get involved.

## Try It!

The easiest way to try Savi is to use [asdf version manager](https://asdf-vm.com/), which allows you to install and manage versions for a variety of languages/runtimes, including Savi. After [installing asdf](https://asdf-vm.com/guide/getting-started.html#_1-install-dependencies), run the following commands to get Savi up and running:

```sh
# Add the Savi plugin to asdf.
asdf plugin add savi https://github.com/savi-lang/asdf-savi.git

# Download and install the latest version of Savi.
asdf install savi latest

# Select the latest version of Savi as the one to use globally in your shell.
asdf global savi latest

# Prove the installation with a simple program.
savi eval 'env.out.print("Savi is installed!")'
```

Once Savi is installed, you can enter any directory with a `manifest.savi` file in it and run the `savi` command there to compile one of the manifests defined in it, resulting in an executable binary program in a `./bin` folder with the same name as that targeted manifest.

Alternatively, you can invoke `savi run` to both compile and immediately run the program.

Invoke `savi --help` to learn about more available commands.

If you're a VS Code user, you may be interested to install our [language extension for that editor](./tooling/vscode), which includes both syntax highlighting and some Intellisense features via using the docker image as an LSP server.

We also have [a vim/nvim extension](./tooling/coc-nvim) as well.

Finally, if you want to contribute to Savi, read on through the next two sections for information on how to find work, as well some of the basic development commands.

## Contributing

Looking for ways to help? [Here's a link that shows issue tickets filtered by those that should be ready to work on](https://github.com/savi-lang/savi/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+-label%3ABLOCKED+-label%3A%22complexity+4%3A+scary%22+-label%3A%22needs+design%22).

You can also filter by complexity label to try to find something that's the right level of challenge and time commitment for you.

If you're a new contributor looking for some guidance, please reach out to us [in this chat room](https://savi.zulipchat.com/) to introduce yourself and even schedule pairing sessions where we can help you understand parts of the compiler or language that you're interested in learning more about.

We think you'll find it exciting to join us at this stage of our work, where there is already enough working that you can get things done and produce a tangible result, but it's early enough that you can have a strong impact on the future of the language and the community.

We are excited to welcome all contributors that bring a positive attitude, regardless of their level of experience. [Join us!](https://savi.zulipchat.com/)

## Developing

To work on this project and build the Savi compiler from source, you'll need `make`, `clang`, and `crystal` installed (look at `shard.yml` to see the correct version of Crystal that is officially supported). You may also want to have `lldb` for debugging.

To get started, clone the project to your development machine, then run one of the following commands within the project working directory, or consult the `Makefile` for more available commands. Note that the first time you run one of these commands it will take longer, as it will need to download some static dependencies and build the compiler for the first time.

- Run `make spec.all` to run the full test suite, or refer the Makefile for information about runnning more specific sets of specs.

- Run `make format.check` to check `*.savi` source files for formatting rule violations, or `make format` to fix them automatically.

- Run `make example dir="/opt/code/examples/adventofcode/2018` to compile and run from the sources in `./examples/adventofcode/2018` directory (or similarly for any other example code directory).

Alternatively, you can develop within the confines of a docker container, so that no development dependencies are needed other than `docker` itself. To do so, first run `docker/make ready` to run up a development container, then use `docker/make` instead of `make` to run any of the commands mentioned above (for example, `docker/make test`), which will run that command inside of the development container.