October CMS Twig Highlighter

This package adds syntax definitions for the October CMS Twig engine. Support is available for Sublime Text, Visual Studio Code and all JetBrains IntelliJ IDEs.

Visual Studio Code

How to install with VS Code

Search for October Twig and install the package. You can then select "October CMS Template" from the available syntax list.

If you would like the INI syntax to be enabled, ## must be at the beginning of the template file. For example:

##
url = "/blog"
layout = "default"
==
<?
function onStart() { /* ...*/ }
?>
==
<h1>Page Title</h1>

{% for post in posts %}
    <h4>{{ post.title }}</h4>
    {{ post.content}}
{% endfor %}

How to Contribute

• Intall this extension
• Open the %USERPROFILE%\.vscode\extensions directory
• Modify the extension files
• Reload the window to test

VS Code Configuration

Add these lines to your VS Code settings to associate HTM files as October Twig syntax. These settings can also be used to get Emmet working.

"files.associations": {
    "*.htm": "october-htm"
},
"emmet.includeLanguages": {
    "october-htm": "html"
}

Sublime Text

Uses .sublime-syntax files that works with Sublime Text 3 and newer.

How to install with Sublime Package Control

Search for October Twig and install it, it's just that simple.

Restart Sublime Text after you install this package.

Sublime Text Manual Install

• Download or clone this repository into [install-dir]/Packages/october-twig
• Restart Sublime Text.

How to Contribute

• To test a local version of the highlighter first uninstall the highlighter from package control.
• Follow the manual installation process by cloning the repo into your packages directory.
• Restart Sublime Text.
• Open up the '[install-dir]/Packages/october-twig' folder into a new Sublime Text project.
• Open up the october-twig.sublime-syntax file and make changes.
• Provided is a test.htm file that holds most of the common uses for testing the regex, use this to verify your changes before and after you make them to ensure the changes you make do not break anything.
• Send a pull request with a single change per request.

JetBrains IntelliJ

How to install with IntelliJ

• Make sure the TextMate Bundles plugin is installed and enabled.
• Clone this repo into a local directory (/path/to/october-twig).
• In IntelliJ's settings, navigate to Editor -> TextMate Bundles.
• Click + and select the local clone of this repo (/path/to/october-twig).
• In IntellJ's settings, navigate to Editor -> File Types.
• Select Files supported via TextMate bundles.
• Under File name patterns add *.htm.
• Apply the new settings to get October Twig highlighting in any file that has a *.htm extension.

Thanks

• Thanks @dqsully for the original October CMS Template language package.
• Thanks @Anomareh for the PHP-Twig TextMate bundle used to source the Twig functions.

License

This code is licensed with a Creative Commons Attribution-NoDerivatives 4.0 International Public License which means you may use it freely and submit pull requests, but you may not fork it to create a new product without written permission. We are happy to give permission to developers that ask nicely.