o2sh/onefetch

Config file for theming/customization💄

Open

#745 opened on Aug 20, 2022

View on GitHub
 (20 comments) (4 reactions) (0 assignees)Rust (188 forks)batch import
discussionenhancementgood first issuehelp wanted

Repository metrics

Stars
 (5,179 stars)
PR merge metrics
 (Avg merge 13h 19m) (10 merged PRs in 30d)

Description

Summary 💡

What about having a configuration file in which you could customize visual aspects of onefetch? for example:

General options:

  • The glyph to use for the separator (use "->" instead of ":")
  • The padding between the output and its surroundings
  • The spacing between the separator and the info
  • The text colors (would be equivalent to --text-colors)
  • Whether to hide the ASCII logo
  • image path to display by default instead of the ASCII logo
  • ...

Palette:

  • Which glyph to use for the palette (use "●" instead of " ")
  • Whether to hide the palette.
  • ...

Info lines:

  • Define the text to display as a title for each info lines (use "🖴" instead of "Size")
  • ...

The configuration file could be placed in ${HOME}/.config/onefetch/config.conf (which format? YAML? TOML?)

As suggested by @spenserblack

  • Add CLI flag to provide a different path to the config file

Motivation 🔦

Allow users to customize the look and feel of onefetch by creating themes and config files that can be shared and enjoyed by others.

For reference --> https://github.com/Chick2D/neofetch-themes and https://github.com/spenserblack/repofetch (for an example of implementation)

Contributor guide

Research direction
Implement a configuration file parser (e.g., TOML) and add a CLI flag to specify a custom path. Define a config struct with all options listed in the issue, then integrate it with the existing theming code.
Tech stack
rust
Domain
clidevtools
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65