⚙️ Use simple validators in TOC #1172
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rowanc1
reviewed
Apr 30, 2024
| "test:watch": "vitest watch", | ||
| "build:esm": "tsc", | ||
| "build:schema": "npx ts-json-schema-generator --path src/types.ts --type TOC -o ./src/schema.json", |
There was a problem hiding this comment.
I feel like we could keep this around, even if we aren't using it?
There was a problem hiding this comment.
Sure but we don't publish it yet. I'm thinking let's add it later?
fwkoch
requested changes
May 1, 2024
packages/myst-toc/src/toc.ts
Outdated
| outputEntry.file = validateString(outputEntry.file, incrementOptions('file', opts)); | ||
|
|
||
| outputEntry = validateCommonEntry(outputEntry, opts); | ||
| if (!outputEntry) { |
There was a problem hiding this comment.
Don't think this is possible with how validateCommonEntry is defined (see the corresponding type updates I made).
agoose77
force-pushed
the
agoose77/refactor-use-simple-validators
branch
2 times, most recently
from
f20ce45 to
3d3e914
Compare
Co-authored-by: Franklin Koch <[email protected]>
Co-authored-by: Franklin Koch <[email protected]>
agoose77
force-pushed
the
agoose77/refactor-use-simple-validators
branch
from
2018149 to
ad50fcc
Compare
rowanc1
reviewed
May 7, 2024
fwkoch
approved these changes
May 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As we want to integrate TOC validation with our config system, and raise informative errors, this PR drops schema generation in favour of explicit imperative validation (until we get around to moving to a schema/ORM based approach).