Various fixes for OCaml cucumber #41
Conversation
|
Looks good to me. Though my knowledge about OCaml is limited to nodding along with @cyocum enthusiastic explanations. I'm merging this to keep some momentum going. More improvements, if any, can always be made later.
Unfortunately there are very few Windows Users in the Cucumber organisation. I don't think we can test this on Windows. But given that currently there are only a few people interested in Cucumber with OCaml I also think that is fine for now.
I think that would prudent. It would also allow Windows to be covered. Once I merge this a bot will come by and give you commiter permissions. At this point you can work directly in this repo. If you want to setup CI please feel free to do so. The ci option does look nice but needs a core team member to set it up. So that's less than ideal. |
|
Hi @tmcgilchrist, 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, |
CHANGES: * before updating we need to init the submodule (cucumber/cucumber.ml#37). * Add GitHub Actions CI (@tmcgilchrist cucumber/cucumber.ml#42 cucumber/cucumber.ml#44). * Various fixes for OCaml cucumber (@tmcgilchrist cucumber/cucumber.ml#41). * Improve odoc documentation and add an example. * Update base to v0.15.1 updating OCaml lower bound to 4.10.0. * Update README with a working example. * Fixup linking against libgherkin. * Adapt to the interface changes when updating to gherkin-c v23. * Move git submodule to https://github.com/cucumber/gherkin monorepo. * Fixup cmdliner deprecations and update dune. * Updated README to read a bit better. * Updated Readme to reflect the new build steps. * Removed unnecessary submodule. * Updated dune project information to get things ready for release. * Updated dune files to use autogenerated opam. * Updated test make file to work with new dune build stucture. * Updated files to work with Dune's foreign lib interface. * Added gherkin-c READ ONLY as a submodule. * Updated based on rebase from master. * Added dialect example in the README. * Moved initialization of result code. * Added whitespace for readability. * Added the Dialect module to allow compile time checking of supported dialects of Cucumber * Created a means for indicating feature file dialect. * Removed unneeded flag in dune. * Removed unneeded flag in dune * Added freeing before caml_failwith just to ensure that everything is cleaned up before going back to OCaml runtime. * Refactored long code block into function in gherkin_intf.c. * Refactored long code block into function in gherkin_intf.c * Fixed small memory leak due to TokenScanner not being deleted after it is done being used * Added const qualifier to sFileName to fix cucumber/cucumber.ml#31.
🤔 What's changed?
I have fixed the following issues:
I am looking at changing the bindings to use the
ctypeslibrary to cut down on the size of the c stubs.⚡️ What's your motivation?
This should allow the project to build against the most recent version of gherkin-c and ideally be released to opam.
♻️ Anything particular you want feedback on?
Please test this on Windows if that is an important platform to support. I haven't myself as I don't have access to a Windows machine. Note I have tested it with
ocaml-ciagainst a number of Linux and macOS platforms https://github.com/tmcgilchrist/cucumber.ml/runs/9697631507Currently there is no test setup on this repo, would you be interested in either trying out ocam-ci (docs here https://ci.ocamllabs.io/getting-started) or setting up GH Actions to test this project.
📋 Checklist: