update config to support default definition function

[notaphplover]

🤔 What's changed?

This PR aims to allow default profile to be a function that dynamically generates cucumber profiles

⚡️ What's your motivation?

Closes #2009.

🏷️ 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.
• My change requires a change to the documentation.
  • I have updated the documentation accordingly.
• Users should know about my change
  • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

---

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

[coveralls]

coverage: 98.397% (+0.005%) from 98.392%
when pulling 5699c69 on notaphplover:feat/add-default-config-function
into a02d90e on cucumber:main.

[davidjgoss]

Thanks for raising @notaphplover, this is looking good.

A few initial thoughts from me, if that's okay:

• It's neat that we allow static profile definitions to be done on other exports when doing the function, but that feels like a bit of a confusing API to me - I think it might be better to keep it simple, so you either a) provide static profiles with exports, or b) a single default export function to do it dynamically, and not a mixture of the two. What do you think?
• I also think we should avoid adding the default: {} in the new code - if the dynamically resolved config has no default key, I still think we want to have that logging happen below

Other than that, I think the next steps here would be:

• Add a logger.debug statement when we detect and run a function for config
• Add a new e2e scenario at the end of https://github.com/cucumber/cucumber-js/blob/main/features/profiles.feature
• Add documentation in https://github.com/cucumber/cucumber-js/blob/main/docs/configuration.md and/or https://github.com/cucumber/cucumber-js/blob/main/docs/profiles.md

Let me know if you need a steer on anything!

[notaphplover]

Thanks for raising @notaphplover, this is looking good.

You're very welcome, it's my pleasure 😃.

A few initial thoughts from me, if that's okay:

• It's neat that we allow static profile definitions to be done on other exports when doing the function, but that feels like a bit of a confusing API to me - I think it might be better to keep it simple, so you either a) provide static profiles with exports, or b) a single default export function to do it dynamically, and not a mixture of the two. What do you think?

I totally agree with you.

• I also think we should avoid adding the default: {} in the new code - if the dynamically resolved config has no default key, I still think we want to have that logging happen below

I see, but then in some cases there will be no default profile. You know way better than me the code flows so I assume that's ok. Sure, I'll add the logging sentence.

Other than that, I think the next steps here would be:

• Add a logger.debug statement when we detect and run a function for config
• Add a new e2e scenario at the end of https://github.com/cucumber/cucumber-js/blob/main/features/profiles.feature
• Add documentation in https://github.com/cucumber/cucumber-js/blob/main/docs/configuration.md and/or https://github.com/cucumber/cucumber-js/blob/main/docs/profiles.md

Sure, I'll go for it.

Let me know if you need a steer on anything!

Thank you so much! Sure, I'll do it. I'll try to have some time to continue on this on the weekend.

[davidjgoss]

I see, but then in some cases there will be no default profile. You know way better than me the code flows so I assume that's ok. Sure, I'll add the logging sentence.

Ah you're right, looking at the code again I see that the else block with the logging would not be reached in the case of a config-providing function. It would be good to make that happen either way by shifting the code around a bit.

[davidjgoss]

Thanks very much @notaphplover!

[davidjgoss]

Released in https://github.com/cucumber/cucumber-js/releases/tag/v10.5.0