Add Standard to documentation

This commit is contained in:
2024-10-07 01:36:09 +02:00
parent a3cca056ae
commit 37eaa4b912
3 changed files with 140 additions and 45 deletions

View File

@ -152,16 +152,24 @@ En ce qui concerne les templates Jinja
et les fichiers SCSS, la norme de formatage
est celle par défaut de `djHTML`.
Pour Javascript, vous pouvez utiliser
Prettier, avec sa configuration par défaut,
qui est plutôt bonne,
mais nous n'avons pas de norme établie pour le projet.
Pour Javascript, nous utilisons [standard](https://github.com/standard/standard).
C'est à la fois un formateur et un linter avec très peu de configuration,
un peu comme ruff.
!!!note "Le javascript dans les templates jinja"
Standard n'est pas capable de lire dans les fichiers jinja,
c'est sa principale limitation.
Il est donc recommandé d'éviter de mettre trop de Javascript
directement dans jinja mais de préférer des fichiers dédiés.
### Qualité du code
Pour s'assurer de la qualité du code, Ruff est également utilisé.
Pour s'assurer de la qualité du code, Ruff et Standard sont également utilisés.
Tout comme pour le format, Ruff doit tourner avant chaque commit.
Tout comme pour le format, Ruff et Standard ddoivent tourner avant chaque commit.
!!!note "to edit or not to edit"
@ -182,6 +190,14 @@ Tout comme pour le format, Ruff doit tourner avant chaque commit.
ruff check --fix
```
Standard se comporte d'une manière très similaire
```bash
npx standard # Liste toutes les erreurs et leurs catégories
npx standard --fix # Applique tous les fix considérés safe et formatte le code
```
## Documentation
La documentation est écrite en markdown, avec les fonctionnalités

View File

@ -354,16 +354,25 @@ Bien installé, il peut effectuer ce travail
à chaque sauvegarde d'un fichier dans son éditeur,
ce qui est très agréable pour travailler.
### Standard
[Site officiel](https://github.com/standard/standard)
Puisque Ruff ne fonctionne malheureusement que pour le Python,
nous utilisons Standard pour le javascript.
Tout comme Ruff, standard fait office de formateur et de linter.
### DjHTML
[Site officiel](https://github.com/rtts/djhtml)
Ruff permet de formater les fichiers Python,
mais il ne formatte pas les templates et les feuilles de style.
Ruff permet de formater les fichiers Python et Standard les fichiers js,
mais ils ne formattent pas les templates et les feuilles de style.
Pour ça, il faut un autre outil, aisément intégrable
dans la CI : `djHTML`.
En utilisant conjointement Ruff et djHTML,
En utilisant conjointement Ruff, Standard et djHTML,
on arrive donc à la fois à formater les fichiers
Python et les fichiers relatifs au frontend.