Add a way to add comments and TOML sections to config files

Open
#42 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
tooling

Research direction

The issue names no files, tests, or entry points. Start by locating confy's TOML configuration parsing and writing code, then determine how comments and sections should be represented and preserved. Done should provide a documented, tested way to add comments and TOML sections without breaking existing configuration handling.

Written by the indexing model from the issue text.

Description

Comments can make config files more user-friendly by giving hints about possible values and where more info can be found.
When config files get large, sections are useful to break it up so that things are easier to find.

Thanks for making this, confy made my life much much easier today.

Dominant language
Rust
Stars
1k
Forks
78
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from rust-cli/confy

All issues in rust-cli/confy

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.