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

Implicit option names should be kebabed #7400

Open
SUPERCILEX opened this issue Oct 16, 2018 · 7 comments
Open

Implicit option names should be kebabed #7400

SUPERCILEX opened this issue Oct 16, 2018 · 7 comments
Labels
a:feature A new functionality in:console output progress tty mintty cygwin cli in:writing-tasks task option

Comments

@SUPERCILEX
Copy link
Contributor

Example:

@Option(description = "Trigger default templates update")
@get:Input
var updateTemplates: Boolean = false

The option name becomes updateTemplates but it should be update-templates.

@SUPERCILEX
Copy link
Contributor Author

@eriwen WDYT? And how would we deprecate the old properties? Or maybe save this up for Gradle 6.0?

@eriwen
Copy link
Contributor

eriwen commented Jan 9, 2019

This does seem like a breaking change (if minor), so in my opinion it should be Gradle 6.0. Possibly name should be required.

I'd say "a contribution is welcome" but it would be kinda weird to have to save a PR for nearly a year to merge it.

@SUPERCILEX
Copy link
Contributor Author

Yeah, that's what I was thinking. 👍 Well, I'm already excited for Gradle 6! 😆

@big-guy
Copy link
Member

big-guy commented Jan 9, 2019

We could have both options available and emit a deprecation warning for the non-kebab names.

We should update the docs to say that specifying an option value is a good practice for setters/fields that have names that should be kebabed. This is what we're doing in InitBuild.

@CristianGM
Copy link
Contributor

This was waiting for Gradle 6.0 to do a small breaking change, now this train seems to be gone..

@stale
Copy link

stale bot commented Dec 3, 2020

This issue has been automatically marked as stale because it has not had recent activity. Given the limited bandwidth of the team, it will be automatically closed if no further activity occurs. If you're interested in how we try to keep the backlog in a healthy state, please read our blog post on how we refine our backlog. If you feel this is something you could contribute, please have a look at our Contributor Guide. Thank you for your contribution.

@stale stale bot added the stale label Dec 3, 2020
@Vampire
Copy link
Contributor

Vampire commented Dec 8, 2020

Would still be nice to have, not present in 6.7.1.
7.0 is around the corner, so maybe now would be a good time for the breaking change? :-)

@stale stale bot removed the stale label Dec 8, 2020
@octylFractal octylFractal added a:feature A new functionality in:console output progress tty mintty cygwin cli in:writing-tasks task option and removed in:core DO NOT USE labels Nov 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:feature A new functionality in:console output progress tty mintty cygwin cli in:writing-tasks task option
Projects
None yet
Development

No branches or pull requests

8 participants