Gherkin Generator

Gherkin est un standard puissant pour le BDD (Behavior-Driven Development). Les fichiers .feature décrivent le comportement attendu en langage naturel : Given, When, Then. Lisibles par tous — product owners, QA, développeurs.

Mais écrire ces specs à la main devient vite pénible :

Et si on pouvait tout faire programmatiquement ?

Gherkin Generator est une bibliothèque Swift complète pour le cycle de vie des fichiers .feature. Au lieu d'écrire du Gherkin à la main, vous le construisez en code — avec validation, autocomplétion, et toute la puissance de Swift.

Résultat : un objet Feature immutable, validé, prêt à être exporté en .feature, JSON ou Markdown.

Ce n'est plus juste un générateur. C'est un toolkit complet : builder, parser, validateur, formateur, exporteur, importeur, streaming, batch processing, et CLI.

L'API est conçue pour refléter la structure naturelle de Gherkin. Chaque méthode retourne une nouvelle copie — tout est immutable et Sendable.

Chaînez les steps And et But après n'importe quel step primaire :

Définissez des préconditions communes exécutées avant chaque scénario. Le closure reçoit un BackgroundBuilder :

Utilisez addOutline pour les scénarios paramétrés. Les placeholders entre chevrons (<email>) sont substitués depuis la table d'exemples :

Les blocs d'exemples nommés et taggés sont aussi supportés via .examples(_:name:tags:).

Attachez une table de données à n'importe quel step. La première ligne est le header :

Attachez du texte multi-ligne avec un type de média optionnel :

Appliquez des tags au niveau feature avec .tags() et au niveau scénario avec .scenarioTags(). Les tags servent au filtrage, à la catégorisation et au ciblage des hooks :

Groupez des scénarios sous des règles métier nommées pour structurer les features complexes :

Le vrai pouvoir : générer des centaines de scénarios programmatiquement. L'API immutable s'utilise avec var et réassignation :

Pour une approche mutating, utilisez appendScenario(_:) ou appendOutline(_:).

Avant l'export, validez vos features contre 5 règles built-in. Le validateur remonte toutes les erreurs trouvées, pas seulement la première :

Conformez-vous au protocole ValidationRule pour ajouter vos propres vérifications. Les règles sont composables :

BatchValidator est un actor qui parse et valide tous les fichiers .feature d'un répertoire en parallèle :

streamValidation(at:) fournit un AsyncStream pour le reporting progressif.

GherkinParser utilise un recursive descent parser. Il détecte automatiquement la langue depuis un header # language: ou se rabat sur l'anglais :

Parse aussi directement depuis une chaîne Gherkin :

Mappez les colonnes CSV vers les types de steps Gherkin via CSVImportConfiguration. Chaque ligne devient un scénario :

Délimiteur personnalisé et colonne de tags optionnelle supportés.

JSONFeatureParser décode le JSON produit par GherkinExporter, garantissant un aller-retour parfait — exporter en JSON puis réimporter produit un Feature identique :

Parsez du texte informel en scénarios. Les lignes commençant par Given/When/Then deviennent des steps, --- sépare les scénarios :

Tous les préfixes et le séparateur sont configurables via PlainTextImportConfiguration.

ExcelParser lit les fichiers .xlsx nativement grâce à un lecteur ZIP/OOXML intégré — aucune dépendance tierce. Cross-platform : macOS, iOS, Linux via la librairie système zlib.

Le paramètre tagColumn mappe une colonne vers des tags par scénario (séparés par espaces ou virgules). Le paramètre sheetIndex sélectionne le worksheet à lire.

BatchImporter est un actor qui scanne un répertoire de fichiers .feature et les parse en parallèle :

streamDirectory(at:) fournit un AsyncStream pour le traitement progressif.

GherkinExporter écrit une feature au format de votre choix — .feature, JSON ou Markdown :

Render en mémoire sans écrire sur disque :

GherkinFormatter convertit un Feature en Gherkin proprement indenté avec des tables alignées. Trois presets disponibles :

Pour les gros volumes, la lib fournit des actors dédiés avec des patterns AsyncStream.

StreamingExporter est un actor qui écrit les features ligne par ligne, sans charger tout en mémoire. Adapté aux features avec des centaines de scénarios :

Obtenez un AsyncStream<String> de lignes formatées pour un traitement custom :

Suivez la progression de l'export :

BatchExporter est un actor qui exporte plusieurs features vers des fichiers individuels dans un répertoire cible. Les fichiers sont écrits en parallèle via TaskGroup. Les titres sont automatiquement slugifiés en noms de fichiers, et les doublons reçoivent des suffixes numériques (login.feature, login-1.feature, login-2.feature) :

Suivez la progression avec exportAllWithProgress :

Gherkin supporte plus de 70 langues. Gherkin Generator aussi — avec les keywords officiels du gherkin-languages.json de Cucumber.

15 langues courantes ont des raccourcis statiques : .english, .french, .german, .spanish, .italian, .portuguese, .japanese, .chinese, .russian, .arabic, .korean, .dutch, .polish, .turkish, .swedish.

Accédez à n'importe quelle langue par code ISO ou listez toutes les langues disponibles :

Le parser détecte automatiquement les directives # language: et le formateur produit la sortie avec les bons mots-clés localisés.

gherkin-gen est un outil en ligne de commande avec 7 sous-commandes pour composer, valider et convertir des fichiers .feature directement depuis le terminal.

Les options --given, --when, --then, et --tag sont répétables. --language pour les features non-anglaises (défaut : en).

--strict active toutes les règles par défaut. --quiet supprime les messages de succès.

Colonnes personnalisables avec --scenario-column, --given-column, --when-column, --then-column, --tag-column. Délimiteur CSV avec --delimiter.

Les fichiers .feature générés sont compatibles avec tous les outils Gherkin :

Gherkin Generator fait partie d'un ensemble d'outils complémentaires pour un workflow BDD complet en Swift :

Deux outils complémentaires : l'un génère les specs, l'autre les exécute.