Derived component diagram with provided and required interfaces

Đang mở
  • Có gì không ổn?
#367 0 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
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, rust, yaml
Lĩnh vực
backend, design

Hướng nghiên cứu

Start with the diagram-generation design in #334 and the existing IBD rendering for ports and connections. Trace how PortDef, InterfaceDef, direction, and conjugation are represented, then add tests for the provider-consumer diagram, unmatched socket warning, and unchanged IBD. Done means the tests show a joined lollipop and socket with the interface name, a warning for an unmatched required socket, and no IBD change.

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

Mô tả

Part of #363 (item 5).

Current state

Ports carry direction, isConjugated and conjugates (a PortDef and its conjugate), and the IBD draws ports as squares with a direction fill. There is no component-style view with provided and required interfaces.

Proposal

A derived Component diagram (diagramKind: Component, subject a part or package): each part is a component box; a port typed by a PortDef/InterfaceDef that the part provides is drawn as a lollipop, one that it requires (the conjugated side) as a socket; a connection joins a lollipop to a socket and the interface name labels it. Provided/required is derived from conjugation and direction, not stored. Parts are grouped by domain or package (see the diagram-generation design, #334). Operations of the interface (A) can be listed on request.

Acceptance (tests first)

  • A model with a provider and a consumer of one interface shows lollipop and socket joined; an unmatched socket (required, nothing provides) is a warning.
  • The same data in the IBD is unchanged.

Part of #272 (executable MBSE / software design).

Generated by Claude Code

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

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ề Rust

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.