Open source
Testdocs
Extrait les blocs de code TypeScript du Markdown et les exécute comme des tests, gardant les exemples synchronisés avec le code.
capturetestdocs.dev
Testdocsexemples de documentation exécutables
Ce que c'est
Un harnais de test pour la documentation. Il extrait les blocs de code TypeScript des fichiers Markdown et les exécute comme de vrais tests sous Vitest ou Jest : les exemples d'un README font partie de la suite de tests, sans duplication entre les deux.
Pourquoi il existe
Les exemples de documentation pourrissent en silence. Une API change, les tests sont mis à jour, et le README continue de montrer l'ancienne signature jusqu'à ce que quelqu'un la copie et ouvre un bug. Exécuter les exemples est la seule façon de savoir qu'ils fonctionnent encore.
Notre part
Nous le maintenons, et il tourne contre notre propre documentation — c'est ainsi que les exemples des autres pages de projets restent honnêtes.
Ce sur quoi nous le construisons
Des sites statiques et rendus côté serveur qui tournent près de l'utilisateur, et peu coûteux à maintenir.
Des tests unitaires rapides, du HTTP enregistré, et une documentation qui fait échouer le build quand elle se périme.
Une seule chaîne d'outils pour tous les dépôts : passer de l'un à l'autre ne coûte rien.
Nous contacter
Dites-nous ce que vous voulez faire construire.
Nous sommes une petite équipe au Portugal, aux horaires de Londres. Un site, une application, un outil interne, ou la plateforme derrière — commencez par une phrase sur le problème et nous prenons la suite.