Cet article a pour objectif de fournir les méthodes de syntaxe, les conventions et structures d’application au développement des applications internes d’Ingéniance.

Pourquoi ? Simplement pour unifier le code rédigé et simplifier le code review, mais aussi pour donner des mécaniques de développement afin d’obtenir une meilleure lisibilité et maintenabilité du code.

Cette guideline est susceptible d’évoluer en fonction des choix techniques futurs. N’hésitez pas à nous faire part de vos interrogations ou suggestions.

TSLint

TypeScript peut être utilisé conjointement avec TSLint, un analyseur de code dédié à TypeScript.
Pour cela, depuis la page de gestion des modules Visual Studio Code, installez TSLint d’egamma.
Il vous faudra également lancer une commande npm pour installer globalement la dernière version de TSLint et Typescript :

npm install -g tslint typescript

Pour chaque projet, un fichier tslint.json devra être mis à disposition à la racine de celui-ci. Ainsi TSLint pourra mettre en surbrillance les éléments contrevenant à la bonne lecture du code.

Prettier

Pour vous aider dans la mise en forme du code, il est recommandé d’ajouter en complément de TSLint le module Prettier.
Depuis la page de gestion des modules de Visual Studio Code, installez Prettier d’Esben Petersen.
Pour configurer Prettier, vous pouvez vous référer à la documentation suivante : https://prettier.io/docs/en/configuration.html
Dans l’idéal, vous pouvez déclarer un paramètre dans le package.json de votre projet :

"prettier": {
    "singleQuote": true
 }

Via la commande Alt + Shift + F, vous réaliserez automatiquement une remise en page du code, sur le modèle fourni par le fichier de configuration de Prettier.
Celle-ci peut être automatisée à la sauvegarde du document en ajoutant dans les paramètres de Visual Studio Code la configuration suivante :

// Set the default
"editor.formatOnSave": true,
// Enable per-language
"[[javascript]]": {
    "editor.formatOnSave": true
}

0 commentaire

Laisser un commentaire

Avatar placeholder

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.

TypeScript Style Guide

par Cyrille P. temps de lecture : 1 min
0