add ruff pre-commit hook and README info

This commit is contained in:
yedpodtrzitko 2024-05-02 01:01:36 +08:00
parent 1030328420
commit afd6e113d2
3 changed files with 13 additions and 1 deletions

6
.pre-commit-config.yaml Normal file
View file

@ -0,0 +1,6 @@
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.4.2
hooks:
- id: ruff-format

View file

@ -276,4 +276,8 @@ As of right now, no. However, I _did_ have a CLI version in the recent past befo
**Yes!!** I recommend taking a look at the [Priority Features](#priority-features), [Future Features](#future-features), and [Features I Won't Pull](#features-i-likely-wont-addpull) lists, as well as the project issues to see whats currently being worked on. Please do not submit pull requests with new feature additions without opening up an issue with a feature request first.
Code formatting is automatically checked via [ruff](https://docs.astral.sh/ruff/). To format your code, install ruff via `pip install -r requirements-dev.txt` and run `ruff format`
Code formatting is automatically checked via [ruff](https://docs.astral.sh/ruff/).
To format the code manually, install ruff via `pip install -r requirements-dev.txt` and then run `ruff format`
To format the code automatically before each commit, there's a configured action available for `pre-commit` hook. Install it by running `pre-commit install`. The hook will be executed each time on running `git commit`.

2
requirements-dev.txt Normal file
View file

@ -0,0 +1,2 @@
ruff==0.4.2
pre-commit==3.7.0