Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fspoettel/advent-of-code-2021

🦀 Rust solutions for Advent of Code 2021
https://github.com/fspoettel/advent-of-code-2021

advent-of-code advent-of-code-2021

Last synced: 25 days ago
JSON representation

🦀 Rust solutions for Advent of Code 2021

Awesome Lists containing this project

README 

        



# 🎄 [Advent of Code](https://adventofcode.com/)



![Language](https://badgen.net/badge/Language/Rust/orange)



## 2021 Results



| Day | Part 1 | Part 2 |

| :---: | :---: | :---: |

| [Day 1](https://adventofcode.com/2021/day/1) | ⭐ | ⭐ |

| [Day 2](https://adventofcode.com/2021/day/2) | ⭐ | ⭐ |

| [Day 3](https://adventofcode.com/2021/day/3) | ⭐ | ⭐ |

| [Day 4](https://adventofcode.com/2021/day/4) | ⭐ | ⭐ |

| [Day 5](https://adventofcode.com/2021/day/5) | ⭐ | ⭐ |

| [Day 6](https://adventofcode.com/2021/day/6) | ⭐ | ⭐ |

| [Day 7](https://adventofcode.com/2021/day/7) | ⭐ | ⭐ |

| [Day 8](https://adventofcode.com/2021/day/8) | ⭐ | ⭐ |

| [Day 9](https://adventofcode.com/2021/day/9) | ⭐ | ⭐ |

| [Day 10](https://adventofcode.com/2021/day/10) | ⭐ | ⭐ |

| [Day 11](https://adventofcode.com/2021/day/11) | ⭐ | ⭐ |

| [Day 12](https://adventofcode.com/2021/day/12) | ⭐ | ⭐ |

| [Day 13](https://adventofcode.com/2021/day/13) | ⭐ | ⭐ |

| [Day 14](https://adventofcode.com/2021/day/14) | ⭐ | ⭐ |

| [Day 15](https://adventofcode.com/2021/day/15) | ⭐ | ⭐ |

| [Day 16](https://adventofcode.com/2021/day/16) | ⭐ | ⭐ |

| [Day 17](https://adventofcode.com/2021/day/17) | ⭐ | ⭐ |

| [Day 18](https://adventofcode.com/2021/day/18) | ⭐ | ⭐ |

| [Day 19](https://adventofcode.com/2021/day/19) | ⭐ | ⭐ |

| [Day 20](https://adventofcode.com/2021/day/20) | ⭐ | ⭐ |

| [Day 21](https://adventofcode.com/2021/day/21) | ⭐ | ⭐ |

| [Day 22](https://adventofcode.com/2021/day/22) | ⭐ | ⭐ |

| [Day 23](https://adventofcode.com/2021/day/23) | ⭐ | ⭐ |

| [Day 24](https://adventofcode.com/2021/day/24) | ⭐ | ⭐ |

| [Day 25](https://adventofcode.com/2021/day/25) | ⭐ | ⭐ |



---



Generated with the [advent-of-code-rust](https://github.com/fspoettel/advent-of-code-rust) template.



## Create your own



 1. Open the [advent-of-code-rust](https://github.com/fspoettel/advent-of-code-rust) template on Github.

 2. Click `Use this template` and create your repository.

 3. Clone the repository to your machine.



## Install



* Install the [Rust toolchain](https://www.rust-lang.org/tools/install).

* (optional) Install [rust-analyzer](https://rust-analyzer.github.io/manual.html) for your editor.

* (optional) Install a native debugger, e.g. [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) for VS Code.

* (optional) Install [`aoc-cli`](https://github.com/scarvalhojr/aoc-cli/) and follow their setup guide to use the `download` script for puzzle inputs. (see below)

* (optional) Setup the README stars github action. (see below)



## Commands



### Setup new day



```sh

# example: `./scripts/scaffold.sh 1`

./scripts/scaffold.sh 



# output:

# Created module `src/solutions/day01.rs`

# Created input file `src/inputs/day01.txt`

# Created example file `src/examples/day01.txt`

# Linked new module in `src/main.rs`

# Linked new module in `src/solutions/mod.rs`

# Done! 🎄

```



Every solution file has _unit tests_ referencing the example input file. You can use these tests to develop and debug your solution. When editing a solution file, `rust-analyzer` will display buttons for these actions above the unit tests.



### Download inputs for a day



```sh

# example: `./scripts/download.sh 1`

./scripts/download.sh 



# output:

# Invoking `aoc` cli...

# Loaded session cookie from "/home/foo/.adventofcode.session".

# Downloading input for day 1, 2021...

# Saving puzzle input to "/tmp/..."...

# Done!

# Wrote input to `src/inputs/day01.txt`...

# Done! 🎄

```



Puzzle inputs are not checked into git. [See here](https://old.reddit.com/r/adventofcode/comments/k99rod/sharing_input_data_were_we_requested_not_to/gf2ukkf/?context=3) why.



### Run solutions for a day



```sh

# example: `cargo run 1`

cargo run 



# output:

#     Running `target/debug/aoc 1`

# ----

#

# 🎄 Part 1 🎄

#

# 6 (elapsed: 37.03µs)

#

# 🎄 Part 2 🎄

#

# 9 (elapsed: 33.18µs)

#

# ----

```



To run an optimized version for benchmarking, use the `--release` flag or the alias `cargo rr `.



### Run all solutions against example input



```sh

cargo test

```



### Format code



```sh

cargo fmt

```



### Lint code



```sh

cargo clippy

```



## Setup readme stars



This template includes [a Github action](https://github.com/k2bd/advent-readme-stars) that automatically updates the readme with your advent of code progress.



To enable it, you need to do two things:



 1. set repository secrets.

 2. create a private leaderboard.



### Repository secrets



Go to the _Secrets_ tab in your repository settings and create the following secrets:



* `AOC_USER_ID`: Go to [this page](https://adventofcode.com/settings) and copy your user id. It's the number behind the `#` symbol in the first name option. Example: `3031`

* `AOC_YEAR`: the year you want to track. Example: `2021`

* `AOC_SESSION`: an active session for the advent of code website. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in your Cookies under the Application or Storage tab, and copy out the `session` cookie.



### Private Leaderboard



Go to the leaderboard page of the year you want to track and click _Private Leaderboard_. If you have not created a leaderboard yet, create one by clicking _Create It_. Your leaderboard should be accessible under `https://adventofcode.com/{year}/leaderboard/private/view/{aoc_user_id}`.