workshop-runner 0.2.5

A CLI to run test-driven Rust workshops
Documentation 
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

<div class="oranda-hide">
    <h1 align="center">wr</h1>
    <div align="center">
        <strong>
        A Rust workshop runner
        </strong>
    </div>
    <div align="center">
        <!-- Crates version -->
        <a href="https://crates.io/crates/cargo-px">
            <img src="https://img.shields.io/crates/v/cargo-px.svg?style=flat-square"
            alt="Crates.io version" />
        </a>
        <!-- Downloads -->
        <a href="https://crates.io/crates/cargo-px">
            <img src="https://img.shields.io/crates/d/cargo-px.svg?style=flat-square"
            alt="Download" />
        </a>
    </div>
</div>

<br />

![demo](demo.gif)

`wr` is a CLI to drive test-driven workshops written in Rust.
It is designed to be used in conjunction with a workshop repository, which contains a series of exercises to be solved
by the workshop participants.

> This workshop runner has been developed by [Mainmatter](https://mainmatter.com/rust-consulting/) to support
> our [hands-on Rust workshops](https://mainmatter.com/services/workshops/rust/).
> Check out our [landing page](https://mainmatter.com/rust-consulting/) if you're looking for Rust consulting or
> training!

<div class="oranda-hide">
## How to install

Check out the instructions on the [release page](https://mainmatter.github.io/rust-workshop-runner/).
</div>

## How it works

> What I cannot create, I do not understand.
>
> Richard Feynman

A test-driven workshop is structured as a series of exercises.
Each exercise is a Rust project with a set of tests that verify the correctness of the solution.

`wr` will run the tests for the current exercise and, if they pass, allow you to move on to the next exercise while
keeping track of what you have solved so far.

You can see it in action in the [rust-telemetry-workshop](https://github.com/mainmatter/rust-telemetry-workshop).

## Installation

```bash
cargo install --locked workshop-runner
```

Check that it has been installed correctly:

```bash
wr --help
```

## Usage

Run

```bash
wr
```

from the top-level folder of a workshop repository to verify the solution for the current exercise
and move forward in the workshop.

You can also navigate to a specific exercise and then run `wr check` from inside its directory
to verify its solution, regardless of what the current exercise is.

### Continuous checking

You can combine `wr` with [`cargo-watch`](https://crates.io/crates/cargo-watch) to re-check your solution every time you
make a change
to the code:

```bash
cargo watch -- wr
```

## Folder structure

`wr` expects the following structure for the workshop repository:

```
.
├── exercises
│  ├── 00_<collection name>
│  │  ├── 00_<exercise name>
│  │  │  ..
│  │  ├── 0n_<exercise name>
│  │  ..
│  ├── 0n_<collection name>
│  │  ├── 00_<exercise name>
│  │  │  ..
│  │  ├── 0n_<exercise name>
```

Each `xx_<exercise name>` folder must be a Rust project with its own `Cargo.toml` file.

You can choose a different top-level folder name by creating a top-level `.wr.toml` file with the following content:

```toml
exercises_dir = "my-top-level-folder"
```

You can refer to [rust-telemetry-workshop](https://github.com/mainmatter/rust-telemetry-workshop) as an example.