PrismJS/prism

Language Request: ssh-config

Open

#3444 opened on Apr 30, 2022

View on GitHub
 (3 comments) (7 reactions) (0 assignees)JavaScript (11,488 stars) (1,296 forks)batch import
good first issuelanguage-definitionsnew language

Description

Language This is the configuration file for sshd found inside ~/.ssh/config on most systems.

Additional resources I found this issue that seems to have done the same thing for linguist which drives GitHub syntax highlighting - wondering if it can be added in Prism which drives syntax highlighting in my favourite MD editor (Obsidian).

EDIT: Additionally, some regex from https://github.com/Alhadis/language-etc/blob/master/grammars/ssh-config.cson may be reusable - can't be sure because I don't know the language, perhaps someone else can take a look.

Notes If this syntax highlighting engine already exists (and I simply didn't find it), this request could be changed to be a request for an official alias to ssh-config to get some consistency for the same code uploaded to different platforms with different syntax highlighting engines.

Contributor guide

Tech stack
javascriptshell
Domain
developer experience
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-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
Regex knowledgeSSH config syntaxPrism language definition structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the linked linguist issue (#3450) and the grammar file from Alhadis/language etc to understand SSH config syntax. Then create a new Prism language definition in components/prism languages/ssh config.js, following the pattern of existing languages like 'ini' or 'bash'. Test with various SSH config examples found online. Update the language list and table in the repository accordingly, and consider adding an alias 'ssh config' if needed.