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.
Fixes (for supporting
""" Comments """
)SDLView.tsx
forSDLView.tsx
Background:
The major issue was that the
printSchema()
function was not converting commentsi.e
""" Some Comment"""
to a description
i.e
# Some description
The
addLinebreak()
function was replacing the#
token, not the"""
token. Which is what lead to the syntax highlighting for the Codemirror component reading the comments as an invalid character.Also the cause for why the
commentsDisabled
property may not have worked for those using the"""
method of commenting on their schemas.Screenshots 📸 🖥
Changes proposed in this pull request:
Added default params to
getSDL(..., commentsDisabled: boolean = true)
Added default argument of true for
printSchema(..., commentDescriptions: boolean = true)
Tested on Electron & React app.
Note
I'm not sure how versioning works with the electron & react apps, but I tested this via
yarn link