Support copy-pasting schema changelog validation errors
Closed this issue · 7 comments
In simple cases, the pretty-printed schema changelog validation error messages are in exactly the right format to copy-paste back into the changelog, which is very convenient. However, some manual editing may be required. Some simple changes could reduce the need for this:
- include
default ...clause where required - sort missing types and components in reverse dependency order
- include
|symbols when printing new unions/enums
Another silly case: the type of booleans is rendered as bool but parsed as boolean. QuickCheck round-tripping, perhaps?
Yes indeed -- it is very close; I cannot think of any other edits that I make in updating change log.
Yet another case: when using a keyword (like version) as a record field name, quotes are required by the parser ('version'), but not printed.
Yes of course.
Following #46 the only cases I'm aware of in which the changelog cannot be copy pasted are things that require manual intervention anyway: missing default values, and incompatible definitions of schema types.
@adamgundry shall we close this?
Perhaps we should. 😄