klmp200/Sith
1
0
Fork 0
mirror of https://github.com/ae-utbm/sith.git synced 2024-10-18 12:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Standard to documentation

Browse Source
This commit is contained in:
Antoine Bartuccio 2024-10-07 01:36:09 +02:00
parent a3cca056ae
commit 37eaa4b912
3 changed files with 140 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/explanation/conventions.md
View File

@ -152,16 +152,24 @@ En ce qui concerne les templates Jinja
et les fichiers SCSS, la norme de formatage et les fichiers SCSS, la norme de formatage
est celle par défaut de `djHTML`. est celle par défaut de `djHTML`.
Pour Javascript, vous pouvez utiliser Pour Javascript, nous utilisons [standard](https://github.com/standard/standard).
Prettier, avec sa configuration par défaut, C'est à la fois un formateur et un linter avec très peu de configuration,
qui est plutôt bonne, un peu comme ruff.
mais nous n'avons pas de norme établie pour le projet.
!!!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 ### 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" !!!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 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 ## Documentation
La documentation est écrite en markdown, avec les fonctionnalités La documentation est écrite en markdown, avec les fonctionnalités

15
docs/explanation/technos.md
View File

@ -354,16 +354,25 @@ Bien installé, il peut effectuer ce travail
à chaque sauvegarde d'un fichier dans son éditeur, à chaque sauvegarde d'un fichier dans son éditeur,
ce qui est très agréable pour travailler. 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 ### DjHTML
[Site officiel](https://github.com/rtts/djhtml) [Site officiel](https://github.com/rtts/djhtml)
Ruff permet de formater les fichiers Python, Ruff permet de formater les fichiers Python et Standard les fichiers js,
mais il ne formatte pas les templates et les feuilles de style. mais ils ne formattent pas les templates et les feuilles de style.
Pour ça, il faut un autre outil, aisément intégrable Pour ça, il faut un autre outil, aisément intégrable
dans la CI : `djHTML`. 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 on arrive donc à la fois à formater les fichiers
Python et les fichiers relatifs au frontend. Python et les fichiers relatifs au frontend.

142
docs/tutorial/devtools.md
View File

@ -99,52 +99,122 @@ votre éditeur pour que Ruff fasse son travail automatiquement à chaque éditio
Nous tenterons de vous faire ici un résumé pour deux éditeurs de textes populaires Nous tenterons de vous faire ici un résumé pour deux éditeurs de textes populaires
que sont VsCode et Sublime Text. que sont VsCode et Sublime Text.
### VsCode === "VsCode"
Installez l'extension Ruff pour VsCode. Installez l'extension Ruff pour VsCode.
Ensuite, ajoutez ceci dans votre configuration : Ensuite, ajoutez ceci dans votre configuration :
```json ```json
{ {
"[python]": { "[python]": {
"editor.formatOnSave": true, "editor.formatOnSave": true,
"editor.defaultFormatter": "charliermarsh.ruff" "editor.defaultFormatter": "charliermarsh.ruff"
}
} }
} ```
```
### Sublime Text === "Sublime Text"
Vous devez installer ce plugin : https://packagecontrol.io/packages/LSP-ruff. Vous devez installer le plugin [LSP-ruff](https://packagecontrol.io/packages/LSP-ruff).
Suivez ensuite les instructions données dans la description du plugin. Suivez ensuite les instructions données dans la description du plugin.
Dans la configuration de votre projet, ajoutez ceci: Dans la configuration de votre projet, ajoutez ceci:
```json ```json
{ {
"settings": { "settings": {
"lsp_format_on_save": true, "lsp_format_on_save": true,
"LSP": { "LSP": {
"LSP-ruff": { "LSP-ruff": {
"enabled": true, "enabled": true,
}
} }
} }
} }
} ```
Si vous utilisez le plugin [anaconda](http://damnwidget.github.io/anaconda/),
pensez à modifier les paramètres du linter pep8
pour éviter de recevoir des warnings dans le formatage
de ruff comme ceci :
```json
{
"pep8_ignore": [
"E203",
"E266",
"E501",
"W503"
]
}
```
## Configurer Standard pour son éditeur
!!!note
Standard est inclus dans les dépendances du projet.
Si vous avez réussi à terminer l'installation, vous n'avez donc pas de configuration
supplémentaire à effectuer.
Pour utiliser Standard, placez-vous à la racine du projet et lancer la commande suivante:
```bash
npx standard --fix # pour formatter le code
npx standard # pour linter le code
``` ```
Si vous utilisez le plugin [anaconda](http://damnwidget.github.io/anaconda/), Standard va alors faire son travail sur l'ensemble du projet puis vous dire
pensez à modifier les paramètres du linter pep8 si des documents ont été reformatés (si vous avez fait `npx standard`)
pour éviter de recevoir des warnings dans le formatage ou bien s'il y a des erreurs à réparer (si vous avez faire `npx standard --fix`).
de ruff comme ceci :
```json Appeler Standard en ligne de commandes avant de pousser votre code sur Github
{ est une technique qui marche très bien.
"pep8_ignore": [ Cependant, vous risquez de souvent l'oublier.
"E203", Or, lorsque le code ne respecte pas les standards de qualité,
"E266", la pipeline bloque les PR sur les branches protégées.
"E501",
"W503" Pour éviter de vous faire régulièrement avoir, vous pouvez configurer
] votre éditeur pour que Standard fasse son travail automatiquement à chaque édition d'un fichier.
} Nous tenterons de vous faire ici un résumé pour deux éditeurs de textes populaires
``` que sont VsCode et Sublime Text.
=== "VsCode"
Standard est fourni par le plugin [vscode-standard](https://marketplace.visualstudio.com/items?itemName=standard.vscode-standard).
Ensuite, ajoutez ceci dans votre configuration :
```json
{
standard.autoFixOnSave: true
}
```
=== "Sublime Text"
Pour formatter, il suffit d'installer le plugin [StandardFormat](https://packagecontrol.io/packages/StandardFormat).
Aucune configuration supplémentaire n'est nécessaire.
Pour la partie linter, cela nécessite plus de réglage.
* Installer [sublimelinter](http://www.sublimelinter.com/en/latest/installation.html)
* Installer le plugin pour standard [SublimeLinter-contrib-standard](https://packagecontrol.io/packages/SublimeLinter-contrib-standard)
Et enfin, dans la configuration de votre projet, ajouter les lignes suivantes :
```json
{
"settings": {
"linters": {
"standard": {
"paths": {
"PATH":"./node_modules/.bin/standard"
}
}
},
}
}
```
Pensez à redémarrer le plugin sublimelinter.