NeogitOrg / NeogitOrg/neogit

Refactor configuration options

Open
#227 4 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

refactor
Dominant language
Lua
Stars
5.6k
Forks
357
Avg merge
15h 47m
Merged PRs (30d)
2

Description

Is your feature request related to a problem? Please describe.
Options aren't 'in the same direction' at the moment. Would be nice to remove disable_ strings from them and switch bools around.

{
  disable_signs = false,
  disable_hint = false,
  disable_context_highlighting = false,
  disable_commit_confirmation = false,
  auto_refresh = true,
  disable_builtin_notifications = false,
}

This is subset of current options. Please note how auto_refresh is 'positive' while all others are 'negative' (disable_).

Describe the solution you'd like
It would probably make sense to group related options into subtable and turn them around, so instead of disable_signs = false default would be signs = true, but also would be nested into, let's say, display subtable (display.signs = true).

Describe alternatives you've considered
Leave things as they are but setup table will eventually become polluted.

Additional context
https://github.com/TimUntersberger/neogit/pull/225#discussion_r724809237

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the configuration options listed in the issue and the linked pull-request discussion. Determine the intended grouping and naming scheme before locating all current option definitions and uses. Done means the configuration is consistently organized without breaking existing setup behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.