blob: ff6d36246fc0907041181854eaa86aa2fc53d251 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
# Effekt Template
> [!WARNING]
> This is a work-in-progress, feel free to contribute!
This template provides a starting point for Effekt projects.
## Table of contents
- [First steps](#first-steps)
- [Useful commands](#useful-commands)
- [Effekt commands](#effekt-commands)
- [Nix-related commands](#nix-related-commands)
- [Example projects](#example-projects-using-this-template)
- [Repository structure](#repository-structure)
- [CI](#ci)
---
## First steps
After using this template, follow these steps to set up your project:
1. Set up your development environment:
- Clone this repository locally.
- Open it in VSCode.
- Install the Effekt VSCode extension offered in the pop-up in the bottom right.
2. Customize the project:
- Open `flake.nix` and update the project name and other relevant values (follow the comments).
- Push your `flake.nix` file after the changes and see if the CI agrees.
3. Set-up auto-update CI in order to get weekly PRs on Tuesday which update the Effekt version in CI:
- Go to Settings -> Actions -> General:
- and set "Workflow permissions" to "Read and write permissions"
- and check "Allow GitHub Actions to create and approve pull requests"
- See the [CI](#ci) section for more details
4. Replace this `README` with your own!
## Useful commands
### Effekt commands
Run the main file:
```sh
effekt src/main.effekt
```
This (like many other Effekt commands) uses the JavaScript backend by default.
To use a different backend, add the `--backend <backend>` flag.
Run the tests:
```sh
effekt src/test.effekt
```
Open the REPL:
```sh
effekt
```
Build the project:
```sh
effekt --build src/main.effekt
```
This builds the project into the `out/` directory, creating a runnable file `out/main`.
To see all available options and backends, run:
```sh
effekt --help
```
### Nix-related commands
While Nix installation is optional, it provides several benefits:
Update dependencies (also runs automatically in CI):
```sh
nix flake update
```
Open a shell with all necessary dependencies:
```sh
nix develop
```
Run the main entry point:
```sh
nix run
```
Build the project (output in `result/bin/`):
```sh
nix build
```
## Example projects using this template
- [`effekt-stm`](https://github.com/jiribenes/effekt-stm)
- This very project!
## Repository structure
- `.github/workflows/*.yml`: Contains the [CI](#ci) definitions
- `src/`: Contains the source code
- `main.effekt`: Main entry point
- `test.effekt`: Entry point for tests
- `lib.effekt`: Library code imported by `main` and `test`
- `flake.nix`: Package configuration in a Nix flake
- `flake.lock`: Auto-generated lockfile for dependencies
- `LICENSE`: Project license
- `README`: This README file
## CI
Two GitHub Actions are set up:
1. `flake-check`:
- Checks the `flake.nix` file, builds and tests the project
- Runs on demand, on `main`, and on PRs
- To run custom commands, add a step using:
- `nix run -- <ARGS>` to run the main entry point with the given arguments
- `nix develop -c '<bash command to run>'` to run commands in the correct environment
2. `update-flake-lock`:
- Updates package versions in `flake.nix`
- Runs on demand and weekly (Tuesdays at 00:00 UTC)
|
