1
1
mirror of https://github.com/theoludwig/advent_of_code_2023.git synced 2024-10-29 22:17:19 +01:00
My solutions for the Advent of Code 2023, implemented in the Rust Programming Language. https://adventofcode.com/2023
Go to file
2024-01-29 21:07:38 +01:00
.github docs: add explanations about external linting tools 2024-01-27 19:18:46 +01:00
.vscode docs: add contributing templates 2024-01-27 18:53:26 +01:00
day_1 ci: test both MSRV and latest stable Rust versions 2024-01-27 17:49:25 +01:00
day_2 ci: test both MSRV and latest stable Rust versions 2024-01-27 17:49:25 +01:00
day_3 ci: test both MSRV and latest stable Rust versions 2024-01-27 17:49:25 +01:00
day_4 ci: test both MSRV and latest stable Rust versions 2024-01-27 17:49:25 +01:00
day_5 ci: test both MSRV and latest stable Rust versions 2024-01-27 17:49:25 +01:00
day_6 ci: test both MSRV and latest stable Rust versions 2024-01-27 17:49:25 +01:00
day_7 docs: add contributing templates 2024-01-27 18:53:26 +01:00
.commitlintrc.json ci: test both MSRV and latest stable Rust versions 2024-01-27 17:49:25 +01:00
.editorconfig test: add cases for input.txt 2023-12-08 18:56:07 +01:00
.gitattributes ci: add automated tests/linting/format 2023-12-01 17:26:01 +01:00
.gitignore ci: add automated tests/linting/format 2023-12-01 17:26:01 +01:00
.markdownlint-cli2.jsonc docs: add contributing templates 2024-01-27 18:53:26 +01:00
.prettierrc.json docs: add contributing templates 2024-01-27 18:53:26 +01:00
Cargo.lock ci: test both MSRV and latest stable Rust versions 2024-01-27 17:49:25 +01:00
Cargo.toml docs: add contributing templates 2024-01-27 18:53:26 +01:00
CODE_OF_CONDUCT.md docs: add contributing templates 2024-01-27 18:53:26 +01:00
CONTRIBUTING.md docs: add contributing templates 2024-01-27 18:53:26 +01:00
LICENSE docs(license): add email address 2024-01-29 21:07:38 +01:00
README.md docs: add explanations about external linting tools 2024-01-27 19:18:46 +01:00

theoludwig/advent_of_code_2023

My Solutions for the Advent of Code 2023, implemented in the Rust Programming Language.

CONTRIBUTING Licence MIT Contributor Covenant
CI Rust Conventional Commits

Getting Started

Prerequisites

Rust Toolchain

The current Minimum Supported Rust Version (MSRV) is v1.74.0.

The project is tested against the following Rust versions:

  • Minimum Supported Rust Version (MSRV): v1.74.0
  • Latest Stable Version

External Linting Tools (optional)

External linting tools are used to ensure a consistent code style and commit message format. They are used in the Continuous Integration (CI) pipeline and can be optionally used locally.

They have to be installed using Node.js >= v20.0.0 and npm >= v10.0.0.

  • editorconfig-checker (npm install --global editorconfig-checker@5.1.2)
  • Prettier v3.2.4 (npm install --global prettier@3.2.4)
  • markdownlint-cli2 v0.12.1 (npm install --global markdownlint-cli2@0.12.1)
  • commitlint v18.6.0 (npm install --global @commitlint/cli@18.6.0 @commitlint/config-conventional@18.6.0)

Usage

# Run a specific day's challenge (e.g. Day 1)
cargo run --package day_1

# Build, Lint, and Test Usage
cargo build
cargo test
cargo clippy --verbose -- -D warnings
cargo fmt -- --check

# External Linting Tools Usage (optional)
editorconfig-checker
prettier . --check
markdownlint-cli2
echo 'chore: try commitlint' | commitlint

💡 Contributing

Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.

The steps to contribute can be found in the CONTRIBUTING.md file.

📄 License

MIT