-
Notifications
You must be signed in to change notification settings - Fork 72
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
🐛 Fix options key present with parts during JB 1 upgrade #1799
base: main
Are you sure you want to change the base?
🐛 Fix options key present with parts during JB 1 upgrade #1799
Conversation
In JB 1, including the top-level options key with parts has no effect. However, it doesn't throw an error in JB 1, so we prefer to remove it and warn rather than erroring.
|
numberted: z.boolean(), | ||
numbered: z.boolean(), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Brilliant catch!
We definitely should loosen the strictness of TOC handling during upgrade. However, I think the proper solution is to do this in the validation step: mystmd/packages/myst-cli/src/init/jupyter-book/toc.ts Lines 172 to 176 in fad8f67
I will circle around to this shortly. |
Thanks! I'd written to Rowan on discord, I tried to find a way to get Zod to issue a warning, but it doesn't really support that: https://discord.com/channels/1083088970059096114/1177359316886503464/1331659677485891664 |
Closes #1796