🔧 Tighten up JSON input #1405
🔧 Tighten up JSON input #1405
Conversation
| opts, | ||
| ); | ||
| // Although this is required, we'll set it to an empty article by default | ||
| const mdast: GenericParent = value?.mdast ?? { type: 'root', children: [] }; |
There was a problem hiding this comment.
Is this a reasonable thing to do? Declare this mdast property required, but add a default? I did this so that we don't need to throw an error in this function.
There was a problem hiding this comment.
Although maybe throwing an error (or at least returning undefined) would be better?
Both of these results are handled gracefully in the loadFile function where this is called, and then we wouldn't end up persisting and processing this likely erroneous empty page?
|
@rowanc1 this follows from our meeting, and fixes the frontmatter. |
| file: vfile.path, | ||
| messages: {}, | ||
| errorLogFn: (message: string) => { | ||
| fileError(vfile, message, { ruleId: opts?.ruleId ?? RuleId.mystJsonValid }); |
There was a problem hiding this comment.
The name of the rule ID follows our existing convention.
|
@fwkoch friendly ping! :) |
| opts, | ||
| ); | ||
| // Although this is required, we'll set it to an empty article by default | ||
| const mdast: GenericParent = value?.mdast ?? { type: 'root', children: [] }; |
There was a problem hiding this comment.
Although maybe throwing an error (or at least returning undefined) would be better?
Both of these results are handled gracefully in the loadFile function where this is called, and then we wouldn't end up persisting and processing this likely erroneous empty page?
🦋 Changeset detectedLatest commit: bdad6fc The changes in this PR will be included in the next version bump. This PR includes changesets to release 6 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Fab! Thanks @fwkoch, will merge this in! |
This PR adds some validation for JSON-file input, and applies our frontmatter transforms.