sjson.vim

sjson.vim provides syntax highlighting to the simplified JSON ("SJSON") file format used by the Bitsquid engine.

Installation

Install via your plugin manager or method of choice. There are no special installation requirements.

Detecting SJSON Files

Most SJSON files don't actually use the .sjson extension. Instead they are named according to the type of object they represent in the engine. This complicates filetype detection, as the extensions in practice often conflict with other common extensions (and individual projects may have unique extensions that this plugin cannot account for).

Generally, all the SJSON files for a given project are underneath a particular directory. Thus, you can assume all files under that directory are SJSON and encode that assumption in your .vimrc:

augroup set_sjson_filetype
  autocmd!
  autocmd BufRead,BufNewFile ~/your/project/data/path/* set filetype=sjson
auground end

Highlight Groups

sjson.vim defines the following highlight groups.

• sjsonKeyword (keywords like null, true and false)
• sjsonComment (comments, which are C++-style; C-style comments are not yet supported)
• sjsonBracket (opening and closing square brackets)
• sjsonBrace (opening and closing curly braces)
• sjsonEquals (the assignment operator)
• sjsonComma (the comma)
• sjsonNumber (numbers)
• sjsonString (characters enclosed in double quotes)

These are initially all linked to standard highlight groups; if you want to provide custom highlighting you can override the group in your own .vimrc. For example, if you want to make commas (which are optional in SJSON) really stand out, you could put

highlight sjsonComma guifg=#ff0000 gui=bold

somewhere in your .vimrc