Guide de style

De Traduction du Wiki diaspora* (non officiel)
Aller à la navigation Aller à la recherche

Veuillez adhérer aux guide de style suivant pour vos contributions. Transformez le code existant que vous traitez pour qu'il les suive.

Ruby

Nous suivons Guide de style de bbatsov pour Ruby, avec les modifications et choix suivants :

  • La longueur maximale de la ligne est de 120 caractères.
  • Toujours utiliser raise, jamais utiliser fail. Utiliser abort pour sortir sur une condition d'erreur fatale.
  • Pas d'affectation dans les conditions, pas même les soi-disant (safe = affectation).
  • Pas de noms de variables imposés pour inject, utilisez des noms qui décrivent correctement les données.
  • N'utilisez pas Class.new pour définir les exceptions, utilisez le mot clé class ordinaire.
  • Ne pas ajouter d'espaces dans l'interpolation des chaînes de caractèresn, "a #{b} c" est valide, "a #{ b } c" ne l'est pas.
  • Ne pas faire de contrôle de flux avec && et || en dehors des conditions. Les seuls usages valides de && et de || sont dans une condition et pour calculer un prédicat qui est retourné par une méthode.
  • N'ajoutez pas d'espaces de chaque côtés d'un signe = quand il est utilisé pour définir les arguments par défault dans les définitions de méthode. def foo(a, b=c) est valide, def foo(a, b = c) ne l'est pas.
  • Utilisation par défaut des doubles quotes ("), n'utilisez que des simples quotes (') lorsque vous souhaitez utiliser une double quote dans votre chaîne. Utilisez un pourcentage littéral si vous voulez utiliser les deux dans la chaîne.
  • Utilisez le pourcentage %i pour définir un tableau de symboles.
  • Préférez Hash#has_key? et Hash#has_value? à Hash#key? et Hash#value?.
  • Préférez String#% à Kernel#sprintf.
  • Préférez inject à reduce.
  • Ne mettez pas d'espace entre l'accolade ouvrante et un argument de bloc. foo {|a| } est valide, foo { |a| } ne l'est pas.
  • Ne mettez pas d'espace après l'accolade ouvrante ou avant l'accolade fermante d'un littéral de hachage. {foo: bar} est valide, { foo: bar } ne l'est pas.
  • Utilisez la règle de Weirichs pour décider de la syntaxe de bloc à utiliser.
  • Utilisez un nom approprié pour l'argument lorsque vous définissez une méthode d'opérateur, ne vous contentez pas de la valeur par défaut autre.

JavaScript

Nous utilisons ESLint avec notre propre config. Certaines des règles les plus importantes sont :

  • Tous les noms de variables doivent utiliser le style camelCase ou UPPER_CASE avec des underscores.
  • Toujours mettre des accolades autour des blocs dans les boucles et les conditionnels.
  • Utiliser === et !== au lieu de == et !=.
  • Utilisez deux espaces par niveau d'indentation.
  • La longueur maximale de la ligne est de 120 caractères.
  • Utilisez les double quotes (")

SCSS

Nous utilisons scss-lint avec la configuration par défaut. Le repo de scss-lint contient des informations détaillées sur les différents linters.

Révision automatique locale

Vous pouvez contrôler rapidement les violations introduites dans votre branche de fonctionnalité.

Veuillez le faire avant d'ouvrir une demande de pull !

Pour les modifications committées et non committées : $ bin/pronto run --unstaged -c upstream/develop.

N'oubliez pas de mettre d'abord à jour la branche development avec git fetch upstream develop.

Effectuez une révision locale automatique avant de faire un push vers votre dépôt.

Si vous avez tendance à oublier d'effectuer la révision locale automatique avant de faire un push vers votre repo, vous pouvez faire en sorte que Git l'effectue pour vous avant d'effectuer une action. Cet outil s'appelle un Git hook. Par exemple, vous pouvez faire en sorte que Git exécute Pronto avant tout push vers votre dépôt et qu'il échoue si Pronto soulève un quelconque avertissement.

Pour ce faire, allez dans le répertoire .git/hooks de votre repo local, renommez le fichier pre-push.sample en pre-push et remplacez le contenu par :

  #!/bin/sh
  bin/pronto run --exit-code -c develop

Maintenant, git lancera Pronto chaque fois que vous voudrez faure un push vers votre dépôt Github de diaspora et vous empêchera de le faire si Pronto soulève des avertissements. Si vous voulez ignorer le hook Git, il suffit d'ajouter --no-verify à la commande git.