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

Đang mở
#958 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 5 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
18/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ệ
handlebars, html, java, markdown
Lĩnh vực
cli, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
Java
Star
1.1k
Fork
191
Merge trung bình
4 ngày 23 giờ
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

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 OpenAPITools/openapi-diff

Tất cả issue của OpenAPITools/openapi-diff

Issue tương tự

Thêm issue về Java

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.