rouge-lexer-spl

A Rouge lexer plugin for Splunk's Search Processing Language (SPL). Rouge is the default syntax highlighter for Jekyll (and therefore GitHub Pages). This gem adds SPL support to Rouge.

Install the gem directly:

gem install rouge-lexer-spl

Or add it to your Gemfile:

gem 'rouge-lexer-spl'

Then run:

bundle install

Once installed, Rouge will automatically discover the lexer. You can use spl, splunk, or splunk-spl as the language tag in fenced code blocks:

```spl
index=web sourcetype=access_combined | stats count by status
```

Add the gem to your site's Gemfile inside the :jekyll_plugins group:

group :jekyll_plugins do
  gem "rouge-lexer-spl"
end

Run bundle install, then use ```spl fences in your posts and pages. Jekyll will pick up the lexer automatically via Rouge's plugin discovery.

The lexer tells Rouge how to identify tokens. Rouge wraps each token in a span tag with a class related to that token type. If you want to change how the tokens are highlighted, change themes or add custom CSS.

Install dependencies:

bundle install

Run the test suite:

bundle exec rake

Start the visual preview server (available at http://localhost:9292):

bundle exec rake server

Run the terminal preview script:

ruby preview.rb

Enable debug mode to print each token and its value:

DEBUG=1 ruby preview.rb

1. Run bundle exec rake to check for test failures and error tokens.

2. Start the server with bundle exec rake server.

3. In another terminal, check for error tokens in the rendered output:

   curl -s http://localhost:9292 | grep 'class="err"'

4. Fix any error tokens in lib/rouge/lexers/spl.rb.

5. Repeat until no error tokens remain.

MIT