[Rendering] R2: views, templates and built-in formats

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

维护者通常 5 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
18/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
handlebars, html, java, markdown
领域
cli, tooling

调研方向

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 内容生成。

描述

Render capabilities

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 → common location prefix, group result = worst result
  • byComponent() view: model → common component.path prefix, 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, Maven templateFile + templateOutputFileName (#355)
  • Markdown as a built-in template (plain Mustache syntax) + cross-format test
  • HTML as a built-in template; both flags stay: --html shows only breaking changes, --html-detailed shows 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 模板
  • 阅读贡献指南

从这里开始

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

OpenAPITools/openapi-diff 的其他 Issue

查看 OpenAPITools/openapi-diff 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

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