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

Deprecate --dependency-check-properties command line option #107

Closed
lread opened this issue Aug 19, 2024 · 2 comments · Fixed by #109
Closed

Deprecate --dependency-check-properties command line option #107

lread opened this issue Aug 19, 2024 · 2 comments · Fixed by #109
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@lread
Copy link
Contributor

lread commented Aug 19, 2024

From #106 (comment)

Currently

The --dependency-check-properties is more confusing than helpful, and is superseded by --clj-watson-properties.

So

Let's go ahead and deprecate it.

Ideas for deprecating -d

Option 1: Do nothing - continue to support.

Con: The option is confusing
Con: we have to maintain and make sure it works

Option 2: Turf it, breaking change.

This seems ok to me.
Con: breaks usage for x number of users. Maybe x = 0?
Pro: simplifies our life.

Option 3: Stop documenting the feature and warn if it is used.

Usage and README would not describe the feature and warn that it is slated for deletion if used.
Pro: gives users time to adapt.
Con: It is a burden on us to test/support for a bit longer.

Decision

@seancorfield has chosen option 3 for now.
A future release will likely implement option 2.

Next Steps

I can follow up with PR if that would help you.

@seancorfield
Copy link
Contributor

Yes, PR please -- it'll give me more insight into the CLI lib...

@seancorfield seancorfield added the documentation Improvements or additions to documentation label Aug 19, 2024
@seancorfield seancorfield added this to the 6.0 milestone Aug 19, 2024
@lread
Copy link
Contributor Author

lread commented Aug 19, 2024

I like babashka.cli because it is helpful but not rigid.

lread added a commit to lread/clj-watson that referenced this issue Aug 19, 2024
Don't show it in usage help.
Don't describe it in README.
Emit warning when it is used.

Close clj-holmes#107
lread added a commit to lread/clj-watson that referenced this issue Aug 19, 2024
Don't show it in usage help.
Don't describe it in README.
Emit warning when it is used.

Closes clj-holmes#107
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging a pull request may close this issue.

2 participants