Replace json parser with jsonc. #1147
Conversation
| @@ -5799,6 +5799,11 @@ json5@^2.1.2, json5@^2.2.0: | |||
| dependencies: | |||
| minimist "^1.2.5" | |||
|
|
|||
| jsonc-parser@^3.0.0: | |||
There was a problem hiding this comment.
Does Monaco depend on some jsonc parser already that we could use?
There was a problem hiding this comment.
It looks like Monaco depends on the same jsonc-parser package: https://github.com/microsoft/monaco-editor/blob/7826dee4ea80e7e4542db6934593e370f2305d97/package.json#L43. I think the jsonc-parser interface is a lot more straightforward than the Monaco interface, but it might be possible to wrap Monaco.
There was a problem hiding this comment.
It's a dev dependency in Monaco.
I'm asking since I would have expected the dependency to already be in the lock file.
There was a problem hiding this comment.
ah I see! yeah I didn't realize that
There was a problem hiding this comment.
Looks good to me! Thanks for addressing this long-running feature request @joshpoll!! My one minor comment is whether we could use a more descriptive alias than parse for the jsonc import? There's a lot of parsing happening in the editor, so a more distinctive name would help readability/understandability when people come back to the code base.
|
@arvind I changed the parse import names |
This PR replaces the JSON parser with JSONC. JSONC is an extension of the JSON spec that includes comments and trailing commas. It's supported by Microsoft and used in Monaco and VSCode.
This should provide a significant quality-of-life improvement for people using the editor.
It's still possible to export and share JSON specs, and this is the default behavior. Users can opt-in to JSONC specs when sharing by clicking the "Preserve whitespace, comments, and trailing commas" button.