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

Offen
#958 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 5 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
18/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
handlebars, html, java, markdown
Bereich
cli, tooling

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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
Vorherrschende Sprache
Java
Sterne
1.1k
Forks
191
Ø Merge
4 T. 23 Std.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus OpenAPITools/openapi-diff

Alle Issues in OpenAPITools/openapi-diff

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.