hashicorp/consul

Supporting syntax highlighting for TOML-formatted values when viewing KV in the Consul GUI

Open

#12,668 opened on Mar 31, 2022

View on GitHub
 (7 comments) (1 reaction) (0 assignees)Go (29,891 stars) (4,588 forks)batch import
good first issuehelp-wantedtheme/kvtheme/uitype/enhancement

Description

Many people store configuration files in toml format and it will be useful to add support for this format

Contributor guide

Tech stack
javascriptcss
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.
1-3 hours
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
JavaScript knowledgeConsul GUI development setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Investigate how syntax highlighting is currently implemented in the Consul GUI codebase, likely through a library like highlight.js or Prism. Locate the configuration or file where language definitions are registered, and add TOML. Test the addition in the development environment. If no existing highlighter is used, consider integrating one. Refer to any existing PRs or comments for guidance; no linked PRs yet.
Supporting syntax highlighting for TOML-formatted values when viewing KV in the Consul GUI · hashicorp/consul#12668 | Good First Issue