mirror of https://github.com/polarity-lang/polarity.git synced 2025-08-04 18:48:13 +00:00

Mango The Fourth 8495c059e5

* [feat] add simple nix development environment

* [feat] add a workflow that checks the nix code

* [chore] documentation updates of the expr ast

* [fix] allow unification errors to originate from a specific location

- add an origin field to NotEq unification error
- add an origin field to CannotDecide unification error
- reuse the span emitted for a data constructor without type for its
  type
- Box the type error in Error to reduce the size of the enum

* [chore] add testfiles for unificatoin errors

* [fix] apply changes as requested by Tim Süberkrüb

- correct spelling in nix workflow
- adjust README to mention IFD
- use span of (co)matches instead of propagating outwards
- adjust spelling
- add two new examples for fail-check
- change the naming of the reason span to while_elaborating_span

Co-authored-by: Tim Süberkrüb <dev@timsueberkrueb.io>

* [chore] add a workflow name for the nix workflow

Co-authored-by: Tim Süberkrüb <dev@timsueberkrueb.io>

* [chore] only run the nix workflow on main

---------

Co-authored-by: Tim Süberkrüb <dev@timsueberkrueb.io>

2024-11-18 14:37:46 +01:00

2.6 KiB

Raw Permalink Blame History

How to Use the Nix Code

Obtaining Nix

Refer to one of the sets of instructions to install nix:

Make sure you enable flakes support, if you do not know what you are doing.

Optionally, install direnv and the nix-direnv integration

Using Nix to Develop Polarity

We provide a development environment that should contain everything to build polarity and work on it. To enter a development shell containing all the tools you need, run:

nix develop

If you do not want to wait for evaluation of the nix code every time you enter the directory, using direnv and nix-direnv you can add a .envrc file in the root directory of your checkout, containing

use flake . -Lv

After that, you only have to run direnv allow which will then allow direnv to enter the development shell automatically every time you enter the polarity directory.

Building Polarity Using Nix

To build polarity with nix

in your local checkout, run:
```
nix build
```

if you do not have a local checkout, run:

 nix build github:polarity-lang/polarity

if you do not care for the latest version, nixpkgs also has polarity:
```
nix build nixpkgs#polarity
```

This will put the pol executable in the result/bin symlink relative to your current working directory.

If you want to directly run polarity, replace build with run and if you want to temporarily add polarity to your $PATH, replace build with shell.

If you want to install polarity globally using nix, use nix profile install instead of nix build.

Contributing to the Nix Code

Before opening a merge request with changes to the nix code, please check the following:

all *.nix files except the flake.* files live in the contrib/nix directory
all of the nix code keeps working with both legacy nix and flakes
your changes have been formatted with nix fmt, or if you do not use flakes, nix-fmt (rfc-style)
your changes use existing nixpkgs infrastructure where possible
your changes do not break any of the existing workflows and everything works as normal for non-nix users
your changes do not require changes in regular non-nix development workflows
your changes do not introduce any unnecessary IFD (see the nix manual for an explanation of what IFD is)

2.6 KiB Raw Permalink Blame History