feat: add Go to Definition and Hover support for Gherkin steps

[PcGnCLwnCm9EgY56mAmL]

• Add DefinitionProvider for navigating from Gherkin steps to Robot Framework keywords
• Add HoverProvider for displaying keyword information on hover
• Support for parsing .resource files in steps directories
• Intelligent keyword matching with variable normalization
• Extension metadata updates for enhanced Gherkin support

[PcGnCLwnCm9EgY56mAmL]

I know chances are low for pull requests to be merged. But I had to try to contribute a small quality of life change for those of us who still use this everyday.

Thank you @d-biehl for all your hard work.

I hope someday this extension gets merged into robotcode.

[ReneFromHolland]

Thanks. It would be great if it works.

Where can I find /get this file "robotcode-gherkin-extended-0.4.0.vsix"?

[PcGnCLwnCm9EgY56mAmL]

Hi Rene,

https://github.com/PcGnCLwnCm9EgY56mAmL/robotframework-gherkin-parser/releases/tag/v0.4.0

I have the release there. I'll try and check if I might get an microsoft publisher account to publish it. (and maybe see if we can integrate the other fixes from other forks also.)

you can just drag it into vscode, to install it.
(we disabled the official addon, and enabled this one, so they don't mess with eachother)

let me know if you run into any issues!

p.s. cool username, I'm from Holland also

edit: - we work on macs so, I must admit I have not tested it on windows.

[ReneFromHolland]

I don't see a separate option to add issues regarding to this pull request here, so I will add my remarks here:

1. I use your fix on my Windows home computer and at my work on a shared Windows server. In general it works and I am happy with it.

2. I notice that when I use Scenario Outline and a step definition has a parameter at the end with (double) quotes. The hover doesn't recognize it. (For Robot Framework / Robot Code it works fine.) Example:
   Given a parameter is at the "<position>"
   Examples:
   | position |
   | end |

   *** Keywords ***
   a parameter is at the "${position}"
   Log ${position}

3. In my Robot Framework project I have the structure to test multiple modules. The directory structure under these modules is more or less the same. Including some keywords with the same name (but with module specific actions) . No problem for Robot Framework or Robotcode. But the hover shows then 2 options. Example:
   RFproject -- module1 -- keyword_file_1 --> keyword1
   |
   | -- module2 -- keyword_file_1 --> keyword1

5. I miss the prediction of step definitions, like we are used to with keywords.

6. Sometimes the hover says it is loading, on the Windows server at work. I quess it is a combination of the Windows server and Robotcode acting slow. At home there is no problem.

I hope my remarks can improve your solution.

[PcGnCLwnCm9EgY56mAmL]

Hi Rene,

Thanks for the feedback! Short reply for now, currently I'm chilling on Texel, will check it out when I get back and see how I can improve it. Sorry for the delay!

[PcGnCLwnCm9EgY56mAmL]

Hi Rene,

Took me some time, to get back to you.
For adressing your points:

I don't see a separate option to add issues regarding to this pull request here, so I will add my remarks here:

1. I use your fix on my Windows home computer and at my work on a shared Windows server. In general it works and I am happy with it.

Thanks!

2. I notice that when I use Scenario Outline and a step definition has a parameter at the end with (double) quotes. The hover doesn't recognize it. (For Robot Framework / Robot Code it works fine.) Example:
   Given a parameter is at the ""
   Examples:
   | position |
   | end |
   *** Keywords ***
   a parameter is at the "${position}"
   Log ${position}

Good catch, we don't use the double quotes for our variables in the keywords. So I will adjust the regex to compensate for that.

3. In my Robot Framework project I have the structure to test multiple modules. The directory structure under these modules is more or less the same. Including some keywords with the same name (but with module specific actions) . No problem for Robot Framework or Robotcode. But the hover shows then 2 options. Example:
   RFproject -- module1 -- keyword_file_1 --> keyword1
   |
   | -- module2 -- keyword_file_1 --> keyword1

Hmm would it work for you if I limit the search for corresponding keywords only in the current module/steps folder?

5. I miss the prediction of step definitions, like we are used to with keywords.

This PR, is for goto definition function. If I have time, I'll try to make a new PR for that!

6. Sometimes the hover says it is loading, on the Windows server at work. I quess it is a combination of the Windows server and Robotcode acting slow. At home there is no problem.

This one will be hard for me to debug, but maybe with the new improvements, this will work better on the windows server at work.

I hope my remarks can improve your solution.

Thanks for the feedback, really appreciated!

[ReneFromHolland]

Thanks for your reaction. I have only a remark about point 3. The short answer is limiting the search won't help. Actually it will miss keywords. I will try to explain a bit more the style of my project.

I created one big project. With a seperation into about 20 modules. See as 20 folders within the project with more or less the same folder and file structure. Next to this modules there is a general folder with underlaying folder structure and files. If there is something that can be used in multiple modules. I have it in the general folder. Searching in the current folder will miss the general keywords.
(Maybe in the future I will put the general folders and files in a seperate project.)

3. In my Robot Framework project I have the structure to test multiple modules. The directory structure under these modules is more or less the same. Including some keywords with the same name (but with module specific actions) . No problem for Robot Framework or Robotcode. But the hover shows then 2 options. Example:
   
    RFproject -- general -- keyword_file_a --> keyword_a
                  |
                  |-- module1 -- keyword_file_1 --> keyword_1
                  |
                  | -- module2 -- keyword_file_1 --> keyword_1