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
Spring-CLI: "packageName" parameter is not aligned with the docs and doesn't fit the naming convention of other parameters #26878
Comments
This is my first issue as well as PR that I submitted here: #26879. Please correct me if I wrong. |
If you run |
You're 100% correct. Even remembering a couple of parameters might help, but knowing which one should be camelCased and which one should not, makes it harder to use (unless you would look in the documentation). Talking about documentation and the It seems like the best option would be to change the camelCase naming on the server to the dash-separated. However, it's clear that it might break some existing clients/integrations. I would wait for your feedback. Thanks a lot for looking at this. |
That's a totally different endpoint that provides the API contract. As I've mentioned in my reply, the server gives you back a number of "parameters" that it supports primarily to tell you about default values. These are not meant to map to the actual option that you can use using the Sping CLI. Arguably, if it was we should rather have written them as |
The code has a mapping from CLI options (kebab-case) to query parameters (camelCase) when issuing a project creation request. I think it needs to map things the other way when displaying information for We should probably also fix the CLI options so that all multi-word options have a kebab-case variant. Specifically |
Hi Team, wanted to check if this issue is still open to contribute? |
Yes, it is. The comment above your summarizes what we'd like to do. We can't stop supporting an option without a deprecation period so, yes, both CLI options should work. You can submit a PR if you like and we can guide you from there. |
Closing in favour of #28138. |
Hi @wilkinsona, Request you to kindly provide the issue/PR which supersedes the fix for #28138? Thank you so much |
@vignesh1992 #28138 has not been superseded. We're closing this issue in favor of your PR. |
Hi @philwebb, Thank you so much for your response. As this is my first time contributing to this repo, would be interested to know to get feedbacks on the PR and next steps on when it will make it to the release. |
@vignesh1992 We hope to get to it soon. |
Steps to reproduce:
spring init --list
. As a result a list of dependencies and parameters will appear in the console:Expected result:
Spring app should be created. The following (or similar output) should be produced in the console:
Actual result:
Spring app creation fails with the following message:
packageName is not a recognized option
Notes:
The reason I put "doesn't fit the naming convention of other parameters" in the description as it seems like all other options are "camel cased" whereas this particular one is dash separated. There are 2 way of fixing - either changing the docs or parameter name. I felt like changing the parameter is more appropriate in this case.
The text was updated successfully, but these errors were encountered: