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

Splunk Conf File Syntax Highlighting

by Shakeel Mohamed ST2/ST3

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

Labels language, syntax

Details

Installs

  • Total 2K
  • Win 822
  • OS X 700
  • Linux 317
May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10
Windows 0 0 2 2 0 0 2 2 2 1 4 4 1 0 3 7 6 2 1 2 0 3 3 1 4 0 0 2 2 0 1 1 1 1 1 4 0 1 3 3 0 0 1 2 1 3
OS X 1 2 2 0 1 0 0 0 0 0 1 1 0 0 2 0 0 2 1 1 0 2 0 1 0 3 2 0 0 3 0 2 1 0 0 2 1 3 0 0 0 0 2 4 0 1
Linux 1 0 1 0 2 2 0 2 0 0 1 1 0 0 0 0 4 2 1 0 1 0 0 0 1 1 0 0 0 4 0 1 0 0 1 3 0 0 0 0 0 0 0 1 0 1

Readme

Source
raw.​githubusercontent.​com

Sublime Text syntax highlighting for .conf files

Build Status

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.