https://github.com/martinsos/aoc-2023-haskell-template

Template for solving Advent of Code 2023 in Haskell
https://github.com/martinsos/aoc-2023-haskell-template

advent-of-code advent-of-code-2023 haskell

Last synced: 2 months ago
JSON representation

Template for solving Advent of Code 2023 in Haskell

• Host: GitHub
• URL: https://github.com/martinsos/aoc-2023-haskell-template
• Owner: Martinsos
• Created: 2023-11-28T22:00:30.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-03T14:06:11.000Z (about 1 year ago)
• Last Synced: 2024-10-13T16:28:48.411Z (3 months ago)
• Topics: advent-of-code, advent-of-code-2023, haskell
• Language: Haskell
• Homepage:
• Size: 10.7 KB
• Stars: 9
• Watchers: 2
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# AOC 2023

This is a template project for solving Advent Of Code (2023) in Haskell: fork it and you can start solving!

## Setup

You are expected to have `ghcup` installed on your machine.

Run `./ghcup-set.sh` to set the intended version of GHC, cabal and HLS via GHCup.

If any of the versions needed are not yet installed on your machine, you can use `ghcup tui` to install them.

It might work with other combination of versions also, but this combo works for sure.

If all is good, `cabal build` should complete successfully for you.

## Organization of the codebase

`src/` contains all the Haskell code. `src/Day01.hs`, `src/Day02.hs`, ... each contain the solution

for that specific day, and they are all imported into the `src/Main.hs`, which is the executable

that we use to easily run the solution for the specific day.

`data/` dir is where puzzle input files go for each day.

Each day, you should save a new file there, named `dayXY-input.txt` where `XY` is day number (`01`, `25`, ...).

Your code in `src/DayXX.hs` can then read those files as needed.

These data files are gitignored, since AoC authors ask not to publicly post your puzzle input files.

## Running

Easiest way is calling `./day ` to run specific day, e.g. `./day 01` or `./day 25`.

`day` is really just a helper script for calling `cabal run`, so you can use `cabal run` directly if you want more control. `cabal run` will build all your code (same as `cabal build`) and then run the executable which has `src/Main.hs` as its entry point.

`cabal repl` is also interesting option: it will take you to ghci where all the modules are already

loaded for you and you can easily run any function, this is great for debugging and testing, or even

normal running. You can just type `day01` and run it that way. Type `:r` to reload upon changes in

the code.

## Project config

This is a cabal-based project.

`aoc2023.cabal` file already contains the default configuration that should work fine for you.

You will notice it also contains some commented-out extensions and dependencies(packages). These are

some common extensions and dependencies that we think you are likely to need so we put them there

for your convenience, you just need to uncomment them in order to get going with them.

## Other templates

1. Nice, a bit heavier/richer AoC template (Stack based) that I took some nice ideas from: https://github.com/samcoy3/advent-of-code-template .