Preserve frontmatter key order and comments on write (round-trip)

Aperta
#14 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
38/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
rust, yaml
Ambito
backend, data

Direzione di ricerca

Read the frontmatter merge/split path in gitnodes-app, especially merge_frontmatter, and the frontmatter types in gitnodes-domain; the issue also points to AGENTS.md and docs/ROADMAP.md. Identify where the write path rebuilds YAML and how the existing round-trip tests are organized. Done when editing one field preserves unrelated keys, ordering, comments, and nested maps and sequences.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

help wanted rust

Frontmatter round-trip is currently lossy: writing a note can reorder keys and drop comments. Tracked debt (see AGENTS.md / docs/ROADMAP.md) and a frequent papercut for users who hand-author YAML.

Scope

  • Preserve key order and comments through the write path (likely a YAML-AST-preserving approach rather than serialize-from-scratch).
  • Do not patch this ad hoc inside merge_frontmatter; the invariant is called out explicitly.

Acceptance criteria

  • Editing one field via the app/API leaves unrelated keys, ordering, and comments intact.
  • Round-trip tests cover comments, ordering, and nested maps/sequences.

Pointers: frontmatter merge/split in gitnodes-app (merge_frontmatter), gitnodes-domain frontmatter types.

Lingua principale
Rust
Stelle
5
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di AndreaBozzo/gitnodes

Tutte le issue di AndreaBozzo/gitnodes

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.