-
-
Notifications
You must be signed in to change notification settings - Fork 28
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
Expose all build suggestion APIs in index.ts
#227
Expose all build suggestion APIs in index.ts
#227
Conversation
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.
Cheers @james0888215! Just requires an npm run eslint-fix
(due to alphabetic ordering of singular buildSuggestionFromCucumberExpression
) and a changelog entry under the Added
section.
You might advise whether is possible to meet your particular use case at present through calling buildSuggestions
(which should ideally act as a factory). Just thinking whether possible through existing API or if any present gap or use case to address - including whether any suggested changes for that API? Or otherwise potentially 'could' use existing?
In either case, just thinking separately what would be really valuable (and is missing from this repo) would be to capture a Usage
section in the project README; if an example usage is something you'd like to contribute - similar to gherkin, gherkin-utils, cucumber-expressions, etc.?
Thanks for the feedback @kieran-ryan. Updated imports with es-lint and updated changelog Regarding the use case, for my own case it provides better granular control on how to actually build out the suggestion based on the type of expression I know I am working with. It also just allows users of the service to be able to access these functions without directly referencing in the node_modules. Would be happy to raise a separate PR for use case section around both functions also. |
index.ts
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.
Cheers @james0888215 - good to go! 🚀
🤔 What's changed?
Added buildSuggestionFromCucumberExpression and buildSuggestionsFromRegularExpression to suggestions index in order to expose them directly from the package import.
⚡️ What's your motivation?
Allows access to the buildSuggestionFromCucumberExpression function directly.
🏷️ What kind of change is this?
♻️ Anything particular you want feedback on?
📋 Checklist:
This text was originally generated from a template, then edited by hand. You can modify the template here.