Skip to content

feat(status): add hint #225

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

Merged
merged 2 commits into from
Oct 12, 2021
Merged

Conversation

wongjiahau
Copy link
Contributor

Preface

As a beginner I feel that it would be convenient to have the common keymap displayed all the time, otherwise I have to keep looking at the help file until I can memorize them.

Screenshots

Before After
image image

@bronzehedwick
Copy link

I think this is a great idea, but could there also be a preference to disable it?

@TimUntersberger
Copy link
Collaborator

@wongjiahau like @bronzehedwick said can you please add a config property?

@wongjiahau
Copy link
Contributor Author

@TimUntersberger Sure! I'll try to get this done by today

@@ -104,6 +104,7 @@ local neogit = require("neogit")

neogit.setup {
disable_signs = false,
disable_hint = false,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It matches the options, but wouldn't it be better to have them other way around? Maybe something like:

neogit.setup {
  display = {
    signs = true,
    hint = true,
    context_highlighting = true,
    commit_confirmation = true,
  },
}

I know it's breaking change, but simplifies things in my opinion. What do you think @TimUntersberger? (most likely not part of that PR though)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gegoune That's actually more readable, but then these properties might not be easily searchable, which is part of the reason why I can find the relevant files quickly, say by searching for disable_signs.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gegoune I think grouping these together into a common subtable wouldn't be a bad idea, but I am not sure what to call it yet. Can you open a seperate issue for this?

@TimUntersberger
Copy link
Collaborator

LGTM! Thank you!

@TimUntersberger TimUntersberger merged commit baa7d76 into NeogitOrg:master Oct 12, 2021
@wongjiahau
Copy link
Contributor Author

@TimUntersberger Thanks!

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

Successfully merging this pull request may close these issues.

4 participants