josdejong/jsoneditor

Make auto-completion by schame to work with non-valid JSONs

Open

#1,443 opened on Jun 14, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (2,034 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (10,781 stars)
PR merge metrics
 (Avg merge 15h 36m) (3 merged PRs in 30d)

Description

This issue is a continue of #968 which was implemented on change #1435

The current implementation is limited to work only with valid JSONs, as described in the change request comment.

This is a hard limitation, as usually we want to have the auto-complete suggestions while editing the JSON, and it is likely to be a non-valid while typing its content.

There has being some suggestions how to resolve it:

  1. straight forward approach:  try to figure out the missing part and fix it on-the-fly, like removing/fixing the current line and try again - this might not cover every use case but might be sufficient for most of the common use cases
  2. use external packages like jsonrepair or partial-json-parser to repair/parse the non-valid JSON - this might be challenging as it might not be aligned wit the current cursor location on the document, so the result can be wrong suggestions
  3. find a way to Integrate with the ACE editor JSON parser, and perhaps use the internal AST to understand the current path of the cursor location

Contributor guide

Research direction
Explore approaches to parse partial JSON, such as using jsonrepair or partial json parser, and integrate with ACE editor's parser to provide autocomplete suggestions based on cursor path.
Tech stack
javascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptJSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45