<commit_before>= Cukedoctor

:toc: preamble

[quote]
____
So you can bring your documentation back to life!
____


image:https://travis-ci.org/rmpestano/cukedoctor.svg[Build Status (Travis CI), link=https://travis-ci.org/rmpestano/cukedoctor]
image:https://coveralls.io/repos/rmpestano/cukedoctor/badge.svg?branch=master&service=github[Coverage, link=https://coveralls.io/r/rmpestano/cukedoctor]
image:https://maven-badges.herokuapp.com/maven-central/com.github.cukedoctor/cukedoctor/badge.svg["Maven Central",link="https://maven-badges.herokuapp.com/maven-central/com.github.cukedoctor/cukedoctor"]
image:https://www.versioneye.com/user/projects/55d3328a265ff6002200029f/badge.svg?style=flat[Dependency Status, link=https://www.versioneye.com/user/projects/55d3328a265ff6002200029f/]

BDD living documentation using http://cukes.info/[Cucumber] and http://asciidoctor.org[Asciidoctor] based on Cucumber http://www.relishapp.com/cucumber/cucumber/docs/formatters/json-output-formatter[JSON execution output].

== Narrative

[quote]
____
As a developer +
I want to generate documentation based on my tests execution +
In order to have better collaboration and understanding between my software and its users.
____

== Story

****
[big]#*GIVEN*# I execute my cucumber tests using the json formatter

[BIG]#*AND*# cucumber json output files are generated

[big]#*WHEN*# I run Cukedoctor against those files

[big]#*THEN*# I should have awesome _living_ documentation generated by Asciidoctor
****

== Sample

The following cucumber feature:

----
@a<commit_msg>updated maven central badget link<commit_after>= Cukedoctor

:toc: preamble

[quote]
____
So you can bring your documentation back to life!
____


image:https://travis-ci.org/rmpestano/cukedoctor.svg[Build Status (Travis CI), link=https://travis-ci.org/rmpestano/cukedoctor]
image:https://coveralls.io/repos/rmpestano/cukedoctor/badge.svg?branch=master&service=github[Coverage, link=https://coveralls.io/r/rmpestano/cukedoctor]
image:https://maven-badges.herokuapp.com/maven-central/com.github.cukedoctor/cukedoctor/badge.svg["Maven Central",link="http://search.maven.org/#search|ga|1|cukedoctor"]
image:https://www.versioneye.com/user/projects/55d3328a265ff6002200029f/badge.svg?style=flat[Dependency Status, link=https://www.versioneye.com/user/projects/55d3328a265ff6002200029f/]

BDD living documentation using http://cukes.info/[Cucumber] and http://asciidoctor.org[Asciidoctor] based on Cucumber http://www.relishapp.com/cucumber/cucumber/docs/formatters/json-output-formatter[JSON execution output].

== Narrative

[quote]
____
As a developer +
I want to generate documentation based on my tests execution +
In order to have better collaboration and understanding between my software and its users.
____

== Story

****
[big]#*GIVEN*# I execute my cucumber tests using the json formatter

[BIG]#*AND*# cucumber json output files are generated

[big]#*WHEN*# I run Cukedoctor against those files

[big]#*THEN*# I should have awesome _living_ documentation generated by Asciidoctor
****

== Sample

The following cucumber feature:

----
@a
{'fraction_non_alphanumeric': 0.12443584784010316, 'fraction_numerical': 0.024822695035460994, 'mean_word_length': 5.849889624724062, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 15, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '284508', 'n_tokens_mistral': 1135, 'n_tokens_neox': 1056, 'n_words': 221}