Start using djLint in development flow

partio-scout · Dec 19, 2024 · a875021 · a875021
1 parent cd1cbf9
commit a875021
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git 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
@@ -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