sublime_lib

A utility library for Sublime Text providing a variety of convenience features for other packages to use.

Installation

To make use of sublime_lib in your own package, first declare it as a dependency of your package. Create a file named dependencies.json in the root of your package with the following contents:

{
    "*": {
        "*": [
            "sublime_lib"
        ]
    }
}

Once you have declared the dependency, open the command palette and run Package Control: Satisfy Dependencies to ensure that sublime_lib is installed and available for use.

Then, anywhere in your package, you can import sublime_lib by name:

import sublime_lib

Features

For complete documentation of all features, see the API documentation.

Highlights include:

• SettingsDict, which wraps a sublime.Settings object with an interface modeled after a standard Python dict.
• ViewStream, a standard Python IO stream wrapping a sublime.View object; and OutputPanel, which extends ViewStream to provide additional functionality for output panel views.
• The syntax submodule, providing methods to list all loaded syntax definitions and to find a syntax matching a given scope.

Releasing a new version

1. Create a tag in the format v<major>.<minor>.<patch>
2. Push the tag to origin.

A github action should be created that builds a WHEEL file, creates a release for this tag and attaches the WHEEL file as an artifact.