`%optimize` and `%configure` have no machine-readable form (`-json`)

未关闭
#2,342 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
55/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
go

调研方向

Start with internal/frontend/repl/optimize.go and repl.SolveReport in check.go, then trace how %check -json is parsed and emitted in the CLI and REPL. Define and document a stable solver-report JSON shape for %optimize and %configure, with tests for normal, unsat, and unknown results and unchanged text output. Done means consumers can read reports as JSON while existing text output and exit codes remain unchanged.

由索引模型根据 Issue 内容生成。

描述

Disclaimer, this issue was detected and written by an AI

Summary

%optimize returns a structured []SolveReport in Go but only prose through
the REPL/CLI; %configure has no structured form at all. Tools that want the
optima (a trade-study UI, a results comparison) must scrape terminal text, or
cannot offer the verb.

%check already has a JSON form (-json, one JSON document), so the shape to
follow exists.

Current state

  • internal/frontend/repl/optimize.go:16 — OptimizeSolve returns
    []SolveReport; repl.SolveReport (check.go:58) has no json: tags.
  • No -json arm for %optimize/%configure; -json selects check-report JSON.
  • The service/CLI RPCs are unaffected; this is an output-contract issue.

Proposal

Define and document a JSON document for solver reports, mirroring -check -json:
one JSON object per command run, with subject, status (sat/unsat/
unknown), solver, values (name/value/unit), and lines for the human
explanation. Add -json (or %optimize -json/%configure -json) on the CLI and
REPL; when the flag is set, write only that document and no prose. Give the struct
tags and a stable schema; keep existing text output unchanged without the flag.

Tests

  • A solver demo: %optimize -json emits one object per report with the stable
    fields; %optimize without the flag is byte-identical to today.
  • %configure -json covers the same shape (or a documented subset).
  • An unsat/unknown case carries status and the explanation, not an empty object.

Acceptance

  • The JSON shape is documented (wire-contract or CLI reference) and tagged.
  • -json changes only the output form; exit codes and text mode unchanged.
  • A consumer can read optima without parsing prose.
主要语言
Go
星标
59
派生
20
平均合并
10 小时 23 分钟
30 天内合并 PR
897

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Open-MBEE/OpenSysML 的其他 Issue

查看 Open-MBEE/OpenSysML 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。