Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/weaponsforge/adventofcode

Solutions for Advent of Code event puzzles
https://github.com/weaponsforge/adventofcode

advent-of-code adventofcode aoc

Last synced: about 5 hours ago
JSON representation

Solutions for Advent of Code event puzzles

Host: GitHub
URL: https://github.com/weaponsforge/adventofcode
Owner: weaponsforge
License: mit
Created: 2024-12-12T08:03:21.000Z (2 months ago)
Default Branch: dev
Last Pushed: 2025-02-06T11:43:28.000Z (6 days ago)
Last Synced: 2025-02-06T12:33:34.842Z (6 days ago)
Topics: advent-of-code, adventofcode, aoc
Language: TypeScript
Homepage: https://adventofcode.com/
Size: 720 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

## ✨ adventofcode

This repository contains solutions and a local development environment for the [Advent of Code](https://adventofcode.com/) event puzzles using **TypeScript/JavaScript**.

- The code repository structure follows a way that discusses and walks through the solution steps for the AoC quizzes rather than focusing on AoC's competitive programming.
- The quizzes were solved for fun (unlocking the 2024 AoC Chrismas symbol 🎄) and brain exercise purposes. Therefore, no GPT or AI completion was used for solving, as advised on the AoC website.
- These codes may get occasional optimization updates or solutions using other languages from time to time.

### 🎄 Advent of Code Quiz Information

2024

- Day 1: Historian Hysteria [[link]](/src/2024/2024-12-01/README.md)
- Day 2: Red-Nosed Reports [[link]](/src/2024/2024-12-02/README.md)
- Day 3: Mull It Over [[link]](/src/2024/2024-12-03/README.md)
- Day 4: Ceres Search [[link]](/src/2024/2024-12-04/README.md)
- Day 5: Print Queue [[link]](/src/2024/2024-12-05/README.md)
- Day 6: Guard Gallivant [[link]](/src/2024/2024-12-06/README.md)
- Day 7: Bridge Repair [[link]](/src/2024/2024-12-07/README.md)
- Day 8: Resonant Collinearity [[link]](/src/2024/2024-12-08/README.md)
- Day 9: Disk Fragmenter [[link]](/src/2024/2024-12-09/README.md)
- Day 10: Hoof It [[link]](/src/2024/2024-12-10/README.md)
- Day 11: Plutonian Pebbles [[link]](/src/2024/2024-12-11/README.md)
- Day 12: Garden Groups [[link]](/src/2024/2024-12-12/README.md)
- Day 13: Claw Contraption [[link]](/src/2024/2024-12-13/README.md)
- Day 14: Restroom Redoubt [[link]](/src/2024/2024-12-14/README.md)
- Day 15: Warehouse Woes [[link]](/src/2024/2024-12-15/README.md)

### Table of Contents

Click to expand the table of contents

- [Advent of Code Quiz Information](#-advent-of-code-quiz-information)
- [Project Folder Structure](#-project-folder-structure)
- [Requirements](#-requirements)
- [Installation](#%EF%B8%8F-installation)
- [Usage](#-usage)
- [Alternate Usage](#-alternate-usage)
- [Available Scripts](#-available-scripts)
- [Docker Scripts](#-docker-scripts)

## 📚 Project Folder Structure

It follows the directory structure:

> [!NOTE]
> 📂 dist

> 📂 src

> └─ 📂 aoc

> └─ 📂 sample

> └─ 📂 2024

> └─── 📂 2024-12-01

> └───── 📂 lib

> └───── 📄 input.txt

> └───── 📄 main.ts

> └───── 📄 sample.test.ts

> └───── 📄 README.md

> └─── 📂 2024-12-02

> └─── 📂 ...

> └─ 📂 2025

> └─ 📂 ...

> └─ 📄 index.ts

> └─ 📄 ...

> 📄 README.md

#### Quiz Folders

Each Advent of Code (AoC) event quiz has its folder under **`"/src//"`** containing:
- **/lib**: Folder containing main quiz solution logic
- **input.txt**: Random quiz input
> _**INFO:** The sample quiz inputs were slightly altered from the original AoC input text and quiz samples as advised on their website_
- **main.ts**: Main program entry point containing quiz answer(s) using random input
- **sample.test.ts**: Minimal sample input with expected correct answers
- **README.md**: Reference and other notes about the AoC quiz question

#### Other Items

- **/src/aoc**: 🗃️ Folder containing generic utility and common AoC helper functions
- **/src/dist**: Folder containing the JavaScript files compiled from TypeScript (not committed to the repository)
- **/src/sample**: Miscellaneous random examples
- **/src/index.ts**: Exports all solutions to AoC quiz answer functions

### 📋 Requirements

- Node v20.15.0 (at least)
- node: 20.15.0
- npm: 10.7.0

- Docker (optional)

## 🛠️ Installation

1. Clone the repository.
```
git clone https://github.com/weaponsforge/adventofcode.git
```

2. Install dependencies.
```
npm install
```

## 🚀 Usage

Using Node

1. (Optional) Replace the values of specific `input.txt` in the `"/src//"` directories with actual AoC input.
2. Run a non-test TypeScript file inside the **/src** directory from the project's _**"root directory"**_. For example:
```
npx vite-node src/sample/sample.ts
```

```
npx vite-node src/2024/2024-12-01/main.ts
```
3. Run compiled JavaScript code from the TypeScript files. For example:
```
npm run transpile
node dist/sample/sample.js
```
4. See the [Available Scripts](#-available-scripts) section for more information.

## ⚡ Alternate Usage

Using Docker

- **Build the image**
```
docker compose -f docker-compose.dev.yml build
```

- **Transpile the TypeScript files to JavaScript** (PowerShell)
```
docker run -it -v ${pwd}:/opt/app -v /opt/app/node_modules --rm weaponsforge/adventofcode:dev npm run transpile
```

- **Run tests** (PowerShell)
```
docker run -it -v ${pwd}:/opt/app -v /opt/app/node_modules --rm weaponsforge/adventofcode:dev npm test
```

- **Watch TS file updates: Use available scripts** - e.g., `npm run watch`, `npm run docker:watch:win`
```
docker run -it -v ${pwd}:/opt/app -v /opt/app/node_modules --rm weaponsforge/adventofcode:dev
```

- **Run a script and debug it with the VSCode Debugger**
- Prepare a function for debugging with VSCode in Docker. Wrap it in the `AOCRunScript()` function.
- Assign the path to a TypeScript file from the previous step to the package.json file's `"docker:debug"` script, replacing `src/sample/sample.ts`.
- `"docker:debug": "export IS_DOCKER=true && node --inspect=0.0.0.0:9229 ./node_modules/.bin/vite-node src/path/to/script.ts"`
- Run the script with VSCode debugging (PowerShell):
```
docker run -it -v ${pwd}:/opt/app -v /opt/app/node_modules -p 9229:9229 --rm weaponsforge/adventofcode:dev npm run docker:debug
```
> **INFO:** This process requires attaching a debugger with the VSCode launch config defined in Issue [#53](https://github.com/weaponsforge/adventofcode/issues/53)

VSCode Launch Configuration

```json
{
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "attach",
"name": "Attach to Docker",
"address": "localhost",
"port": 9229,
"restart": true,
"skipFiles": ["/**"],
"localRoot": "${workspaceFolder}",
"remoteRoot": "/opt/app"
}
]
}
```

## 📜 Available Scripts

These scripts, compatible with running in Node and Docker, run various TypeScript scripts and tests.

Click to expand the list of available scripts

### `npm run dev`

Runs `vitest` in watch mode, watching file changes and errors to files linked with `*.test.ts` files.

### `npm run watch`

Watches file changes in `.ts` files using the `tsc --watch` option.

### `npm run dev:debug`

Runs the sample TS script.

### `npm run transpile`

Builds JavaScript, `.d.ts` declaration files, and map files from the TypeScript source files.

### `npm run transpile:noemit`

Runs type-checking without generating the JavaScript or declaration files from the TypeScript files.

### `npm run lint`

Lints TypeScript source codes.

### `npm run lint:fix`

Fixes lint errors in TypeScript files.

### `npm test`

Runs test scripts defined in `*.test.ts` files.

## 📦 Docker Scripts

These scripts allow optional Docker-related processes, such as enabling file watching in Docker containers running in Windows WSL2 and others.

Click to expand the list of available scripts

**Docker run command (PowerShell)**

`docker run -it -v ${pwd}:/opt/app -v /opt/app/node_modules --rm weaponsforge/adventofcode:dev `

### `npm run docker:debug`

- Runs the `"/src/sample/sample.ts"` script in containers with debugging enabled in VSCode.
- Replace the `"/src/sample/sample.ts"` file path in the package.json file's `"docker:debug"` script with a target TypeScript file for debugging.
- Map port **9229** to enable debugging VSCode while running in Docker (PowerShell).

- `docker run -it -v ${pwd}:/opt/app -v /opt/app/node_modules -p 9229:9229 --rm weaponsforge/adventofcode:dev npm run docker:debug`
- Launch the VSCode debugger using the following configuration:

### `npm run docker:watch:win`

Watches file changes in `.ts` files using the `tsc --watch` option with `dynamicPriorityPolling` in Docker containers running in Windows WSL2.

### `npm run docker:dev:win`

- Sets and exports the environment variables: `CHOKIDAR_USEPOLLING=1` and `CHOKIDAR_INTERVAL=1000`
- Runs `vitest` in watch mode inside Docker containers running in Windows WSL2, watching file changes and errors to files linked with `*.test.ts` files.

@weaponsforge

20241213