Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve the format used to store type information. #81

Merged
merged 6 commits into from
Dec 3, 2023

Conversation

lenscas
Copy link
Owner

@lenscas lenscas commented Dec 3, 2023

This basically completely changes the format
though it should be backwards compatible
with the old format for readers.

The old format was very biased towards
to teal's syntax and focused on layout.

This made it very hard to create definition files
for anything other than teal.

It also made it very hard to get any meaningful
information out of the types without parsing

And to top it off, forced the writer of the type
to care about formatting/how the type ends
up being laid out as.

The new format fixes this by only focusing on
the types and what for type it is. Rather than
allowing people to inject syntax in the type definitions.

There is however a function to turn the new format
into the old one and the old format is still included.

So, for as long as readers don't mind extra fields they
should be able to keep using the old fields as normal.

This basically completely changes the format
though it should be backwards compatible
with the old format for readers.

The old format was _very_ biased towards
to teal's syntax and focused on layout.

This made it very hard to create definition files
for anything other than teal.

It also made it very hard to get any meaningful
information out of the types without parsing

And to top it off, forced the writer of the type
to care about formatting/how the type ends
up being laid out as.

The new format fixes this by only focusing on
the types and what for type it is. Rather than
allowing people to inject syntax in the type definitions.

There is however a function to turn the new format
into the old one _and_ the old format is still included.

So, for as long as readers don't mind extra fields
they should be able to keep using the old fields as
normal.
@lenscas lenscas merged commit a8872b3 into master Dec 3, 2023
18 checks passed
@lenscas lenscas deleted the feature/better_format branch December 3, 2023 23:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant