josdejong/jsoneditor

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

Open

#1,443 建立於 2022年6月14日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)JavaScript (10,781 star) (2,034 fork)batch import
featurehelp wanted

描述

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

貢獻者指南

技術棧
javascript
領域
tooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
3-5 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Basic JavaScriptJSON parsingACE editor basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Review the previous implementation in PR #1435 and the related comment. Approach 3, integrating with ACE editor's JSON parser to use its internal AST, is recommended. Prototype by modifying the auto completion logic to parse partial JSONs using jsonrepair or partial json parser, ensuring suggestions align with cursor position. Test with various malformed JSONs.