Variables

Utilisez des noms de variables significatifs et faciles à prononcer

Mauvais exemple :

const yyyymmdstr = moment().format("YYYY/MM/DD");

Bon exemple :

const currentDate = moment().format("YYYY/MM/DD");

Utilisez la même terminologie pour le même type de variable

Mauvais exemple :

getUserInfo();
getClientData();
getCustomerRecord();

Bon exemple :

getUser();

Utilisez des noms faciles à rechercher

Nous lirons plus de code que nous n'en écrirons. Il est crucial que le code que nous produisons soit lisible et consultable. En ne nommant pas correctement les variables essentielles à la compréhension, nous pénalisons les lecteurs.

Privilégiez des noms permettant une recherche efficace. Des outils comme buddy.js et ESLint peuvent identifier les constantes non nommées.

Mauvais exemple :

// What the heck is 86400000 for?
setTimeout(blastOff, 86400000);

Bon exemple :

// Declare them as capitalized named constants.
const MILLISECONDS_PER_DAY = 60 * 60 * 24 * 1000; //86400000;

setTimeout(blastOff, MILLISECONDS_PER_DAY);

Utilisez des variables explicatives

Mauvais exemple :

const address = "One Infinite Loop, Cupertino 95014";
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
saveCityZipCode(
  address.match(cityZipCodeRegex)[1],
  address.match(cityZipCodeRegex)[2]
);

Bon exemple :

const address = "One Infinite Loop, Cupertino 95014";
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
const [_, city, zipCode] = address.match(cityZipCodeRegex) || [];
saveCityZipCode(city, zipCode);

Évitez le décodage mental

L'explicite prévaut sur l'implicite.

Mauvais exemple :

const locations = ["Austin", "New York", "San Francisco"];
locations.forEach(l => {
  doStuff();
  doSomeOtherStuff();
  // ...
  // ...
  // ...
  // Wait, what is `l` for again?
  dispatch(l);
});

Bon exemple :

const locations = ["Austin", "New York", "San Francisco"];
locations.forEach(location => {
  doStuff();
  doSomeOtherStuff();
  // ...
  // ...
  // ...
  dispatch(location);
});

N'ajoutez pas de contexte redondant

Si votre classe/objet fournit déjà un contexte, ne le répétez pas dans le nom de variable.

Mauvais exemple :

const Car = {
  carMake: "Honda",
  carModel: "Accord",
  carColor: "Blue"
};

function paintCar(car, color) {
  car.carColor = color;
}

Bon exemple :

const Car = {
  make: "Honda",
  model: "Accord",
  color: "Blue"
};

function paintCar(car, color) {
  car.color = color;
}

Privilégiez les paramètres par défaut à l'évaluation de court-circuit ou aux conditions

Les paramètres par défaut sont généralement plus élégants que l'évaluation de court-circuit. À noter qu'ils ne s'appliquent qu'aux arguments undefined. Les autres valeurs dites "falsy" (faussées) comme '', "", false, null, 0 et NaN ne seront pas remplacées.

Mauvais exemple :

function createMicrobrewery(name) {
  const breweryName = name || "Hipster Brew Co.";
  // ...
}

Bon exemple :

function createMicrobrewery(name = "Hipster Brew Co.") {
  // ...
}