Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/csessh/aoc.nvim
Neovim's Christmas Elf who fetches puzzle input
https://github.com/csessh/aoc.nvim
advent-of-code adventofcode lua neovim-plugin
Last synced: 26 days ago
JSON representation
Neovim's Christmas Elf who fetches puzzle input
- Host: GitHub
- URL: https://github.com/csessh/aoc.nvim
- Owner: csessh
- License: mit
- Created: 2024-12-05T12:27:56.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-12T03:15:46.000Z (29 days ago)
- Last Synced: 2024-12-12T03:28:12.478Z (29 days ago)
- Topics: advent-of-code, adventofcode, lua, neovim-plugin
- Language: Lua
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - csessh/aoc.vim (⭐3) - Simple little elf who fetches Advent of Code puzzle input for you. (Recently Updated / [Dec 12, 2024](/content/2024/12/12/README.md))
README
# Advent of Code: Neovim Christmas Elf who fetches puzzle input
## Intro
If you're like me and you don't want to copy and paste puzzle input from the web page every single time, this could be something you might find handy.
There are other CLI tools that accomplish the same task, none I could see for Neovim. Inspirations include:
- [CLI written in Rust](https://github.com/scarvalhojr/aoc-cli)
- [CLI written in Python](https://github.com/emilkloeden/aoc-cli-python)
I'd like to stay within Neovim for as long as I could possibly get away with doing so. Hence, this plugin.
In the true developer fashion, I started with one task to solve Advent of Code puzzles, I ended up talking myself into "Let's spend a day or two to write a tool that saves me ... 5s of copy and paste task". Here we are.
### Other features in the work
There are a number of features I'd like to add in the coming days/weeks to get to v1.0.0
- `:AocSubmitAnswer` to submit your answer.
- `:AocGetSampleInput` to write puzzle's sample input to file.
- `:AocYankSampleInput` to yank a puzzle's sample input to a register.
I am always open to any feedbacks and suggestions.
## Requirements
This plugin requires a session token to communicate with [adventofcode.com](https://adventofcode.com).
This is how you generate one:
1. Login to [adventofcode.com](https://adventofcode.com).
2. Open Inspect panel, navigate to Storage tab.
3. Select cookies and copy `session` value.
4. Save to somewhere, e.g. `/var/tmp/aoc.txt`. Remeber to set appropriate permission, e.g `chmod 600` or whatever you deem acceptable.
5. Update plugin config to set `session_filepath` attribute with the filepath above.
## Installation
Let your favourite package manager (`lazy.nvim`) do the work:
``` lua
-- lazy.nvim
return {
"csessh/aoc.nvim",
dependencies = { "nvim-lua/plenary.nvim" },
opts = {}
},
```
Should you want to lazy load this plugin, you could add a condition check in its config:
``` lua
cond = vim.fn.getcwd() == vim.fn.expand("your AOC directory path"),
```
## Default configuration
``` lua
--- Default configuration
---@type table
local default_opts = {
session_filepath = "/var/tmp/aoc.txt", -- Default filepath to your AOC session token
puzzle_input = {
filename = "puzzle.txt", -- Default puzzle input filename
save_to_current_dir = true, -- Save puzzle input file to your current buffer's cwd() using {filename} attribute above
alternative_filepath = nil, -- This option is ONLY used when save_to_current_dir is set to false
-- This option allows you to set a generic filepath for your puzzle input
-- For example: ~/aoc/input.txt or ~/aoc/puzzle ...
},
}
```
## User command
This plugin provides the following user commands:
``` vim
:AocGetPuzzleInput
:AocGetTodayPuzzleInput
:AocClearCache
:AocInspectConfig
```
### AocGetPuzzleInput
This command takes two input from you: day and year.
It will then check cache to see if the puzzle input was previously downloaded to avoid unnecessasry requests to `adventofcode.com`
``` vim
:AocGetPuzzleInput
Day: 8
Year: 2024
Successfully downloaded puzzle for input for Day 8 (2024)
```
### AocGetTodayPuzzleInput
This command doesn't take any input from you. It simply gets the input for today's puzzle if it's unlocked.
It checks cache to see if the puzzle input was previously downloaded to avoid unnecessasry requests to `adventofcode.com`
``` vim
:AocGetTodayPuzzleInput
Successfully downloaded puzzle for input for Day 11 (2024)
```
### AocClearCache
This command wipes out all cached puzzle input files. In such case you decide to switch between accounts, your puzzle inputs will be different and cached input will be invalid.
``` vim
:AocClearCache
Cache cleared
```
### AocInspectConfig
This command allows you to quickly inspect the current plugin configuration.
``` vim
:AocInspectConfig
{
session_filepath = "/var/tmp/aoc.txt",
puzzle_input = {
filename = "puzzle.txt",
save_to_current_dir = true,
alternative_filepath = nil,
},
}
```
## Contribution
All contributions are most welcome! Please open a PR or create an [issue](https://github.com/csessh/aoc.nvim/issues).
### Coding Style
- Follow the coding style of [LuaRocks](https://github.com/luarocks/lua-style-guide).
- Make sure you format the code with [StyLua](https://github.com/JohnnyMorganz/StyLua) before PR.