Generators as plugins with drift checking: interface stubs and ARXML from the model

Đang mở
  • Có gì không ổn?
#373 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
20/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
Lĩnh vực
devtools, tooling

Hướng nghiên cứu

Read issue #363 item 12 and the existing build-config, export-sysml, and structured export entry points to understand the current model outputs. Then review the import plugin contract and symbol drift check referenced as A. Done means a documented generator contract and manifest schema, plus one reference generator whose --check fails when a model operation changes and generated output is stale.

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 12). Largest payoff, largest cost.

Current state

build-config generates build-system artifacts from a Configuration; export-sysml and the structured export give the model graph. Nothing generates interface stubs, glue or ARXML.

Proposal

  • A generator contract, symmetric to import plugins: syscribe generate <alias> [--config C] [--out <dir>] runs [generators.<alias>] (a subprocess reading the structured model JSON on stdin, writing files and a manifest), so generators live outside the core.
  • Drift check. The manifest records, per generated file, the hash of the model elements it came from and the hash of the content; generate --check and validate report a generated file edited by hand or a model change not reflected in the output (traceBaselines:-style).
  • Reference generators (examples): interface stubs for AIDL or C++ from operations:; ARXML from ports and interfaces.
  • Ownership rule: the model is the source of truth for the interface, the code for the implementation; generated files are marked and never hand-edited (a // GENERATED header with the element ids).

Acceptance

  • One reference generator with --check that fails when a model operation changes and the output is stale.
  • The contract is documented with the manifest schema.

Risks

Round-tripping (code edits that should flow back) is out of scope; the import plugins plus the symbol drift check (A) cover the reverse direction.

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
4 giờ 44 phút
Pull request đã merge (30 ngày)
51

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.