[Rendering] R2: views, templates and built-in formats
維護者通常 5 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 18/100
研究方向
This is the R2 umbrella of the rendering plan in #954 and is split into one PR per checkbox, so start by reading the existing renderer and view classes under the core rendering package, plus how --html and --html-detailed map to files today. Pick a single unchecked item (the Markdown built-in template is the most self-contained) and read the cross-format test it must satisfy. Done means that format shows every record, every change shows its result, and each record appears exactly once in the cross-format test.
由索引模型根據 Issue 內容生成。
描述
Part of the rendering plan: #954 (R2)
Goal
All text formats render from the change list: Markdown, HTML and Asciidoc as built-in templates, Console in Java.
Scope
One item per PR:
-
byOperation()view: operation → commonlocationprefix, group result = worst result -
byComponent()view: model → commoncomponent.pathprefix, each change with its operations (API only in 3.0.0) - Template support: Handlebars.java, template data,
--template(output to stdout),--print-template, log messages to stderr, MaventemplateFile+templateOutputFileName(#355) - Markdown as a built-in template (plain Mustache syntax) + cross-format test
- HTML as a built-in template; both flags stay:
--htmlshows only breaking changes,--html-detailedshows all changes, as today - Asciidoc as a built-in template
- Console moved to the
byOperation()view
Header in every text format: spec titles, file names (#506), overall result, totals per result (#627).
Done when
- Cross-format test: every format shows every record (#620, #215, #362)
- Every change shows its result in every format (#766, #325)
- A shared schema change is shown under every operation that uses it (#523)
- Each view shows every record exactly once
- 主要語言
- Java
- 星號
- 1.1k
- 分支
- 191
- 平均合併
- 4 天 23 小時
- 30 天內合併 PR
- 1
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
OpenAPITools/openapi-diff 的其他 Issue
-
enhancement
難度 2/5 1-3 小時 新手友好度 68/100
OpenAPITools/openapi-diff#506 ·
維護者通常 5 天內回覆
-
HtmlRender: Notes of Parameters shows always the new description可能已有人在做 @Inf1mum 於 6 天前認領。 未關閉good first issue help wanted
難度 2/5 1-3 小時 新手友好度 68/100
OpenAPITools/openapi-diff#364 ·
維護者通常 5 天內回覆
-
Render capabilities
難度 5/5 一週以上 新手友好度 20/100
OpenAPITools/openapi-diff#959 ·
維護者通常 5 天內回覆
-
Render capabilities
難度 3/5 1-2 天 新手友好度 55/100
OpenAPITools/openapi-diff#957 ·
維護者通常 5 天內回覆
-
[Rendering] R0: change list and builder可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉Render capabilities
難度 4/5 3-5 天 新手友好度 32/100
OpenAPITools/openapi-diff#956 · 1 則留言 ·
維護者通常 5 天內回覆
查看 OpenAPITools/openapi-diff 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 62/100
eclipse-tradista/tradista#371 ·
維護者通常 1 天內回覆
-
critical
難度 2/5 1-3 小時 新手友好度 68/100
mars-sim/mars-sim#2199 · 2 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
primefaces/primefaces#15568 ·
維護者通常 1 天內回覆
-
崩溃日志只按 CRLF 分行未關閉
難度 2/5 1-3 小時 新手友好度 72/100
PCL-Community/PCL-CE#3872 ·
維護者通常 1 天內回覆