Uses the latest Gavel API - Githubissues

apiaryio / gavel2html

Renders HTML diff from Gavel.js output

MIT License

0 stars 0 forks source link

Uses the latest Gavel API #19

Closed artem-zakharchenko closed 5 years ago

artem-zakharchenko commented 5 years ago

Changes

Adjusts internals to use the latest Gavel API (version 7)
Changes the public API:

new Gavel2Html({
- dataReal
- dataExpected
- gavelResult
+ fieldName: string
+ fieldResult: FieldValidationResult
})

dataReal and dataExpected internal pointers are kept, but proxy fieldResult.values instead

Motivation

Simplify the usage of gavel2html by reducing the surface of coercion on the usage level.
Acknowledge Gavel API changes and adapt internals of gavel2html (which also simplifies it)

Roadmap

[x] Adjust tests, since fixtures use the legacy Gavel API

artem-zakharchenko commented 5 years ago

Thank you! Comments addressed, PR updates. Please see once more 🙏

honzajavorek commented 5 years ago

Don't forget to push with --tags. Let me know when you merge this so I can make the release.