[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 天内回复