diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..291c3bde --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,6 @@ +repos: + - repo: https://github.com/astral-sh/ruff-pre-commit + # Ruff version. + rev: v0.4.2 + hooks: + - id: ruff-format diff --git a/README.md b/README.md index bc43bbc5..d9d223bd 100644 --- a/README.md +++ b/README.md @@ -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 what’s 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`. diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 00000000..4745ae0c --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,2 @@ +ruff==0.4.2 +pre-commit==3.7.0