Derived component diagram with provided and required interfaces

Aperta
  • Qualcosa non va?
#367 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
javascript, rust, yaml
Ambito
backend, design

Direzione di ricerca

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.

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

Descrizione

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

Lingua principale
Rust
Stelle
8
Fork
1
Merge medio
3h 35m
PR unite (30g)
69

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 sjames/syscribe

Tutte le issue di sjames/syscribe

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.