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 3K
  • Win 1K
  • OS X 973
  • Linux 457
Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9 Mar 8 Mar 7 Mar 6 Mar 5 Mar 4 Mar 3 Mar 2 Mar 1 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8 Feb 7
Windows 0 0 2 1 1 0 3 1 0 3 1 4 3 3 0 0 2 2 3 0 2 1 0 0 3 2 3 1 1 1 0 3 3 1 5 0 0 0 4 2 1 1 2 0 1 2
OS X 0 0 0 2 0 0 0 2 0 1 1 1 1 1 0 1 0 1 1 1 2 0 0 0 5 3 4 2 0 0 2 0 1 0 1 0 0 0 2 0 3 0 0 1 0 1
Linux 0 0 1 0 1 0 0 0 0 0 1 0 1 0 1 2 0 1 2 2 1 0 0 1 2 1 0 1 0 0 1 1 2 0 0 0 0 1 0 3 3 0 0 0 0 2

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.