MarcoBuster/yt-dlp
1
0
Fork 0
mirror of https://github.com/yt-dlp/yt-dlp.git synced 2024-06-25 23:20:21 +02:00
Code Issues Projects Releases Wiki Activity

Stylistic review

Browse Source
This commit is contained in:
Simon Sawicki 2024-04-21 15:08:58 +02:00
parent 31d5d8eb1b
commit 3684821140
No known key found for this signature in database
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -145,17 +145,17 @@ # DEVELOPER INSTRUCTIONS
$ hatch run setup
```
so that required checks run automatically before a commit (using pre-commit). This will ensure that certain tests are running before a commit, like formatting. A failing test will mean that the commit will be blocked; fix the failing case and try to commit the fixed version again.
to install a `pre-commit` hook so that required checks (linting, formatting) will run automatically before each commit. If any of the checks fail, then the commit will be blocked; you'll need to fix the failing case and then you can commit the fixed version.
After this you can use `hatch shell` to enable a virtual environment that has development dependencies as well as `yt-dlp` installed. Scripts can be used to run simple tasks, like linting or testing, without having to run `hatch shell` first:
After this you can use `hatch shell` to enable a virtual environment that has `yt-dlp` and its development dependencies installed.
In addition, the following script commands can be used to run simple tasks such as linting or testing (without having to run `hatch shell` first):
* `hatch run format`: Format the code according to yt-dlp code standards
* `hatch run lint`: Find common issues and automatically fix some of them
* `hatch run fix`: Both format and lint the code
* `hatch run fix`: Automatically fix linter violations and apply required code formatting changes
* `hatch run check`: Check if the code is formatted and linted
* `hatch run test`: Run extractor or core tests
To automatically fix linter violations as well as format the code, use `hatch run fix`.
You can run scripts for all available and supported python versions sequentially by setting the `TEST_ALL` variable:
```shell
$ TEST_ALL=1 hatch run test core

2
Makefile
View File

@ -27,7 +27,7 @@ clean-dist:
yt_dlp/extractor/lazy_extractors.py *.spec CONTRIBUTING.md.tmp yt-dlp yt-dlp.exe yt_dlp.egg-info/ AUTHORS
clean-cache:
find . \( \
-type d -name '.*_cache' -o -type d -name __pycache__ -o -name "*.pyc" -o -name "*.class" \
-type d -name ".*_cache" -o -type d -name __pycache__ -o -name "*.pyc" -o -name "*.class" \
\) -prune -exec rm -rf {} \;
completion-bash: completions/bash/yt-dlp