Allow comment inside descriptions #334

jacob-wieland-gematik · 2024-12-09T10:00:23Z

🤔 What's changed?

⚡️ What's your motivation?

Fixes: #333

🏷️ What kind of change is this?

⚡ New feature (non-breaking change which adds new behaviour)

♻️ Anything particular you want feedback on?

📋 Checklist:

I agree to respect and uphold the Cucumber Community Code of Conduct
I've changed the behaviour of the code
- I have added/updated tests to cover my changes.

This text was originally generated from a template, then edited by hand. You can modify the template here.

mpkorstanje · 2024-12-09T13:30:32Z

The parser is generated. To change the parser you'll have to change the grammar.

gherkin/gherkin.berp

Lines 35 to 38 in 00fcc43

    
           // we need to explicitly mention comment, to avoid merging it into the description line's #Other token 
        
           // we also eat the leading empty lines, the tailing lines are not removed by the parser to avoid lookahead, this has to be done by the AST builder 
        
           DescriptionHelper := #Empty* Description? #Comment* 
        
           Description! := #Other+

To regenerate the parsers you can follow these instructions:

https://github.com/cucumber/gherkin/blob/main/CONTRIBUTING.md#generating-parsers

jacob-wieland-gematik · 2024-12-10T14:18:25Z

I have changed the grammar to allow any mixture of empty lines, comments and other-lines as the description.

Extracting only the other-lines from the Description-AST-Node (as before) should yield the description-text without the comments and empty lines.

Only difference is now that a collection of ony empty-lines and comments would yield an empty description text instead of a non-existing Description node.

jacob-wieland-gematik · 2024-12-11T11:16:02Z

Changed the grammar in a way that is more consistent with the former test cases (treating empty lines inside description blocks as '#Other' lines).

kieran-ryan · 2025-01-05T13:38:12Z

@jacob-wieland-gematik, installing berp on the test-codegen workflow and running the tests on the test-dotnet workflow are failing owing to incompatibilities with ubuntu-24.04 which has now been promoted as the ubuntu-latest GitHub runner and is being picked up in the pipeline. I have pinned those workflows to ubuntu-22.04 for now (#348); and you may want to pull in those changes to allow those workflow steps to proceed.

jacob-wieland-gematik · 2025-01-06T12:55:11Z

@kieran-ryan I have rebased on latest main and updated a tokens file. Can you approve the checks again?

jacob-wieland-gematik · 2025-01-07T10:21:37Z

Added dialect.c which was missing for some reason. Please approve checks @kieran-ryan

jacob-wieland-gematik · 2025-01-08T17:56:09Z

I am not able to generate Parser.php locally, so not sure what to do here @kieran-ryan

mpkorstanje · 2025-01-09T09:30:03Z

@jacob-wieland-gematik are you able to generate the php parser using the docker container?

https://github.com/cucumber/gherkin/blob/main/CONTRIBUTING.md#generating-parsers

jacob-wieland-gematik · 2025-01-09T12:31:42Z

@jacob-wieland-gematik are you able to generate the php parser using the docker container?

https://github.com/cucumber/gherkin/blob/main/CONTRIBUTING.md#generating-parsers

No, there seems to be a problem doing that under windows (probably CRLF vs LF related) that hinders this generation.

When change the CRLF of the generated classes.php to LF and then do the generation steps manually, I was able to generate Parser.php

@mpkorstanje

jacob-wieland-gematik · 2025-01-10T20:35:28Z

When will this be merged? @mpkorstanje @kieran-ryan

mpkorstanje · 2025-01-12T16:39:03Z

Always a bit hard to say, depends on availability. Same for releases. 😄

But hopefully bit more regularly now the holidays are over.

mpkorstanje

Looks good overall. I am missing a test with a comment in the middle of a description.

Do you have time to add a scenario to descirptions.feature?

jacob-wieland-gematik · 2025-01-13T10:47:54Z

Looks good overall. I am missing a test with a comment in the middle of a description.

Do you have time to add a scenario to descirptions.feature?

I can try.

jacob-wieland-gematik · 2025-01-13T12:58:11Z

Added tests @mpkorstanje

jacob-wieland-gematik · 2025-01-14T11:00:28Z

Added missing compare files. @mpkorstanje

jacob-wieland-gematik · 2025-01-16T11:02:20Z

Seems all is well now. Any chance we can merge this? @mpkorstanje @kieran-ryan

mpkorstanje

Cheers! Looks good now. Much appreciated.

This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [@cucumber/cucumber](https://redirect.github.com/cucumber/cucumber-js) | [`11.3.0` -> `12.0.0`](https://renovatebot.com/diffs/npm/@cucumber%2fcucumber/11.3.0/12.0.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@cucumber%2fcucumber/12.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@cucumber%2fcucumber/11.3.0/12.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>cucumber/cucumber-js (@cucumber/cucumber)</summary> ### [`v12.0.0`](https://redirect.github.com/cucumber/cucumber-js/blob/HEAD/CHANGELOG.md#1200---2025-07-13) [Compare Source](https://redirect.github.com/cucumber/cucumber-js/compare/v11.3.0...v12.0.0) ##### Added - Allow comments inside descriptions ([cucumber/gherkin#334](https://redirect.github.com/cucumber/gherkin/pull/334)) - Add original `error` to `After` and `AfterStep` hook parameters ([#2572](https://redirect.github.com/cucumber/cucumber-js/pull/2572)) - Add support for Node.js 24.x ([#2588](https://redirect.github.com/cucumber/cucumber-js/pull/2588)) ##### Changed - Redesigned HTML formatter header ([cucumber/react-components#381](https://redirect.github.com/cucumber/react-components/pull/381)) ##### Removed - BREAKING CHANGE: Remove support for Node.js 18.x ([#2588](https://redirect.github.com/cucumber/cucumber-js/pull/2588)) - BREAKING CHANGE: Remove support for Node.js 23.x ([#2588](https://redirect.github.com/cucumber/cucumber-js/pull/2588)) - BREAKING CHANGE: Remove `publishQuiet` option ([#2587](https://redirect.github.com/cucumber/cucumber-js/pull/2587)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/infonl/dimpact-zaakafhandelcomponent).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

mpkorstanje self-requested a review December 10, 2024 18:12

kieran-ryan mentioned this pull request Dec 29, 2024

Comment inside Free Form Description not allowed #333

Closed

jacob-wieland-gematik added 8 commits January 6, 2025 12:21

comments should not change parser state

1815327

Description should be allowed to contain comments and empty lines

9fed6d3

adapt comment

991cc31

regenerate

0a9c25b

extract empty before Description

09d2019

fix RuleType.php

b189f08

fix c/gherkin.berp

58a5880

fix gherkin.berp

2a34df3

jacob-wieland-gematik force-pushed the issue-333 branch from bfbf091 to 2a34df3 Compare January 6, 2025 11:21

change trailing Emtpy line in description to Other

98429c3

add dialect.c

87ba82f

merge

a86f7b3

add re-generated Parser.php

eafe411

mpkorstanje changed the title ~~comments should not change parser state~~ Comments should not change parser state Jan 12, 2025

mpkorstanje changed the title ~~Comments should not change parser state~~ Allow comment inside feature description Jan 12, 2025

mpkorstanje added 2 commits January 12, 2025 17:35

Update CHANGELOG

8918d5b

Merge remote-tracking branch 'origin/main' into issue-333

3dce1e2

mpkorstanje self-assigned this Jan 12, 2025

mpkorstanje requested changes Jan 12, 2025

View reviewed changes

mpkorstanje changed the title ~~Allow comment inside feature description~~ Allow comment inside descriptions Jan 12, 2025

Update CHANGELOG

acef0a5

jacob-wieland-gematik added 2 commits January 13, 2025 13:55

add tests for descriptions with comments

815003f

Merge remote-tracking branch 'origin/issue-333' into issue-333

9ae0593

jacob-wieland-gematik requested a review from mpkorstanje January 13, 2025 12:58

add compare files

30e150b

mpkorstanje approved these changes Jan 23, 2025

View reviewed changes

mpkorstanje merged commit 93339df into cucumber:main Jan 23, 2025
34 checks passed

jsa34 mentioned this pull request Feb 16, 2025

[Python] Regression: Descriptions consisting of just a comment in a Scenario or Scenario Outline block throws error #373

Closed

gasparnagy mentioned this pull request Mar 7, 2025

Python: Handle empty lines in Description AST node and add test cases when there is only a comment between the scenario line and the first step #378

Merged

5 tasks

mpkorstanje mentioned this pull request May 23, 2025

gherkin: Having a Comment before a description breaks parsing #16

Closed

Uh oh!

Allow comment inside descriptions #334

Allow comment inside descriptions #334

Uh oh!

Conversation

jacob-wieland-gematik commented Dec 9, 2024 • edited by mpkorstanje Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤔 What's changed?

⚡️ What's your motivation?

🏷️ What kind of change is this?

♻️ Anything particular you want feedback on?

📋 Checklist:

Uh oh!

mpkorstanje commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jacob-wieland-gematik commented Dec 10, 2024

Uh oh!

jacob-wieland-gematik commented Dec 11, 2024

Uh oh!

kieran-ryan commented Jan 5, 2025

Uh oh!

jacob-wieland-gematik commented Jan 6, 2025

Uh oh!

jacob-wieland-gematik commented Jan 7, 2025

Uh oh!

jacob-wieland-gematik commented Jan 8, 2025

Uh oh!

mpkorstanje commented Jan 9, 2025

Uh oh!

jacob-wieland-gematik commented Jan 9, 2025

Uh oh!

jacob-wieland-gematik commented Jan 10, 2025

Uh oh!

mpkorstanje commented Jan 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mpkorstanje left a comment

Choose a reason for hiding this comment

Uh oh!

jacob-wieland-gematik commented Jan 13, 2025

Uh oh!

jacob-wieland-gematik commented Jan 13, 2025

Uh oh!

jacob-wieland-gematik commented Jan 14, 2025

Uh oh!

jacob-wieland-gematik commented Jan 16, 2025

Uh oh!

mpkorstanje left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jacob-wieland-gematik commented Dec 9, 2024 •

edited by mpkorstanje

Loading

mpkorstanje commented Dec 9, 2024 •

edited

Loading

mpkorstanje commented Jan 12, 2025 •

edited

Loading