ExpressionEngine 2.61 Sublime Text 3 Bundle

ExpressionEngine 2 support package for Sublime Text 2 & 3 that also supports the jQuery bundle syntax when inside of <script> tags.

PLUS:

• Highlighting for built-in EE adddon tags (exp:channel, exp:comment, etc) and their parameters (and unlike with primitive syntaxes, mistyped parameter names are easily identified)

• Highlighting for variables of built-in addon tags ({file_url}, {total_results} etc) - mistyped variable names are also easily identified

• Improved handling of EE comments:

• (does not highlight/color code blocks contained within EE comments)

• (recognizes EE comments within quoted strings)

• (recognizes EE comments and tags within Javascript blocks)

• (recognizes EE comments and tags within PHP blocks)

• Highlighting for EE module attributes (channel=, limit=, etc)

• Highlighting for EE global variables ({site_name}, {user_name}, etc)

• Highlighting for EE constants ({DATE_ATOM}, etc)

• Highlighting for EE conditionals (if:else, if:elseif, if)

• Highlighting for deprecated EE tags (marked as "invalid.illegal")

Notes

You must install the jQuery bundle (mentioned above) to take full avantage of this package.

The HTML5 package for ST may override this package and prevent proper highlighting.

Grammar forked, overhauled and expanded by fcgrx from [imjared's ExpressionEngine2-Sublime-Text-Bundle][https://github.com/imjared/ExpressionEngine2-Sublime-Text-Bundle], which had this note:

Forked and only slightly modified from [Wes Baker's EE 2 TextMate Bundle][https://github.com/wesbaker/ExpressionEngine2.tmbundle], which had this note:

A reworked version of Tim Kelty's ExpressionEngine bundle, updated to work with ExpressionEngine 2.0.

Installation

1. Click the Downloads button at the top right of this page.
2. Choose the zip file.
3. Once downloaded, unzip the the zip file.
4. If you're looking at a folder, rename it to ExpressionEngine. If you're looking at a set of files, create a new folder named ExpressionEngine and put the files in.
5. Copy the folder to ~/Library/Application Support/Sublime Text 2/Packages/ (make sure this is the Library inside your home folder, not the one in the root of your hard drive)

Use a good color theme

To take full advantage of the extended syntax highlighting available with this package, you will want to use a full-featured Sublime Text color theme. Specifically, your theme should assign unique styling to the following scopes:

• entity.function
• entity.other
• invalid
• keyword.control
• keyword.operator
• support.constant
• support.function
• support.variable
• variable
• variable.parameter

More comprehensive coloring can be accomplished by also assigning styling to these more specific scopes:

• ee.tag.html (the entire tag)
• entity.function.addon.ee (user-defined addon)
• entity.other.attribute-name.user.ee (user-defined attribute)
• entity.other.attribute-name.predefined.ee (built-in / system attribute)
• invalid.illegal (grammatical errors)
• invalid.deprecated.ee (deprecated tags)
• keyword.control.ee (conditional)
• keyword.operator.logical.ee (logical operator)
• punctuation.definition.tag.begin.ee (tag begin)
• punctuation.definition.tag.end.ee (tag end)
• support.constant.ee (constant)
• support.function.addon.ee (built-in addon)
• support.variable.language.ee (built-in global variable)
• variable.parameter.ee (parameter)
• variable.other.ee (user-defined variable)

A starter color theme with all these scopes installed is available here:

https://github.com/fcgrx/fcgrx-dark-color-theme-sublime-text-and-textmate

Remaining issues with the highlighting syntax

A list of shortcomings with this syntax definition (and test cases for each) is included in the file "known_problems.html".

Many of the problems below have to do with nesting multiple syntaxes, and could probably be fixed with grammar injection if Sublime Text supports it.

I'd be happy to incorporate solutions to these problems (and any other improvements); please initiate a pull request, or just contact me directly.