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

Splunk Conf File Syntax Highlighting

by Shakeel Mohamed ALL

Syntax highlighting for Splunk .conf files in Sublime Text 2 & 3

Labels language, syntax

Details

Installs

  • Total 6K
  • Win 3K
  • Mac 2K
  • Linux 1K
Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 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
Windows 0 2 0 1 0 0 1 0 0 3 0 0 0 0 0 0 1 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 1 0 1
Mac 0 1 0 0 0 1 0 2 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 2 0 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 0 0 0 0 0 0 0 1 0 0

Readme

Source
raw.​githubusercontent.​com

Sublime Text syntax highlighting for .conf files

Sublime Text is awesome! But, there's no great way to get syntax highlighting for a Splunk .conf file… until now!

It works with Sublime Text 2 & 3!

Before

before

After

after

Installation

  • Install it from Package Control - search for Splunk Conf File Syntax Highlighting

Manual Installation

  • Clone the repo
  • cd sublime-splunk-conf-highlighting

Sublime Text 2

  • cp splunk-conf.tmLanguage ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/user/splunk-conf.tmLanguage

Sublime Text 3

  • cp splunk-conf.tmLanguage ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/user/splunk-conf.tmLanguage

Patterns

Patterns are used to identify some part of a file.

Patterns used by this package:

  • ^# DO NOT EDIT THIS FILE\\!$ - marks any lines as invalid if they are # DO NOT EDIT THIS FILE!
  • ^#.*$ - marks any lines that start with # as a comment
  • ^\\[.*\\]$ - marks any line starting with [ and ending with ] as a stanza
  • ^[\\w+\\.\\-\\:]+ - marks the beginning of a line as a conf key; defined by any whitespace, alphanumeric, - or : characters
  • = - marks any = as an equals sign

Patterns have 3 main attributes:

  • match (or, begin and end): regex patterns
  • name: a TextMate language grammar group, comment.line for an inline comment
  • comment: a comment about the pattern

Resources

Development Notes

There are 2 important files here:

  • splunk-conf.YAML-tmLanguage - The AAAPackageDev package compiles this to the following, this YAML file is much easier to use

  • splunk-conf.tmLanguage - This is a TextMate language definition file in XML format. SublimeText uses this format, it's a necessary evil.

  • Install package control if you haven't already

  • cmd + shift + P (Mac) or ctrl + shift + P (Windows)

    • Install package
    • AAAPackageDev

  • Open splunk-conf.YAML-tmLanguage

  • cmd + B should update splunk-conf.tmLanguage, make a small change and see if it worked. If not, play with your build system settings under Tools -> Build System

  • During development you'll need to constantly copy the splunk-conf.tmLanguage into your Sublime Text package folder, like so: cp splunk-conf.tmLanguage ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/user/splunk-conf.tmLanguage

  • If something doesn't seem to update, quit & reopen Sublime Text and it should work.