-
-
Notifications
You must be signed in to change notification settings - Fork 689
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
gherkin/python: Support gherkin markdown #2103
gherkin/python: Support gherkin markdown #2103
Conversation
…d as the base image.
As an aside, it's great to see how clean the codebase is. Very accessible for new contributors. I was able to port the markdown implementation with no prior experience of the codebase based purely on the Typescript implementation and tests. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like the acceptance tests were not updated to include Markdown. For example see:
common/gherkin/javascript/Makefile
Lines 3 to 4 in dd87c6d
GOOD_FEATURE_FILES = $(shell find ../testdata/good -name "*.feature" -o -name "*.feature.md") | |
BAD_FEATURE_FILES = $(shell find ../testdata/bad -name "*.feature" -o -name "*.feature.md") |
@temyers I'm currently working on extracting Gherkin from the mono repo into its own repo. This means that this MR will soon be aimed at the wrong repository. Unfortunately this migration is fairly complex and I'm not in a position where I can to wait for you to finish this MR (I won't have sufficient time available). So I reckon the best course of action would be to clone temyers/common and then use The migration notes might be helpful for some more details cucumber/gherkin#2 |
@mpkorstanje - Updates made as per comments. I've updated the acceptance tests to include the features. Can this make the cut? I note you said 'soon' ;) Otherwise I'll create a new PR |
Hi @temyers, Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾 In return for this generous offer we hope you will:
On behalf of the Cucumber core team, |
Cheers, looks good enough. I reckon any problems can be fixed in future iterations. |
Summary
Ports the Javascript implementation of Gherkin Markdown support to Python.
Details
This implementation ports the specifications and implementation from the Javascript for a (hopefully) like-for-like implementation.
Motivation and Context
Markdown provides a much richer living documentation format over classic Gherkin syntax
Relates to: 1979
How Has This Been Tested?
Unit tests have been ported from the Javascript version.
Additional unit tests have been added for improved coverage.
A few additional changes have been made without unit test coverage in order to ensure parity with the Javascript version.
I presume these are covered under acceptance tests?
Tested using
pytest
unit tests only at this stage.Testing Environment: python-3.10 container.
Screenshots (if appropriate):
Types of changes
Checklist: