Skip to content
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

fix: Added IPublishConfig interface for use in makePublishConfig #2106

Merged
merged 1 commit into from
Aug 9, 2022

Conversation

mannyistyping
Copy link

@mannyistyping mannyistyping commented Aug 7, 2022

🤔 What's changed?

This PR does the following,

  • defines a new interface IPublishConfig
  • explicitly defines the possible return values to makePublishConfig in src/api/convert_configuration.ts to IPublishConfig | false
  • updates the publish property in the IRunOptionsFormats interface in src/api/types.ts to reflect the newly defined IPublishConfig interface or false

⚡️ What's your motivation?

The motivation for this update/change is the incremental completion of #1648 in small manageable PRs.
I imagine this will be one of multiple PRs to replace explicit any with a type.

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, documentation etc. without changing behaviour)

♻️ Anything particular you want feedback on?

  • I would love feedback on this approach to removing any and defining an interface for strictly typing, is this the recommended approach for this project?
    • I based this approach on looking at how other return types were defined and where those definitions were placed

📋 Checklist:


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

@coveralls
Copy link

coveralls commented Aug 7, 2022

Coverage Status

Coverage remained the same at 98.343% when pulling 43d0573 on mannyistypingonacomputer:issue.1648 into a52e1e5 on cucumber:main.

@mannyistyping mannyistyping marked this pull request as ready for review August 7, 2022 22:02
Copy link
Contributor

@davidjgoss davidjgoss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @mannyistypingonacomputer.

To get this mergeable, could you revert the change to the version in package.json and remove the relevant heading in the changelog? We do version bumps at release time, not as part of pull requests. (The changelog entry is fine to stay, but just under the Unreleased heading.)

Thanks!

@mannyistyping
Copy link
Author

Looks good @mannyistypingonacomputer.

To get this mergeable, could you revert the change to the version in package.json and remove the relevant heading in the changelog? We do version bumps at release time, not as part of pull requests. (The changelog entry is fine to stay, but just under the Unreleased heading.)

Thanks!

Sure thing, David! (@davidjgoss)

I got ahead of myself there and incorrectly added the entry to the released section :)
I appreciate you providing your guidance!

Changes are pushed up and ready for re-review at your convenience.

@davidjgoss davidjgoss merged commit 21a3e6c into cucumber:main Aug 9, 2022
@aslakhellesoy
Copy link
Contributor

Hi @mannyistypingonacomputer,

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:

  • ✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
  • 💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
  • 💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
  • ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
  • 🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team,
Aslak Hellesøy
Creator of Cucumber

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants