A utility library for Sublime Text, providing a variety of convenience features.
To make use of sublime_lib in a package...
-
declare it as a dependency:
Create a file named
dependencies.jsonwith the following contents in package's root directory:{ "*": { "*": [ "sublime_lib" ] } }Open Command Palette and run
Package Control: Satisfy Librariesto ensure sublime_lib is installed and available for use. -
Import sublime_lib in plugins which want to make use of it.
import sublime_lib
For complete documentation of all features, see the API documentation.
Highlights include:
ActivityIndicatorcontext manager to indicate background activity via status bar.ResourcePath, a pathlib.Path-inspired representation of ST's resource paths with methods to convert from and to filesystem paths.SettingsDictprovides a standard Pythondict-like interface forsublime.Settingsobjects.ViewStream, providing a standard Python IO stream wrapping asublime.Viewobject.OutputPanel, extendingViewStreamto provide additional functionality for output panel views.
The flags submodule is deprecated
in favour of native API,
available as of ST4135.
The Syntax Utilities are marked deprecated in favour of native API functions, available as of ST4.
- Create a tag in the format
v<major>.<minor>.<patch> - Push the tag to origin.
A GitHub action builds a WHEEL file, creates a release for this tag, and attaches the WHEEL file as an artifact.