ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

KDL

by eugenesvk ST4

KDL syntax highlighting for Sublime Text

Details

Installs

  • Total 25
  • Win 1
  • Mac 12
  • Linux 12
Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0
Mac 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

A Sublime Text 4 syntax highlighting package for the KDL cuddly document language

Introduction

This package adds support for the KDL document language (for files with .kdl extension)

Install

  • Via Package Control: open Command PalettePackage Control: Install Packagekdl
                                            Ctrl/⌘Cmd⇧ShiftP

  • Manually: clone this repository to your Packages directory and rename it to kdl

cd /path/to/sublime/packages/directory
git clone https://github.com/eugenesvk/sublime-kdl.git
mv sublime-kdl KDL
  • Your color scheme likely needs to be patched to ignore or take full advantages of the /-slashdashed comment blocks:
    Patched examples used for the screenshots below: solarized, default
    • to style /-slashdashed elements with muted colors:
    • add -comment to your scopes, e.g., {"name":"Tag name","foreground":"var(blue6)","scope":"entity.name.tag -comment"},
    • add a copy of the same rule with an extra comment scope and a blending color function, e.g., {"name":"Tag name C","foreground":"color(var(blue6) blend(#000 60% hsl))","scope":"entity.name.tag comment"},
    • to style /-slashdashed elements like regular comments add comment.line.slash-dash.kdl scope to your Comment rule (e.g., {"name":"Comment","foreground":"black","scope":"comment, comment.line.slash-dash.kdl"},) so that its 4 level specificity overrides other rules like entity.other.attribute-name

Use

Open any kdl file (e.g., syntax_example_screen.kdl) and verify that the selected syntax is KDL and KDL-specific contexts are properly scoped[1] and highlighted, maybe like so (depending on your color scheme):

[1]: scope naming is supposed to conform to ST's scope naming guidelines

Exposed scopes

List of scope names

| KDL construct | Scope name | :———— | :———- | Entity | entity.name. tag.node¦type
entity.other.attribute-name .kdl | Elemens | meta. node¦block.child¦argument.value¦property. ¦name¦separator¦value .kdl | Mappings | meta.mapping. key¦separator¦value
punctuation.separator.key-value punctuation.section.mapping. begin¦end .kdl | Number | constant.numeric. decimal¦float¦integer. ¦binary¦octal¦hexadecimal
constant.numeric. base¦exponent¦significand¦value
punctuation.separator. decimal¦exponent¦number .kdl | String | meta.string storage.type.string string.quoted.double. ¦raw
punctuation.definition.string. begin¦end .kdl | Comment | comment.block comment.block.documentation comment. block¦line. double-slash
punctuation.definition.comment. begin¦end .kdl | Annotation | meta.annotation punctuation.separator.annotation. begin¦end .kdl | Others | constant.character. escape¦escape.unicode.16-bit-hex
constant.language. boolean¦null
keyword. other¦operator.arithmetic punctuation.separator.continuation.line punctuation.terminator.node
invalid.illegal. ¦muted¦position¦muted.position .kdl

Keybindings

This plugin adds two keybindings for the kdl scope: "/' that auto-pair double/single quotes even after string modifiers

Add "kdl.keybind_disable":true to your Preferences.sublime-settings to disable

Known issues

  • Only works in Sublime Text 4 since build 4075 (10 July 2020) since it's using version 2 of the syntax

Credits

The default packages' syntax files (Python, Bash, PHP), as well as fish and vscode-kdl