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

[Spike] JSON Schema generation #817

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

[Spike] JSON Schema generation #817

wants to merge 3 commits into from

Conversation

jeremywiebe
Copy link
Collaborator

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 the PerseusItem 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:

@jeremywiebe jeremywiebe self-assigned this Nov 25, 2023
Copy link
Contributor

github-actions bot commented Nov 25, 2023

Size Change: +681 B (+0.08%)

Total Size: 836 kB

Filename Size Change
packages/perseus-editor/dist/es/index.js 267 kB +69 B (+0.03%)
packages/perseus/dist/es/index.js 401 kB +612 B (+0.15%)
ℹ️ View Unchanged
Filename Size
packages/kas/dist/es/index.js 38.1 kB
packages/kmath/dist/es/index.js 4.27 kB
packages/math-input/dist/es/index.js 80.5 kB
packages/math-input/dist/es/strings.js 1.73 kB
packages/perseus-core/dist/es/index.js 908 B
packages/perseus-error/dist/es/index.js 878 B
packages/perseus-linter/dist/es/index.js 21.8 kB
packages/perseus/dist/es/strings.js 3.22 kB
packages/pure-markdown/dist/es/index.js 3.68 kB
packages/simple-markdown/dist/es/index.js 12.4 kB

compressed-size-action

Copy link

codecov bot commented Apr 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.26%. Comparing base (896a159) to head (a8effba).
Report is 18 commits behind head on main.

❗ Current head a8effba differs from pull request most recent head 44f1a83. Consider uploading reports for the commit 44f1a83 to get more accurate results

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     

Impacted file tree graph

see 148 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 896a159...44f1a83. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant