gitui-org/gitui

Configuration file support

Open

#2,140 opened on Mar 20, 2024

View on GitHub
 (3 comments) (2 reactions) (0 assignees)Rust (21,937 stars) (721 forks)batch import
feature-requestgood first issue

Description

Whenever I run GitUI in a new working directory, when comparing differences, I have to do o to get into Options, then under Diff, I set "Ignore whitespaces" to true.

I would like it so that within the config directory, I can place a gitui.ron file with the content:

(
    diff: (
        ignore_whitespace: true,
        context: 3,
        interhunk_lines: 0,
    )
)

Then when GitUI starts up, it uses these values as the new defaults, and any changes you make would be written to .git/gitui in the working directory.

Contributor guide

Tech stack
rust
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Rust programmingUnderstanding of GitUI's options system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate how GitUI currently manages options (likely in `src/options.rs` or similar). Implement reading a `gitui.ron` file from the config directory and merging with defaults. Check the existing `Options` struct and ensure values are applied on startup. See comments in the issue for discussion on format and location.
Configuration file support · gitui-org/gitui#2140 | Good First Issue