https://github.com/tomcat-42/aoc.zig-template

Advent of Code Zig Template
https://github.com/tomcat-42/aoc.zig-template

advent-of-code advent-of-code-zig aoc zig ziglang

Last synced: 23 days ago
JSON representation

Advent of Code Zig Template

• Host: GitHub
• URL: https://github.com/tomcat-42/aoc.zig-template
• Owner: Tomcat-42
• Created: 2024-11-20T01:57:55.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-01T13:41:13.000Z (23 days ago)
• Last Synced: 2024-12-01T14:31:57.357Z (23 days ago)
• Topics: advent-of-code, advent-of-code-zig, aoc, zig, ziglang
• Language: Zig
• Homepage:
• Size: 31.3 KB
• Stars: 24
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# aoc.zig-template

This is a zig template for Advent of Code. It has a very opinionated structure

and automatic input fetching/source code template generation for a current year/day.

All of this is powered by the **zig build system**.

## Usage

Clone this template repo:

```bash

gh repo create aoc.zig --template Tomcat-42/aoc.zig-template --public --clone

```

Then Login to your [Advent of Code](https://adventofcode.com/) account to get your session

token. You can do that by opening the browser devtools, selecting the networks tab, reloading

the page, selecting any request and looking for the `Cookie: session=` header:

![image](https://github.com/user-attachments/assets/8ee0e200-1e00-451d-8309-3a18d94ed3af)

Then, make it available as an env var:

```bash

AOC_SESSION_TOKEN=""

```  

You can pass the command line flags `-Dyear=` and `-Dday=` 

to specify the year and day you want to generate the template for 

(if you don't pass them, it will default to the current year and day of the month).

```sh

zig build --build-runner build_runner.zig -Dyear=2023 -Dday=1 --watch run

```

You can pass `test` instead of run to run the unit tests instead:

```sh

zig build --build-runner build_runner.zig -Dyear=2023 -Dday=1 --watch test

```

## Details

When you run the build command for a year and day for the first time,

it generates the source code template (`./src//.zig`) and input 

(`./input//.txt`) for that year/day. 

The `./src//.zig` file will have the following format:

```zig

const std = @import("std");

const mem = std.mem;

input: []const u8,

allocator: mem.Allocator,

pub fn part1(this: *const @This()) !?i64 {

    _ = this;

    return null;

}

pub fn part2(this: *const @This()) !?i64 {

    _ = this;

    return null;

}

test "it should do nothing" {

    const allocator = std.testing.allocator;

    const input = "";

    const problem: @This() = .{

        .input = input,

        .allocator = allocator,

    };

    try std.testing.expectEqual(null, try problem.part1());

    try std.testing.expectEqual(null, try problem.part2());

}

```

You "solve" the problem by returning the solution from `part1` and `part2` function.

The `input` field is the input data for the problem (see `build.zig` and `src/main.zig` 

for details on how this is achieved). Note that you can return anything as the solution,

for instance, if the solution is a string, you can return a `[]const u8` from any part.

Add tests for small examples and edge cases in tests blocks at the end of the file.