CaenCamp / jobs-caen-camp

Gestion d'offres d'emploi pour les CaenCamp
https://www.caen.camp
GNU General Public License v3.0
9 stars 5 forks source link

Besoin de règles de formatage pour openapi.yaml #68

Open Keksoj opened 4 years ago

Keksoj commented 4 years ago

Le fichier openapi est en yaml, avec des tabulations larges de deux espaces. VScode me propose deux linters différents, mais comment les configurer ? J'ai peur de tout casser.

Ce qui serait super, ce serait d'avoir un fichier du genre .ymllinterrc avec les règles de formatages pour le yaml, dans le fichier racine. Qu'en pensez-vous ? Connaissez-vous des solutions ?

gaelreyrol commented 4 years ago

Il faut installer l'extension editorconfig, qui va se servir de ce fichier .editorconfig pour savoir quoi configurer et pour quels types de fichier.

Pour ce qui est du linter, tu peux faire une PR :) Il y a ce paquet yaml-lint qui a l'air de faire le taff !

Keksoj commented 4 years ago

Merci beaucoup, je n'avais pas vu ce .editorconfig. À voir si je fais une PR !

Keksoj commented 4 years ago

Editorconfig était installé mais n'a pas pris en compte .editorconfig chez moi.

Dans cette PR j'ai opéré ce changement sur .prettierrc :

{
    "trailingComma": "es5",
    "tabWidth": 4,
    "semi": true,
    "singleQuote": true,
    "overrides": [ // nouveau
        {
            "files": "openapi.yaml",
            "options": {
                "tabWidth": 2
            }
        }
    ]
}

ça marche impec et ça a été retenu. Selon les besoins, on pourra ajouter docker-compose.yml par exemple.

gaelreyrol commented 4 years ago

La norme pour l'indentation des fichiers YAML c'est 2 espaces donc je comprends pas qu'on ai besoin de faire un override. C'est redondant pour moi.