norad v1

[chrissimpkins]

[List is being developed, this is not complete]

Collection of issues to reach v1 release status

• Verify we have all validators from ufoLib on board. Component circular reference checking (from UFO implementation checklist #31)
• Enforce use of name Strings without control characters (from UFO implementation checklist #31, tracker Stricter names for things #191)
• More complete user name to filename conversion (from UFO implementation checklist #31, tracker Extend crate::glyph::default_file_name_for_glyph_name to reference algorithm #85)
• Better error reporting
  • Point out glyph name in error message when contents.plist points to glif file that does not exist #137
• review / stabilize the serialization format
• Add changelog #194
• Review/expand/clarify source documentation and add the docs.rs doc link to repo README (Update public API docs #197)
• Update code to take advantage of newer plist crate (Update rust-plist, use new features #145)
• Check we prevent downgrades (Error out if trying to save UFO version != 3 or glif version != 2 #25)

Feel free to edit the list in this post.

[madig]

I think the "Very nice to have" section is not strictly necessary for 1.0, except maybe for the error types. Those are desirable.

[chrissimpkins]

I'll pull out remaining elements from that list into the one above. Please feel free to edit the OP directly with your thoughts.

[chrissimpkins]

I'll pull out remaining elements from that list into the one above.

done

[madig]

@cmyr you wrote on Zulip:

So the main question is, "what decisions are we unsure of?". One I can think of is the big FontInfo struct, which we might prefer to have be a dict (for instance)

what other things can you think of? My other idea was custom plist ser/de code to drop the slow xml-rs dependency, or maybe we want this upstream?

[chrissimpkins]

I started source documentation updates in #197

[madig]

Opinions on #202 and #203?

[madig]

I want to review our error architecture. Articles I need to ruminate about:

• https://www.unwoundstack.com/blog/rust-error-handling.html
• https://www.lpalmieri.com/posts/error-handling-rust/
• https://kazlauskas.me/entries/errors

[madig]

Closing this after closing #31. There's grand stuff left to do, but no manpower to do it right now. Let's use https://github.com/linebender/norad/milestone/2 to track progress to a 1.0.