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

Aberta
#958 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 5 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
18/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
handlebars, html, java, markdown
Domínio
cli, tooling

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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
Linguagem predominante
Java
Estrelas
1.1k
Forks
191
Merge médio
4d 23h
PRs com merge (30d)
1

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de OpenAPITools/openapi-diff

Todas as issues de OpenAPITools/openapi-diff

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.