envoyproxy/envoy

VSCode syntax extension

Open

#13,078 opened on Sep 14, 2020

View on GitHub
 (20 comments) (25 reactions) (0 assignees)C++ (5,373 forks)batch import
area/configurationarea/docshelp wantedpriority/high

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Intellisense for envoy configuration files (yaml)

Having to lookup keywords in documentation causes a slower developer feedback loop. yaml indentation can also be be a challenge to get right at first attempt with deeply nested structures.

Intellisense can help you quickly get feedback on which keywords are available, which also tells you which "depth" you are at within the yaml tree structure.

An example of an extension like this is the Kubernetes extension for VSCode - providing intellisense for Kubernetes resource definition files (which also uses yaml files)

Relevant links

Contributor guide

Research direction
Explore the yaml language server and vscode kubernetes tools repositories to understand pattern for implementing IntelliSense for Envoy YAML config. Then create a VSCode extension using TypeScript that provides autocompletion and validation based on Envoy's configuration schema.
Tech stack
typescriptjavascriptnodejs
Domain
developer experiencetooling
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.
1-2 days
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
GitTypeScriptVSCode extension development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60