added precommit poe task

jdepoix · Nov 11, 2024 · ec3fbe9 · ec3fbe9
1 parent 32ea9c1
commit ec3fbe9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -384,6 +384,11 @@ poe format
 poe lint
 ```
 
+If you just want to make sure that your code passes all the necessary checks to get a green build, you can simply run:
+```shell
+poe precommit
+```
+
 ## Donations
 
 If this project makes you happy by reducing your development time, you can make me happy by treating me to a cup of coffee, or become a [Sponsor of this project](https://github.com/sponsors/jdepoix) :)  

diff --git a/pyproject.toml b/pyproject.toml
@@ -44,6 +44,7 @@ coverage.shell = "coverage run -m unittest discover && coverage report -m --fail
 format = "ruff format youtube_transcript_api"
 ci-format = "ruff format youtube_transcript_api --check"
 lint = "ruff check youtube_transcript_api"
+precommit.shell = "poe format && poe lint && poe coverage"
 
 [tool.poetry.dependencies]
 python = ">=3.8,<3.14"