fix: support schema content with pathy fileName#522
Open
aloisklink wants to merge 1 commit intoadobe:mainfrom
Open
fix: support schema content with pathy fileName#522aloisklink wants to merge 1 commit intoadobe:mainfrom
fileName#522aloisklink wants to merge 1 commit intoadobe:mainfrom
Conversation
Prevent an `ENOENT` error when running `jsonschema2md` on a JSON Schema that doesn't exist on disk, yet has a pathy `fileName`. Using a `fileName` that is a path is required to get working links to the `schema.json` file in the output Markdown.
Codecov Report
@@ Coverage Diff @@
## main #522 +/- ##
=======================================
Coverage 99.75% 99.75%
=======================================
Files 11 11
Lines 2039 2039
=======================================
Hits 2034 2034
Misses 5 5
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
This file contains hidden or 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
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.
Prevent an
ENOENTerror when runningjsonschema2mdon a JSON Schema that doesn't exist on disk, yet has a pathyfileName.Using a
fileNamethat is a path is required to get working links to theschema.jsonfile in the output Markdown.Current behavior
The
Public API with non-existent schema path workstest (added in this PR) currently fails with the following error.Background
I'm trying to simplify some code in https://github.com/mermaid-js/mermaid/blob/b87f1f209843ed794d83bfece5669adf595bdabd/packages/mermaid/scripts/docs.mts#L393-L420 to use the official
import {jsonschema2md} from ...API, since it currently uses a bunch of internals.