Générateur de .editorconfig

Qu'est-ce que Générateur de .editorconfig ?

EditorConfig maintient un style de code cohérent entre éditeurs et IDE (VS Code, JetBrains, Vim, Visual Studio, Sublime…). Cet outil crée un fichier .editorconfig avec vos règles d'indentation, de fins de ligne, de jeu de caractères et d'espaces, plus des règles courantes par type de fichier comme les tabulations pour les Makefiles et Go ou 4 espaces pour Python.

Comment utiliser Générateur de .editorconfig

1. Choisissez l'Indentation (espaces ou tabulations) et la Taille de l’indentation ou la Largeur de tabulation.
2. Définissez les Fins de ligne, le Jeu de caractères et une Longueur de ligne max. facultative.
3. Activez Supprimer les espaces en fin de ligne et Ajouter un saut de ligne final, et choisissez les Règles par type de fichier dont vous avez besoin.
4. Téléchargez .editorconfig et placez-le à la racine de votre projet.

Exemple

Spaces, size 2, LF, UTF-8, trim whitespace, final newline, Markdown and Makefile overrides

# EditorConfig: https://editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab

Quand utiliser Générateur de .editorconfig

Utilisez-le dans tout dépôt édité par plusieurs personnes ou éditeurs, en particulier dans des équipes mixtes Windows/macOS/Linux où les fins de ligne diffèrent. EditorConfig ne contrôle que les espaces de base ; utilisez un formateur comme Prettier, Black ou gofmt pour le style de code complet, de préférence configuré en accord avec ces réglages.

Comment fonctionne Générateur de .editorconfig

Le fichier commence par root = true pour que les éditeurs cessent de chercher dans les dossiers parents, suivi d'une section [*] avec indent_style, indent_size (ou tab avec tab_width pour les tabulations), end_of_line, charset, trim_trailing_whitespace et insert_final_newline selon la spécification EditorConfig. Les règles particulières sont ajoutées comme sections glob ultérieures ([*.md], [*.{yml,yaml}], [*.py], [*.go], [Makefile]), qui l'emportent sur [*] pour les fichiers correspondants.

Cas d'utilisation courants

• ✓ Mettre fin aux changements tabulations/espaces et CRLF/LF dans les pull requests
• ✓ Définir une indentation de 2 espaces pour un projet JavaScript
• ✓ Garder des tabulations dans les Makefiles tout en utilisant des espaces ailleurs
• ✓ Préserver les sauts de ligne Markdown faits avec des espaces en fin de ligne

Questions Fréquentes

Explorer d'autres catégories