add help options to display helper text for cmd applications #661

IvanGael · 2024-05-28T01:32:08Z

Closes: #568

Description:

There are the changes have been made

// cmd.go

Structure for Sub-Commands:route struct now includes a description field to store the command description.
Handling -h or --help:he Run method checks for -h or --help flags. If found, it calls cmd.printHelp() to print the help message and exits.
Listing Sub-Commands: printHelp method prints all registered sub-commands along with their descriptions.
Default Command Handling: If no command is provided or an unknown command is encountered, the help message is printed along with an error message.

The files cmd_test.go, gofr.go, gofr_test.go and examples/sample-cmd/main.go are updated accordingly.

Checklist:

I have formatted my code using goimport and golangci-lint.
All new code is covered by unit tests.
This PR does not decrease the overall code coverage.
I have reviewed the code comments and documentation for clarity.

ccoVeille

My feedback on your changes, you can of course ignore them

pkg/gofr/cmd.go

pkg/gofr/gofr_test.go

pkg/gofr/gofr.go

vipul-rawat · 2024-05-28T08:54:39Z

@IvanGael This gives user to define the custom helper doc to be used printed for each sub command. We also wanted to have a default helper functionality that prints all available sub commands for the executed command in case the command is not present.

IvanGael · 2024-05-28T10:03:22Z

@vipul-rawat After fixing the issues and implementing the various suggestions, should I close this pull request before creating another one?

vipul-rawat · 2024-05-28T10:37:46Z

@vipul-rawat After fixing the issues and implementing the various suggestions, should I close this pull request before creating another one?

@IvanGael Try to update this PR itself

Also please fix the merge conflicts

…vment)

IvanGael · 2024-05-28T12:58:43Z

@vipul-rawat I just added new commit to this PR. Try to review.

IvanGael · 2024-05-28T12:59:48Z

@vipul-rawat What causes merge conflict issues?

ccoVeille

Thanks for the changes. I way simpler to read and maintain now, I think.

I will let maintainers/owner share their point of view

pkg/gofr/cmd_test.go

srijan-27 · 2024-05-28T13:08:47Z

@vipul-rawat What causes merge conflict issues?

@IvanGael - Merge conflicts happen when 2 branches make different changes to the single line, it would be because of other PR (which had changes to the same line as this branch) getting merged to base branch. You can resolve them easily, but be careful as we would not want to remove the changes from other branch.

IvanGael · 2024-05-29T11:41:42Z

Okay @srijan-27 I will try to resolve it

IvanGael · 2024-05-30T10:39:13Z

@vipul-rawat @srijan-27 @ccoVeille I don't understant why this line cause conflict

ccoVeille · 2024-05-30T11:21:44Z

In such a case there is no real need to understand. Remove everything between <<<< and >>>> then save. Your IDE will fix the import

vipul-rawat · 2024-05-31T09:54:59Z

@IvanGael are you still having trouble fixing the conflict?

IvanGael · 2024-05-31T12:10:30Z

@vipul-rawat Normally there should be no more merge conflicts because I did what @ccoVeille suggested to me. I don't understand why this issue persists. Could you help me with this ?

vipul-rawat · 2024-05-31T12:35:43Z

@vipul-rawat Normally there should be no more merge conflicts because I did what @ccoVeille suggested to me. I don't understand why this issue persists. Could you help me with this ?

You need to update your branch in the forked repo with the current development branch of this repo(in which this PR merges the code).
To do this:

Add a remote repo with this repo's link - git remote add gofr https://github.com/gofr-dev/gofr
Merge the development onto your branch- git pull gofr development

These 2 steps should give you a conflict in your gofr_test file, resolve them and push it to your branch.

…elpSubCommandsFeature

IvanGael · 2024-05-31T18:07:08Z

@vipul-rawat Check if all is good for the merging

pkg/gofr/gofr.go

pkg/gofr/cmd.go

IvanGael · 2024-06-01T00:25:50Z

pkg/gofr/cmd.go

…gofr into helpSubCommandsFeature

pkg/gofr/gofr.go

vipul-rawat · 2024-06-06T10:56:05Z

@IvanGael tests and code quality checks are failing, please use golang ci-lint v1.57.2 to check for any linter.

aryanmehrotra

Response doesn't seem right with unwanted square brackets

Would be better if we have something similar to how other help commands look like of -git or github (gh)
No Command Found! is also misleading because help is the command

…elpSubCommandsFeature

…gofr into helpSubCommandsFeature

pkg/gofr/cmd.go

pkg/gofr/gofr.go

pkg/gofr/gofr_test.go

ccoVeille

Only one small question

pkg/gofr/cmd.go

vipul-rawat

Please remove the unused code - fullpattern field

Rest implementation look good 👍

pkg/gofr/cmd.go

Rereviewing

…mmandsFeature

ccoVeille · 2024-06-10T12:56:50Z

You did it @IvanGael

IvanGael · 2024-06-10T15:12:44Z

@ccoVeille I'm glad you appreciate it. Looking forward to continue to contribute to this project.

* Update workflow and docs for docs deployment (#693) * Revert "Update workflow and docs for docs deployment (#693)" (#694) This reverts commit c2e022d. * Added additional logging for datasource (#655) Co-authored-by: Umang Mundhra <[email protected]> Co-authored-by: Srijan Rastogi <[email protected]> Co-authored-by: srijan-27 <[email protected]> * Fe/support for cassandra (#654) Co-authored-by: Aryan Mehrotra <[email protected]> Co-authored-by: Umang Mundhra <[email protected]> Co-authored-by: mehrotra234 <[email protected]> * Add support for local file store (#695) * add help options to display helper text for cmd applications (#661) --------- Co-authored-by: Aryan Mehrotra <[email protected]> Co-authored-by: vipul-rawat <[email protected]> * Revert request_timeout default value (#699) * upgrade framework version --------- Co-authored-by: Aryan Mehrotra <[email protected]> Co-authored-by: KedarisettiSreeVamsi <[email protected]> Co-authored-by: Umang Mundhra <[email protected]> Co-authored-by: Shashank Shekhar <[email protected]> Co-authored-by: mehrotra234 <[email protected]> Co-authored-by: Ivan APEDO <[email protected]> Co-authored-by: vipul-rawat <[email protected]>

issue gofr-dev#568 attempt1 solved!

466200e

ccoVeille reviewed May 28, 2024

View reviewed changes

pkg/gofr/cmd.go Outdated Show resolved Hide resolved

pkg/gofr/gofr_test.go Show resolved Hide resolved

vipul-rawat reviewed May 28, 2024

View reviewed changes

pkg/gofr/gofr.go Outdated Show resolved Hide resolved

vipul-rawat mentioned this pull request May 28, 2024

Add -h or --help for gofr.NewCMD() #568

Closed

issue gofr-dev#568 attempt2 ( solve some issues and adding some impro…

540b196

…vment)

ccoVeille approved these changes May 28, 2024

View reviewed changes

pkg/gofr/cmd_test.go Outdated Show resolved Hide resolved

pkg/gofr/cmd_test.go Outdated Show resolved Hide resolved

vipul-rawat changed the title ~~issue #568 attempt1 solved!~~ add help options to display helper text for cmd applications May 28, 2024

refractoring cmd_test.go functions to make an indentation

9890de1

IvanGael added 2 commits May 30, 2024 15:26

little fix

f07f0ed

little fix

ca24046

IvanGael added 2 commits May 31, 2024 20:04

Merge branch 'development' of https://github.com/gofr-dev/gofr into h…

0c443c6

…elpSubCommandsFeature

fix merge conflicts

c16a5c4

vipul-rawat requested changes May 31, 2024

View reviewed changes

pkg/gofr/gofr.go Outdated Show resolved Hide resolved

pkg/gofr/cmd.go Outdated Show resolved Hide resolved

handle help field

e0ffae0

vipul-rawat reviewed Jun 1, 2024

View reviewed changes

pkg/gofr/cmd.go Outdated Show resolved Hide resolved

vipul-rawat reviewed Jun 1, 2024

View reviewed changes

pkg/gofr/cmd.go Outdated Show resolved Hide resolved

IvanGael added 2 commits June 4, 2024 12:55

Merge branch 'helpSubCommandsFeature' of https://github.com/IvanGael/…

4c6a437

…gofr into helpSubCommandsFeature

refractor gofr.go to decrease number of lines of code

7bc5ca8

IvanGael requested a review from vipul-rawat June 4, 2024 11:16

vipul-rawat reviewed Jun 6, 2024

View reviewed changes

pkg/gofr/gofr.go Outdated Show resolved Hide resolved

Merge branch 'development' into helpSubCommandsFeature

3e87830

aryanmehrotra requested changes Jun 7, 2024

View reviewed changes

IvanGael added 3 commits June 9, 2024 16:07

Merge branch 'development' of https://github.com/gofr-dev/gofr into h…

e1e527a

…elpSubCommandsFeature

Change a little bit the implementation

0c8cf4d

Merge branch 'helpSubCommandsFeature' of https://github.com/IvanGael/…

c31a425

…gofr into helpSubCommandsFeature

IvanGael requested review from vipul-rawat and aryanmehrotra June 9, 2024 14:10

ccoVeille reviewed Jun 9, 2024

View reviewed changes

pkg/gofr/cmd.go Outdated Show resolved Hide resolved

pkg/gofr/cmd.go Outdated Show resolved Hide resolved

pkg/gofr/gofr.go Show resolved Hide resolved

pkg/gofr/gofr_test.go Outdated Show resolved Hide resolved

some changes

c9c2fab

IvanGael requested a review from ccoVeille June 10, 2024 07:59

ccoVeille approved these changes Jun 10, 2024

View reviewed changes

pkg/gofr/cmd.go Show resolved Hide resolved

vipul-rawat previously requested changes Jun 10, 2024

View reviewed changes

pkg/gofr/cmd.go Outdated Show resolved Hide resolved

vipul-rawat added 3 commits June 10, 2024 17:28

revert unnecessary changes and resolve linters

12b6d6a

Merge branch 'development' of github.com:gofr-dev/gofr into helpSubCo…

f3d0597

…mmandsFeature

add godoc for AddDescription and AddHelp

c990b1b

aryanmehrotra previously approved these changes Jun 10, 2024

View reviewed changes

resolve failing linters

009c423

vipul-rawat dismissed aryanmehrotra’s stale review via 009c423 June 10, 2024 12:10

srijan-27 approved these changes Jun 10, 2024

View reviewed changes

aryanmehrotra merged commit ea9107e into gofr-dev:development Jun 10, 2024
11 checks passed

aryanmehrotra mentioned this pull request Jun 11, 2024

Release v1.9.0 #700

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add help options to display helper text for cmd applications #661

add help options to display helper text for cmd applications #661

IvanGael commented May 28, 2024 •

edited by srijan-27

Loading

ccoVeille left a comment

vipul-rawat commented May 28, 2024

IvanGael commented May 28, 2024

vipul-rawat commented May 28, 2024 •

edited

Loading

IvanGael commented May 28, 2024

IvanGael commented May 28, 2024

ccoVeille left a comment

srijan-27 commented May 28, 2024 •

edited

Loading

IvanGael commented May 29, 2024

IvanGael commented May 30, 2024

ccoVeille commented May 30, 2024

vipul-rawat commented May 31, 2024

IvanGael commented May 31, 2024

vipul-rawat commented May 31, 2024

IvanGael commented May 31, 2024

IvanGael commented Jun 1, 2024

vipul-rawat commented Jun 6, 2024

aryanmehrotra left a comment •

edited

Loading

ccoVeille left a comment

vipul-rawat left a comment •

edited

Loading

ccoVeille commented Jun 10, 2024

IvanGael commented Jun 10, 2024

add help options to display helper text for cmd applications #661

add help options to display helper text for cmd applications #661

Conversation

IvanGael commented May 28, 2024 • edited by srijan-27 Loading

ccoVeille left a comment

Choose a reason for hiding this comment

vipul-rawat commented May 28, 2024

IvanGael commented May 28, 2024

vipul-rawat commented May 28, 2024 • edited Loading

IvanGael commented May 28, 2024

IvanGael commented May 28, 2024

ccoVeille left a comment

Choose a reason for hiding this comment

srijan-27 commented May 28, 2024 • edited Loading

IvanGael commented May 29, 2024

IvanGael commented May 30, 2024

ccoVeille commented May 30, 2024

vipul-rawat commented May 31, 2024

IvanGael commented May 31, 2024

vipul-rawat commented May 31, 2024

IvanGael commented May 31, 2024

IvanGael commented Jun 1, 2024

vipul-rawat commented Jun 6, 2024

aryanmehrotra left a comment • edited Loading

Choose a reason for hiding this comment

ccoVeille left a comment

Choose a reason for hiding this comment

vipul-rawat left a comment • edited Loading

Choose a reason for hiding this comment

ccoVeille commented Jun 10, 2024

IvanGael commented Jun 10, 2024

IvanGael commented May 28, 2024 •

edited by srijan-27

Loading

vipul-rawat commented May 28, 2024 •

edited

Loading

srijan-27 commented May 28, 2024 •

edited

Loading

aryanmehrotra left a comment •

edited

Loading

vipul-rawat left a comment •

edited

Loading