[Feature]: Add ability to customize generated snippets

[Noreaster76]

The Problem

There doesn't seem to be any way to customize the generated steps, but people may want to add a default behavior, such as throwing an error, so that generated steps do not pass quietly.

Proposed Solution

Given I am using bddgen
And I have a missing step definition
And I have customized my bddgen setup to include my own code in generated steps
When I run npx bddgen
Then I should see the default bddgen generated step skeletons
And I should see my own code added in as well

$ npx bddgen
Missing step definitions: 1

Given('I am logged out', async ({}) => {
  // Step: Given I am logged out
  // From: features/sign_out.feature:13:5
  throw new Error("not yet implemented!");
});

Use snippets above to create missing steps.

Naturally, people might want different variations of this:

• suppress the default generated step skeleton contents altogether
• include the default, and...
  • add <MY_CODE> before step skeleton
  • add <MY_CODE> within step skeleton, but before the default generated comments
  • add <MY_CODE> within step skeleton, but after the default generated comments
  • add <MY_CODE> after step skeleton

Additional Context

No response

Priority Level

Medium

[vitalets]

Yes, it's not customizable yet.
My suggestion is to add a snippetTemplate option like this:

const testDir = defineBddConfig({
  snippetTemplate: 'test/snippet.tpl',
  // ...
});

And the template itself:

<stepType>(<pattern>, <stepFn> {
  // <stepTitle>
  // <stepLocation>
  throw new Error("not yet implemented!");
});

What do you think?

[Noreaster76]

@vitalets I had to look up what a .tpl file is, but yeah, that should work!

I guess my only question is, what if users want to get a little fancy with their templates, like execute some logic (insert the current date, for example)? I guess one could apply YAGNI to that, and implement that when it's actually asked for. Or maybe that's already supported by .tpl files, in which case, 🆒. I guess what I'm saying is, just be aware that people might start asking for that.

Thank you for replying so promptly to the feature request! ✨

[vitalets]

.tpl extension is a shorten form for template. But it's not necessary, the file could be named with .txt or any other extension.
I'd better follow YAGNI here, to get actual request.

Also I have some thoughts to utilize AI for snippets - to output fully generated step definitions.

[Noreaster76]

Okay, sounds good! Thanks very kindly!