diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index c5f4530..f10d3d0 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -16,10 +16,12 @@ jobs: run: | python -m pip install --upgrade pip pip install 'black==24.10.0' + pip install 'djlint==1.36.3' - name: Check formatting run: | black -t py312 --check . black -t py312 --check web/**/*.py.example + djlint --check . unit-tests-sqlite: runs-on: ubuntu-latest timeout-minutes: 15 diff --git a/docs/development.md b/docs/development.md index d2e9db0..0d9081e 100644 --- a/docs/development.md +++ b/docs/development.md @@ -72,11 +72,15 @@ Hakemistosta `./web/roobt` löytyy myös toinen robot-tiedosto nimeltään `autentikointi.txt`, mutta sen ajaminen ei taida onnistua, ellei ensin toteuta Kipaan suunniteltua kirjautumista. -## Python-koodin formatointi +## Python-koodin ja Django-templaattien formatointi Koodi noudattaa Black-autoformatterin vesion 24.10.0 mukaista tyyliä. -Blackille annetaan lippu `--target-version py312`. Formatointi tarkastetaan -osana CI-putkea. +Blackille annetaan lippu `--target-version py312`. Templaatit formatoidaan +käyttäen [djLint:tiä](https://www.djlint.com/), joka ajetaan seuraavasti: +`djlint --reformat --profile=django .`. Toisin kuin Black, djLint ei takaa +tiedostojen ehjänä pysymistä, joten muutosten tarkastaminen manuaalisesti +formatoinnin jälkeen voi olla tarpeen. Formatoinnit tarkastetaan osana +CI-putkea. ## Selityksiä lähdekooditiedostoista