josdejong/jsoneditor

Syntax highlighting for JMESPath queries

Open

#1,451 opened on Jul 7, 2022

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

Description

A recent PR to pygments added the support for JMESPath highlighting.

A functional demo is found here: https://pygments.org/demo/

It would be a great addition to have that syntax highlight support, specially when writing complex queries.

Contributor guide

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.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic JavaScriptcodebase navigation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Start by examining the current syntax highlighting implementation in jsoneditor (likely in the source code for JSON highlighting). Look for how the editor registers highlighters and integrates with CodeMirror or similar. Then research available JavaScript libraries for JMESPath syntax highlighting or consider writing a simple tokenizer. The pygments PR referenced provides a grammar that can be adapted to JavaScript. Test with the demo query from pygments to ensure correctness.