mirror of
https://github.com/theoludwig/advent_of_code_2023.git
synced 2024-11-09 22:08:53 +01:00
2.9 KiB
2.9 KiB
theoludwig/advent_of_code_2023
My Solutions for the Advent of Code 2023, implemented in the Rust Programming Language.
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.