Xavier Nayrac

Rubyiste accro au TDD, serial blogger, apprenti data scientist, heureux utilisateur de Vim, accordéoniste.
Si vous vous sentez particulièrement généreux, suivez moi sur Twitter.

Trois-centième article aujourd'hui !

| Comments

Niveau : intermédiaire

Aujourd’hui c’est le 300ème article de ce blog ! Voilà 300 jours que je pond un article au quotidien. J’en reviens pas !

Encore 65 et j’aurais réussi le défi que je m’étais fixé il y a 300 jours: écrire un article par jour pendant un an.

Bref, le contenu du jour sera : le fichier .yardopts. Qu’est-ce que c’est encore que ça ?

Pour générer une documentation de vos gems Ruby avec Yard vous écrivez peut-être comme moi une tâche Rake dans ce genre:

1
2
3
4
desc 'Create documentation'
task :doc do
  exec 'yardoc --title "Titre de la doc"'
end

Là j’ai mis une seule option, mais on en a souvent d’autres, plus des fichiers à inclure (comme la licence, le changelog, etc).

Et bien j’ai appris aujourd’hui que ces options pouvaient être mises dans un fichier .yardopts. En reprenant l’exemple précédant, cela deviendrait:

.yardopts
1
--title "Titre de la doc"
1
2
3
4
desc 'Create documentation'
task :doc do
  exec 'yardoc'
end

Non seulement ça évite de surcharger la tâche rake avec des informations inutiles, mais surtout, ça permet à des service externes comme RubyDoc de savoir exactement ce que vous voulez.

À demain.

Articles connexes

Commentaires