Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Format-preserving writes for structural frontmatter (features, connections, layout, shapes, edges)

Đang mở
  • Có gì không ổn?
#405 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, rust, yaml
Lĩnh vực
developer-experience, tooling

Hướng nghiên cứu

Read prompts/help/set.md and inspect the minimal-edit paths for set and move, then compare them with the MCP update_element implementation and syscribe_model::mutate. First clarify with the owner whether the initial scope is structural list and map edits or formatting preservation in update_element, and which fields it covers. Done means the selected path preserves untouched frontmatter formatting while retaining re-validation and the referential-integrity gate; the issue names no tests.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Feature request (from a VS Code extension with a canvas editor for the model).

Gap. Tools that edit a model need to change features:, connections:, layout:, shapes: and edges: without rewriting the rest of the file.

  • syscribe set is documented as a line-level edit, byte-preserving for the rest of the file (prompts/help/set.md), and re-serialises the frontmatter only for a list written as a multi-line flow list. It covers only a short allowlist of fields, and the structural ones above are not on it.
  • move is likewise a surgical edit, also on an allowlist.
  • The MCP update_element is documented as an arbitrary-field merge. Nothing promises it keeps comments, indentation or key order, so it should not be expected to.

So a client that must keep a user's formatting has to edit the frontmatter text itself with its own comment-preserving YAML library, and use the binary only to validate.

Options.

  1. Extend the minimal-edit path to structural lists and maps (add, remove and change an entry of features:, connections:, layout:, shapes:, edges:).
  2. Make update_element preserve formatting (comments, quoting, indentation, key order) for the parts of the frontmatter it does not change.

Either lets such a client use the binary's guarded write path (syscribe_model::mutate, with re-validation and the referential-integrity gate) and drop its own YAML handling.

Open question for the owner: which option, and which fields are in scope for the first slice?

🤖 Generated with Claude Code

https://claude.ai/code/session_01ANvoJ7rMK9HUDP1qDdYEnN

Ngôn ngữ chính
JavaScript
Star
8
Fork
1
Merge trung bình
3 giờ 13 phút
Pull request đã merge (30 ngày)
61

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của sjames/syscribe

Tất cả issue của sjames/syscribe

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.