Si un projet nécessite un formateur de code différent, définissez ce choix au niveau du projet : utilisez le fichier de configuration de ce projet et, si vous travaillez dans Visual Studio Code, ses paramètres d’espace de travail (workspace settings). Cela permet de préserver vos paramètres utilisateur VS Code par défaut tout en rendant le choix de formatage du projet reproductible. Les étapes ci-dessous se concentrent sur macOS et VS Code ; d'autres éditeurs peuvent utiliser des commandes différentes.

Déterminer ce que signifie « formateur » pour ce projet

Identifiez d’abord le langage et le besoin réel. Un formateur réécrit le code selon un style défini ; un paramètre d’éditeur basique peut uniquement contrôler l'indentation, les fins de ligne ou les espaces blancs. Par exemple, EditorConfig fournit des propriétés de style de projet que les éditeurs compatibles peuvent lire, tandis que Prettier est un formateur doté de sa propre configuration de projet. Ces outils peuvent se compléter, mais un fichier EditorConfig seul ne sélectionne ni n'installe un formateur. EditorConfig décrit son format et ses extensions pour éditeurs ; le guide de configuration de Prettier explique comment il lit les fichiers de configuration pris en charge.

Vérifiez quel formateur est déjà utilisé par le projet avant d'en ajouter un autre. Consultez son manifeste de paquets, la configuration du formateur et la documentation du projet. Si vos collaborateurs ou des vérifications automatisées s'attendent à un outil ou à une version spécifique, adopter cette même configuration est généralement le choix le plus pratique. Installer un formateur concurrent ou modifier ses options peut générer d'importants diffs, même si le code fonctionne toujours.

Choisir l’emplacement du paramètre

Dans VS Code, les paramètres utilisateur s'appliquent à l'ensemble de votre utilisation de l'éditeur, tandis que les paramètres d’espace de travail s'appliquent au projet ouvert et prévalent sur les paramètres utilisateur. VS Code conserve les paramètres d'espace de travail dans un dossier .vscode à la racine du projet ; les paramètres utilisateur sont stockés séparément dans le répertoire Application Support de votre compte macOS. Utilisez la palette de commandes (⇧⌘P) et choisissez Preferences: Open Workspace Settings (JSON) pour modifier le paramètre du projet. Assurez-vous que l'éditeur de paramètres indique bien Workspace avant de modifier quoi que ce soit. La documentation des paramètres de VS Code explique les différentes portées et emplacements.

Pour choisir un formateur uniquement pour un langage spécifique dans ce projet, ajoutez une entrée de formateur par défaut propre à ce langage dans les paramètres d'espace de travail. Par exemple, si le projet utilise l'extension VS Code de Prettier pour JavaScript, le paramètre prend cette forme :

{
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

Utilisez l'identifiant d'extension correspondant au formateur réellement installé dans votre éditeur ; l'exemple ci-dessus n'est pas un identifiant universel. Si le projet comporte plusieurs langages, ajoutez une entrée pour chaque langage concerné plutôt que de définir un paramètre global par défaut. La commande Format Document With... de VS Code vous permet de choisir parmi les formateurs disponibles pour le document actif, et ses actions de formatage peuvent être exécutées depuis la palette de commandes. Le guide de formatage de VS Code détaille ces commandes. Évitez d'activer le formatage à l'enregistrement (format-on-save) dans le cadre de ce changement ciblé, à moins que vous ne souhaitiez que chaque enregistrement dans ce projet déclenche un formatage.

Conserver les règles du formateur avec le projet

Un formateur par défaut sélectionne un outil ; il ne définit pas l’ensemble des règles de formatage de cet outil. Stockez les règles partagées dans un fichier de configuration reconnu par le formateur choisi. Pour Prettier, il peut s'agir d'un fichier .prettierrc.json à la racine du projet. Un exemple minimal peut spécifier uniquement les options convenues pour le projet :

{
  "singleQuote": true
}

Prettier recherche la configuration à partir du fichier en cours de formatage en remontant à travers ses répertoires parents, de sorte qu'une configuration à la racine peut s'appliquer aux fichiers situés en dessous. Il prend également en charge plusieurs autres formats de configuration ; choisissez-en un compatible avec la version du projet et les outils existants. La documentation de configuration de Prettier répertorie les fichiers pris en charge et le comportement de résolution.

Si le but est uniquement d'avoir une indentation ou des fins de ligne cohérentes entre différents éditeurs, envisagez plutôt un fichier .editorconfig à la racine. Par exemple, root = true interrompt la recherche d'autres fichiers EditorConfig situés plus haut, et des propriétés telles que indent_style, indent_size et end_of_line peuvent définir des conventions de texte de base. La prise en charge par les éditeurs varie selon les extensions, et ces propriétés ne remplacent pas les règles de formatage propres à chaque langage. La spécification et présentation d'EditorConfig décrivent la manière dont les fichiers sont localisés et comment les règles correspondantes sont appliquées.

Vérifier la portée avant de formater

Enregistrez le paramètre d'espace de travail et la configuration, puis rouvrez le dossier du projet dans VS Code si nécessaire. Ouvrez un fichier représentatif et utilisez Format Document With... pour confirmer le formateur sélectionné. Si le formateur n'apparaît pas, vérifiez que son extension est installée et prend en charge ce langage ; un paramètre d'espace de travail ne peut pas installer d'extension ni ajouter lui-même la prise en charge d'un formateur.

Avant d'appliquer le formatage à grande échelle, inspectez les fichiers affectés dans le contrôle de code source (Source Control) ou dans une vue différentielle (diff). Formatez d'abord un petit ensemble représentatif de fichiers, surtout si le projet comporte déjà des règles de style ou des fichiers générés. Si le résultat est inattendu, arrêtez-vous et vérifiez s'il n'y a pas une configuration concurrente dans un répertoire parent, un paramètre propre au langage ou un autre formateur déjà attendu par le projet. Annulez toute modification de formatage indésirable via les outils de contrôle de code source de l'éditeur, puis ajustez la configuration du projet et réessayez sur un petit échantillon.

Cette approche permet de lier la décision au projet : les paramètres utilisateur par défaut de VS Code restent dans leur portée distincte, tandis que le projet conserve sa propre sélection de formateur et ses propres règles. Si vous changez d'éditeur, le paramètre d'espace de travail ne sera pas transféré ; fiez-vous donc à la configuration de projet du formateur lorsque cet éditeur la prend en charge.

Sources