artilleryio/artillery

Artillery support for text editors

Open

#176 opened on Sep 21, 2016

View on GitHub
 (3 comments) (1 reaction) (0 assignees)JavaScript (7,057 stars) (504 forks)batch import
help wanted

Description

It would be nice to have syntax highlighting for Artillery scripts (YAML and possibly JSON).

It should be pretty straightforward to modify an existing mode for YAML, adding highlighting for templates ({{ }} and {{{ }}}) and various actions (get, post, emit for Socket.io etc).

  • Sublime
  • Emacs
  • Vim

Contributor guide

Tech stack
None
Domain
toolingdeveloper experience
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Text editor plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
To implement syntax highlighting for Artillery scripts, start by examining existing YAML syntax modes for each editor (Vim, Emacs, Sublime). Modify the mode to recognize Artillery specific template syntax ({{ }}, {{{ }}}) and action keywords (get, post, emit). For Vim, look at the built in yaml.vim; for Emacs, yaml mode.el; for Sublime, YAML syntax definition. Add highlighting rules accordingly. No linked PRs or maintainer questions.