Skip to content
Vim-like modelines for Sublime Text.
Python PowerShell
Latest commit 7f703b8 Sep 14, 2012 @guillermooo guillermooo edit readme
Failed to load latest commit information.
bin Fixed build script. Feb 26, 2011
tests Added tests, refactored. Feb 17, 2011
.gitignore Added .gitignore file Mar 27, 2011
.hgignore Updated build script. Feb 26, 2011
.hgtags Added tag 1.1 for changeset f7da5e3a1515 Feb 26, 2011
LICENSE.TXT added license Apr 22, 2010
MANIFEST.in Added experimental distutils command 'spa' (Sublime package). Feb 26, 2011
README.rst edit readme Sep 14, 2012
setup.py Added experimental distutils command 'spa' (Sublime package). Feb 26, 2011
sublime_modelines.py

README.rst

Sublime Modelines

Set settings local to a single buffer. A more granular approach to settings than the per file type .sublime-settings files.

Inspired in Vim's modelines feature.

Getting Started

Download and install SublimeModelines.

See the installation instructions for .sublime-packages.

Side Effects

Buffers will be scanned .on_load() for modelines and settings will be set accordingly. Settings will apply only to the buffer declaring them.

Usage

How to Declare Modelines

Modelines must be declared at the top or the bottom of source code files with one of the following syntaxes:

# sublime: option_name value
# sublime: option_name value; another_option value; third_option value

Note: # is the default comment character. Use the corresponding single-line comment character for your language. When there isn't a concept of comment, the default comment character must be used.

How to Define Comment Characters in Sublime Text

SublimeModelines finds the appropriate single-line comment character by inspecting the shellVariables preference, which must be defined in a .tmPreferences file. To see an example of how this is done, open Packages/Python/Miscellaneous.tmPreferences.

Many packages giving support for programming languages already include this, but you might need to create a .tmPreferences file for the language you're working with if you want SublimeModelines to be available.

Caveats

If the option's value contains a semicolon (;), make sure it isn't followed by a blank space. Otherwise it will be interpreted as a multioption separator.

Non-Standard Options

For some common cases, no directly settable option exists (for example, a setting to specify a syntax). For such cases, Sublime Modelines provides non-standard accessors as a stop-gap solution.

x_syntax Packages/Foo/Foo.tmLanguage

Sets the syntax to the specified .tmLanguage file.

Something went wrong with that request. Please try again.