Merge pull request #695 from NLeSC/588-replace-yapf-with-ruff-format

Author: sjvrijn

CHANGELOG.md

@@ -8,6 +8,8 @@
 
 ### Changed
 
+* Recommend `ruff format` instead of `yapf` for fixing code style readability [#695](https://github.com/NLeSC/python-template/pull/695)
+
 ### Removed
 
 ## 0.6.1

template/pyproject.toml.jinja

@@ -135,6 +135,7 @@ ignore = [
     "FIX001", # Resolve FIXMEs
     "FIX002", # Resolve TODOs
     "B028",   # No explicit `stacklevel` keyword argument found in warning
+    "COM812", # Trailing commas are taken care of by `ruff format`
     # No docstrings required in the following cases
     "D100", # Missing module docstring
     "D104", # Missing public package docstring

template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja

@@ -65,7 +65,7 @@ coverage report
 {%- if AddLinting -%}
 ## Running linters locally
 
-For linting and sorting imports we will use [ruff](https://beta.ruff.rs/docs/). Running the linters requires an
+For linting and sorting imports we will use [ruff](https://docs.astral.sh/ruff/). Running the linters requires an
 activated virtual environment with the development tools installed.
 
 ```shell
@@ -76,7 +76,11 @@ ruff check .
 ruff check . --fix
 ```
 
-To fix readability of your code style you can use [yapf](https://github.com/google/yapf).
+It also provides a command to fix readability of your code style:
+
+```shell
+ruff format .
+```
 {%- endif -%}
 
 {%- if AddPreCommit -%}

template/{% if AddPreCommit %}.githooks{% endif %}/pre-commit

@@ -6,8 +6,8 @@ echo "Script $0 triggered ..."
 echo "Starting ruff analysis..."
 
 # quietly run ruff
-ruff check --fix
-ruff format
+ruff check --fix .
+ruff format .
 
 # use return code to abort commit if necessary
 if [ $? != "0" ]; then

template/{% if HasWorkflows %}.github{% endif %}/workflows/{% if AddGitHubActionBuild %}build.yml{% endif %}.jinja

@@ -61,8 +61,8 @@ jobs:
           python -m pip install .[dev,publishing]
       - name: Check style against standards using ruff
         run: |
-          ruff check
-          ruff format --check
+          ruff check .
+          ruff format --check .
 {%- endif %}
 
 {%- if AddTyping %}
@@ -82,4 +82,4 @@ jobs:
       - name: Run {{ SelectTypeChecker }}
         run: |
           {{ SelectTypeChecker }}
-{%- endif %}
+{%- endif %}