klmp200/Sith
1
0
Fork 0
mirror of https://github.com/ae-utbm/sith.git synced 2025-07-10 20:09:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Biome to documentation

Browse Source
This commit is contained in:
Antoine Bartuccio
2024-10-08 01:49:29 +02:00
parent d0c18d4538
commit 24925f7726
4 changed files with 40 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/explanation/conventions.md
View File

@ -152,13 +152,13 @@ En ce qui concerne les templates Jinja
et les fichiers SCSS, la norme de formatage
est celle par défaut de `djHTML`.
Pour Javascript, nous utilisons [standard](https://github.com/standard/standard).
Pour Javascript, nous utilisons [biome](https://biomejs.dev/).
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,
Biome 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
@ -167,9 +167,9 @@ un peu comme ruff.
### Qualité du code
Pour s'assurer de la qualité du code, Ruff et Standard sont également utilisés.
Pour s'assurer de la qualité du code, Ruff et Biome sont également utilisés.
Tout comme pour le format, Ruff et Standard ddoivent tourner avant chaque commit.
Tout comme pour le format, Ruff et Biome doivent tourner avant chaque commit.
!!!note "to edit or not to edit"
@ -190,11 +190,11 @@ Tout comme pour le format, Ruff et Standard ddoivent tourner avant chaque commit
ruff check --fix
```
Standard se comporte d'une manière très similaire
Biome 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
npx @biomejs/biome check # Liste toutes les erreurs et leurs catégories
npx @biomejs/biome check --write # Applique tous les fix considérés safe et formate le code
```

14
docs/explanation/technos.md
View File

@ -354,25 +354,27 @@ 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
### Biome
[Site officiel](https://github.com/standard/standard)
[Site officiel](https://biomejs.dev/)
Puisque Ruff ne fonctionne malheureusement que pour le Python,
nous utilisons Standard pour le javascript.
nous utilisons Biome pour le javascript.
Tout comme Ruff, standard fait office de formateur et de linter.
Biome est également capable d'analyser et formater les fichiers json et css.
Tout comme Ruff, Biome fait office de formateur et de linter.
### DjHTML
[Site officiel](https://github.com/rtts/djhtml)
Ruff permet de formater les fichiers Python et Standard les fichiers js,
Ruff permet de formater les fichiers Python et Biome 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, Standard et djHTML,
En utilisant conjointement Ruff, Biome et djHTML,
on arrive donc à la fois à formater les fichiers
Python et les fichiers relatifs au frontend.