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

Show the coordinates in a different form #148

Closed
9 tasks done
BranislavBeno opened this issue Nov 27, 2022 · 8 comments
Closed
9 tasks done

Show the coordinates in a different form #148

BranislavBeno opened this issue Nov 27, 2022 · 8 comments
Labels
enhancement New feature or request
Milestone

Comments

@BranislavBeno
Copy link

BranislavBeno commented Nov 27, 2022

It could be a useful addition when the application allows the user to choose a form of found coordinates.
I suggest extending command line interface with the new parameter -o respectively --output.
Supported values for suggested parameter should be:

  • maven
  • gradle
  • gradle-short
  • gradle-kotlin
  • sbt
  • ivy
  • grape
  • leiningen
  • buildr

When the parameter will not be from the given list, the application throws an exception with explaining message.
When the parameter will be empty or blank, the application throws an exception with explaining message as well.

For sake of backwards compatibility, when an output form will not be explicitly defined, maven output form will be used by default.

Suggested parameter will be relevant only for search command and only when groupId, artifactId and version are defined.

@mthmulders mthmulders added this to the 0.3 milestone Dec 1, 2022
@mthmulders mthmulders added the enhancement New feature or request label Dec 1, 2022
@mthmulders
Copy link
Owner

Thank you for contributing this idea, @BranislavBeno. I like the idea a lot!

May I suggest naming the new parameter format rather than output? To me, output sounds more like "where should the output go".

Indeed, when not specified, let's stick with the current behaviour (formatting as pom.xml snippet). For unknown values, an empty value or a blank value, an appropriate error message is a good idea.

@BranislavBeno
Copy link
Author

Thank you for your feedback, @mthmulders.
I agree, that format as a parameter identifier better fits its purpose.

@BranislavBeno
Copy link
Author

Thank you for your feedback, @mthmulders.
I agree, that --format as a parameter identifier better fits its purpose.
On the other hand, in case of -f as a shortened version, there could be potential confusion with --full-name of class-search command.
How to deal with it?

@mthmulders
Copy link
Owner

Hmm, you're right. Thinking out loud:

  1. Keep using --format as the full name of the parameter, shortened to -n (for "notation")
  2. Name the parameter --notation, shortened to -n

I don't like a short parameter which doesn't even resemble the full name (option 1). But I still feel format is the best description of what this parameter does.

What do you think about it, @BranislavBeno?

@BranislavBeno
Copy link
Author

You are right, --format is a better parameter identifier.
I will stick to your first suggestion.
This will also speed up PR preparation.
However, I'm of course still open to any changes within review. :-)

Best regards
Branislav

@mthmulders
Copy link
Owner

Added this feature with a3f54fd. Thanks you, @BranislavBeno, for your contribution!

@BranislavBeno
Copy link
Author

Added this feature with a3f54fd. Thanks you, @BranislavBeno, for your contribution!

The pleasure was mine. :-)

@mthmulders mthmulders modified the milestones: 0.3, 0.4 Jan 5, 2023
@mthmulders
Copy link
Owner

Released in v0.3.0.

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

No branches or pull requests

2 participants