-
Notifications
You must be signed in to change notification settings - Fork 351
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
[Spike] JSON Schema generation #817
base: main
Are you sure you want to change the base?
Conversation
Size Change: 0 B Total Size: 864 kB ℹ️ View Unchanged
|
4e696b3
to
d256374
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #817 +/- ##
==========================================
+ Coverage 69.08% 70.26% +1.18%
==========================================
Files 472 477 +5
Lines 101103 101326 +223
Branches 7216 10890 +3674
==========================================
+ Hits 69843 71200 +1357
+ Misses 31082 30126 -956
+ Partials 178 0 -178 see 148 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
44f1a83
to
89cf6d1
Compare
npm Snapshot: PublishedGood news!! We've packaged up the latest commit from this PR (89cf6d1) and published it to npm. You Example: yarn add @khanacademy/perseus@PR817 If you are working in Khan Academy's webapp, you can run: ./dev/tools/bump_perseus_version.sh -t PR817 |
Summary:
SPIKE: DO NOT MERGE
While watching the Perseus Data Format meeting recording, I remembered an idea that we've batted around to generate a JSON Schema for our Perseus data format using the existing Typescript types.
This PR introduces a package.json script
gen:schema
which generates a JSON schema for thePerseusItem
type as a proof of concept.This wouldn't address all of our API needs, but it might help with external partners who consume the Perseus data format.
Issue: 'none'
Test plan: