🧯 Bibadac is Born

TL;DR Bibadac est un outil en ligne de commande permettant de gérer une bibliographie écrite avec BibTeX. Il est conçu pour répondre à des besoins simples et récurrents comme : formater une bibliographie et vérifier la cohérence des entrées. Son nom est tiré du verbe polonais biadać qui signifie se plaindre, gémir, se lamenter, en ajoutant un b pour Bib TeX:

Bibadać (verbe): faire pleurer des fichiers BibTeX.

Quel type de chercheur / chercheuse êtes-vous ?

Écrire des articles nécessite de citer des articles. En pratique pour les informaticien·e·s et les mathématicien·ne·s, cela signifie interagir beaucoup avec le format de bibliographies BibTeX. Ce “format” est très flexible, et en conséquence, il est très facile de faire des erreurs. Cet outil peut vous être utile si vous avez déjà :

1. Modifié des entrées BibTeX à la main pour retirer des champs.
2. Pleuré devant des entrées BibTeX illisible parce que mal formatées.
3. Eu des problèmes de cohérence entre les entrées de votre fichier BibTeX.
4. Cité des articles en utilisant des liens morts.
5. Ajouté des champs dans fichier écrit par un·e collègue.
6. Eu des erreurs de compilation de votre fichier LaTeX à cause de votre fichier BibTeX.

Bibadac

Bibadać est un outil en ligne de commande écrit en Rust pour gérer des fichiers BibTeX. Il est conçu pour être simple et rapide. Pour lister les potentielles erreurs dans un fichier bibadac check mon-fichier.bib. Pour formater un fichier bibadac format mon-fichier.bib. Pour télécharger les dernières versions des entrées bibliographiques ainsi que tous les PDFs associés bibadac setup mon-fichier.bib.¹

Encore un nouvel outil ? Il existe déjà de nombreux outils pour gérer des fichiers BibTeX. Cependant, ces outils sont souvent pénibles. Ils utilisent des interpréteurs (Python, Node.js) et sont donc relativement lourds à déployer, alors que Bibadać est un binaire d’à peine 2 Mo.² De plus, ils sont souvent assez stricts sur le format de fichier : des erreurs de syntaxes mineures peuvent les faire planter. Là où Bibadać se démarque, c’est qu’il utilise Tree Sitter pour analyser le fichier d’entrée : cela permet de faire des diagnostics pertinents même sur des fichiers invalides, et de formater des fichiers invalides sur le principe du meilleur effort. De plus, son fonctionnement sans état le rend particulièrement adapté à des pipelines de compilation ou d’intégration continue.

Fonctionnalités. La principale fonction de Bibadać est de vérifier la cohérence des entrées d’un fichier BibTeX. Cela signifie vérifier l’absence de doublons, de champs vides, d’URLs qui ne sont pas accessibles, de versions périmées d’un document, etc. En plus de cela, Bibadać propose de formater un fichier BibTeX pour le rendre plus lisible, avec la possibilité d’enrichir les entrées avec des informations provenant d’un autre fichier BibTeX. Enfin, Bibadać propose de télécharger des versions “standardisées” des citations issues du fichier d’entrée ainsi que (presque) tous les PDFs associés.

Usage typique. Vous commencez à collaborer sur un projet, vous téléchargez le fichier BibTeX de votre collègue. Vous lancez bibadac setup pour obtenir tous les documents nécessaires ainsi qu’une base de référence bibliographique à jour. Vous pouvez ensuite vous servir de cette base pour vérifier votre fichier BibTeX, et le formater, l’enrichir au besoin, ou en supprimer certains champs inutiles. Avant de publier votre article, vous pouvez lancer une dernière fois bibadac check pour vérifier que tout est en ordre.

Technologies, Développement, Déploiement

Comme déjà mentionné, Bibadać est écrit en Rust. Le langage possède une excellente communauté, beaucoup de bibliothèques et une toolchain fabuleuse. Le cœur de Bibadać est basé sur Tree-sitter, un parser générique qui permet de faire des analyses syntaxiques de fichiers de manière efficace et itérative.³ Le seul et unique problème avec ce langage est son utilisation des durées de vie nommées qui s’écrivent avec la syntaxe <'a>, or :

1. J’écris avec un clavier BÉPO et je n’ai pas envie de changer de disposition pour écrire du code.
2. J’utilise un MacPro d’occasion sans y avoir installé Linux, et le driver bépo ne permet pas facilement de taper le caractère ', qui est systématiquement remplacé par un caractère ’.

Afin de faire une petite démonstration en ligne de Bibadać, j’ai écrit une interface web minimaliste, et c’est à ce moment là que j’ai rencontré le premier bémol : j’espérais pouvoir compiler Bibadać vers du WebAssembly pour avoir un démonstrateur sur une page statique, mais cela n’est pas possible à cause de la dépendance à Tree-sitter et des incompatibilités d’ABI WebAssembly. J’ai donc dû construire une petite API en ligne. Pour sa mise en route j’ai utilisé le service shuttle.rs, destiné à déployer des applications Rust en ligne de manière simple, rapide, et sans configuration.⁴ C’est particulièrement simple à utiliser (une seule commande), et le déploiement de l’application est fait en une dizaine de minutes lors du premier build.

Conclusion

Un jour, peut-être, Bibadać sera un outil incontournable. En attendant, testez le en ligne sur 🧯 Bibadać — Web Demo. Si vous êtes plutôt CURLieux, vous pouvez directement utiliser l’API:

curl -X POST \
     -H "Content-Type: plain/text" \
     -d @mon-fichier.bib \
     https://bibadac-web-woht.shuttle.app/api/check