Générateur EditorConfig

.editorconfig
Résultats

Un .editorconfig à la racine du dépôt indique à chaque IDE moderne comment ce projet formate ses fichiers, réglant la question des tabulations contre les espaces fichier par fichier. Python: 4 espaces. JavaScript: 2. Makefile: tabulations (obligatoire). Ce générateur construit un .editorconfig à partir de vos choix de formatage (style et taille d’indentation, fin de ligne, jeu de caractères, longueur maximale de ligne, nouvelle ligne finale et suppression des espaces en fin de ligne) et inclut toujours les deux ajustements courants: [*.md] conserve les espaces en fin de ligne pour les retours à la ligne de Markdown, et [Makefile] utilise des tabulations, comme make l’exige.

Comment construire un .editorconfig

  1. 1

    Définir les valeurs par défaut globales

    Jeu de caractères (utf-8 par défaut), fin de ligne (lf vs crlf), style et taille d'indentation, longueur maximale de ligne, nouvelle ligne finale et suppression des espaces en fin de ligne.

  2. 2

    Vérifier les ajustements intégrés

    Le générateur ajoute toujours `[*.md]` avec `trim_trailing_whitespace = false` (Markdown a besoin d'espaces en fin de ligne pour les retours à la ligne) et `[Makefile]` avec `indent_style = tab`, exigé par make lui-même.

  3. 3

    Copier le fichier

    Utilisez le bouton de copie pour récupérer le `.editorconfig` généré et placez-le à la racine du dépôt.

  4. 4

    Le compléter plus tard

    Besoin de règles par langue? Ajoutez vos propres sections, par exemple `[*.py]` avec `indent_size = 4`.

Ce que fait .editorconfig

Un fichier nommé .editorconfig à la racine d’un projet (ou dans n’importe quel répertoire) déclare des conventions de formatage. Les éditeurs prenant en charge EditorConfig (tous les principaux IDE et la plupart des éditeurs de texte modernes) appliquent ces règles à l’ouverture du fichier.

Exemple de sortie

Avec les réglages par défaut (espaces, taille 4, LF, utf-8), le générateur produit:

root = true

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

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab

Directives clés

Directive Valeurs acceptées Remarques
root true / false Définir true à la racine du projet pour que la recherche s’arrête
charset utf-8, utf-8-bom, latin1, utf-16-be, utf-16-le utf-8 est la valeur par défaut
end_of_line lf, crlf, cr lf pour multiplateforme ; crlf pour les dépôts Windows uniquement
indent_style space, tab
indent_size entier Nombre d’espaces, ignoré lors de l’utilisation de tabulations
tab_width entier Largeur visuelle d’une tabulation (indent_size par défaut)
insert_final_newline true / false Assure des fichiers conformes à POSIX
trim_trailing_whitespace true / false Désactivez pour Markdown (les espaces à la fin signifient des sauts de ligne)

Conventions linguistiques en un coup d’œil

Langue / fichier Convention
JS, TS, JSON 2 espaces
HTML, CSS, YAML 2 espaces
Python 4 espaces (PEP 8)
PHP 4 espaces (PSR-12)
Ruby 2 espaces
Go Tabulations (gofmt impose)
Rust 4 espaces (rustfmt impose)
Java 4 espaces
Makefile Tabulations (requises par make lui-même)
Markdown Conservez les espaces à la fin (utilisés pour <br>)
Batch/CMD (.bat) fins de ligne crlf

Piège : espaces blancs à la fin dans Markdown

Dans Markdown, deux espaces à la fin d’une ligne signifient “insérer un <br> ici”. Si votre .editorconfig supprime les espaces blancs à la fin pour tous les fichiers, ces sauts de ligne disparaissent. Remplacez par trim_trailing_whitespace = false pour [*.md].

Votre IDE le prend-il en charge ?

Prise en charge native : VS Code, famille JetBrains IntelliJ, Sublime Text, Vim (via plugin), Emacs (via plugin), Atom, Notepad++, Xcode. Si un éditeur ne prend pas en charge EditorConfig par défaut, il a généralement un plugin. Le fichier est également lisible par machine, donc les linters et formatters peuvent en tenir compte.

Questions fréquentes

À la racine du projet avec root = true. Vous pouvez ajouter des fichiers .editorconfig supplémentaires dans des sous-répertoires pour remplacer des chemins spécifiques ; la recherche remonte l’arborescence et s’arrête au premier fichier root = true trouvé.

Non. EditorConfig gère les bases des espaces blancs et des fins de ligne à travers chaque éditeur. Prettier et les linters spécifiques à la langue gèrent des règles de style plus profondes (guillemets, points-virgules, virgules finales). Les deux se complètent.

Définissez end_of_line = crlf si les outils Windows dans le dépôt l’exigent réellement. Meilleure option : validez end_of_line = lf et ajoutez un .gitattributes avec * text=auto afin que git normalise les fins de ligne lors de la validation tandis que les extractions sont appropriées au système d’exploitation.

Non. Vos choix servent uniquement à générer le fichier; rien n’est stocké sur nos serveurs et rien n’est conservé après votre départ de la page.

Outils similaires

Outil disponible dans d’autres langues