pablomayobre / aoc-2023

Advent of Code Typescript

Setup

Firs you need to setup aoc-cli, it should be available globally and you need to have configured your session cookie.

Init

Initialize a day with a very basic template, puzzle description and your data

npm run init -- 1

The command above would initialize day 1 with the following folder structure

puzzles
 - day-1
   - puzzle.md               # The puzzle description for day 1
   - data.txt                # Your data for this puzzle
   - part-a.sample-data.txt  # Empty file where you can place the sample data
   - part-a.ts               # Typescript template to write your answer

Save your sample data

I recommend you first read the puzzle, grab the sample data generally presented as a code block and paste it into part-a.sample-data.txt.

There will also be an expected result that you will need to store in part-a.ts

Write your answer

You can then write your answer in the generated template part-a.ts like so:

import Day from '../../day.ts';

export default class Day1A extends Day {
  constructor() {
    super({
      day: 1,
      challenge: 'A',

      sampleResult: '142', // DON'T FORGET TO ADD THE EXPECTED RESULT FOR THE SAMPLE DATA
    });
  }

  async answer(input: string) {
    const list = input.split('\n').map(value => parseInt(value));

    return list.reduce((a, b) => a + b);
  }
}

Test it

You can then test your answer using the following command:

npm run exec -- 1 A --sample

# or

npm run exec -- 1 A -s

This will run the code for Day 1 part 1 (internally called challenge A) against the sample data.

You will either know if you succeeded or failed on your quest.

Ship it

Once you are happy with your result against sample data you can submit your answer by running the same command but against your input data:

npm run exec -- 1 A

This will run the code for Day 1 challenge A, against the input data, submit the answer and let you know if it's correct or not.

If you want to test against input data without submitting your answer, you can use the following command

npm run exec -- 1 A --dont-submit

# or

npm run exec -- 1 A -n

Solving challenge A, will automatically update your puzzle.md and create a new part-b.ts for you to advance into the second part of the puzzle, also known as challenge B.

Typecheck and Formatting

I left some commands for formatting and type checking with Prettier and Typescript respectively:

# Formatting
npm run format

# Typecheck
npm run check

Configure the year

If you wanna do the challenge for a previous year, you just need to update the YEAR constant in ./wrapper.ts around line 6.