Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/devdutt6/aoctemplate

A template generator for advent of code and solution runner.
https://github.com/devdutt6/aoctemplate

advent-of-code advent-of-code-2022 adventofcode template

Last synced: about 7 hours ago
JSON representation

A template generator for advent of code and solution runner.

Awesome Lists containing this project

README

        

# Advent of Code

- A Template generator for Advent of Code hackathon :technologist:.
- It will automatically generate the `input.txt` file and `solution.js` file with the template code so you can directly start writing solution :writing_hand:. You don't need to write the same code daily then import file and run solution on it, i handeled it for you :sunglasses:.
- Just write your solution in `solution.js` file and run it using command `aocrun` with the character by which you want to split the filelines and it will run it :rocket:.

[![NPM](https://img.shields.io/npm/l/aoctemplate)](https://cdn.jsdelivr.net/npm/[email protected]/LICENSE)
![node-current](https://img.shields.io/node/v/aoctemplate)

## Installation


It requires global scope because i wanted to make it a CLI command so that it would be easier to run it anywhere on your machine.

```bash
npm install -g aoctemplate
```

```bash
yarn add aoctemplate --global
```

## Usage


So there are :two: commands one for template generation and other for running that template after you write your solution ofcourse.

```bash
aoc
aocrun
```

### Examples

The command `aoc` will generate two files `input.txt` for pasting your puzzle input and `solution.js` where you will write your puzzle solution.

```bash
aoc 'day_six'
```

The command `aocrun` will parse and run on the inputs of `input.txt` file with the character separator which you will provide and will return the solution of your solution function from `solution.js` file.
```bash
aocrun '\n'
```

## Contributing


### See [CONTRIBUTING.md](CONTRIBUTING.md).

## Bugs and Issues


If you encounter any bugs :beetle: or issues :dart:, feel free
to [open an issue at github](https://github.com/devdutt6/aoctemplate/issues) or email :email::mailbox_with_no_mail: me on
. I will always like to hear from you :deaf_man:.