rmpestano / cukedoctor

BDD living documentation using Cucumber and Asciidoctor: https://goo.gl/Yp3NiU
https://rmpestano.github.io/cukedoctor/
Apache License 2.0
122 stars 23 forks source link

Project Deprecation Discussion #306

Open sashokbg opened 1 year ago

sashokbg commented 1 year ago

Hello,

I have worked a little bit on the past on this project to add some feature.

While working I noticed that the cukedoctor project duplicates the Gherkin model internally and that it does not use the "messages" protocol that is recommended by the cucumber team. In fact the "json" output is deprecated. I also noticed that not all gherkin features are available and that when the gherkin language evolves the cukedoctor project will not be updated automatically.

These problems let me to develop a new feature in the original cucumber repository called "flavors" which will allow for support for Asciidoc through the development of a "flavor plugin". This feature was inspired by the already existing support for markdown: https://github.com/cucumber/gherkin/blob/main/MARKDOWN_WITH_GHERKIN.md

These are currently only in form of PR:

I also created an example project that illustrates how things will look if these are merged.

Also there is already a very well designed react components project that reads cucumber messages and generates reports: https://github.com/cucumber/react-components

All of these thing lead me to humbly propose to declare the current project as deprecated and focus on integrating asciidoc support as a plugin to the original cucumber project.

I am eager to hear your thoughts and proposals. I would also be happy to connect with you on discord if you like.

Best regards Alexander