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

suggestion(semver): remove redundant increment() arguments #4420

Open
timreichen opened this issue Mar 1, 2024 · 0 comments
Open

suggestion(semver): remove redundant increment() arguments #4420

timreichen opened this issue Mar 1, 2024 · 0 comments
Labels
feedback welcome We want community's feedback on this issue or PR

Comments

@timreichen
Copy link
Contributor

Is your feature request related to a problem? Please describe.

increment() has four arguments (two required, two optional). That is more than the style guide suggests.

  • buildmetadata just seem to replace the semver build property.
  • prerelease as a string kinda breaks the established pattern of prerelease being an (string|number)[] array and needs to be parsed inside increment(). It doesn't seem very intuitive, how that argument works in combination with ReturnType and existing version.prerelease. This is why the majority of the jsdoc description tries to explain that.

Describe the solution you'd like

  • Remove buildmetadata argument, as version.build can be set outside the increment() function.
  • Remove prerelease argument, as version.prerelease can be set outside the increment() function.

Describe alternatives you've considered

Leave as is.

@iuioiua iuioiua changed the title breaking(semver): increment() redundant arguments suggestion(semver): remove redundant increment() arguments Mar 4, 2024
@iuioiua iuioiua added the feedback welcome We want community's feedback on this issue or PR label Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feedback welcome We want community's feedback on this issue or PR
Projects
None yet
Development

No branches or pull requests

2 participants