Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 3.24 KB

README.md

File metadata and controls

58 lines (39 loc) · 3.24 KB
Raw

logo

kdesrc-build for Sublime Text

Syntax Tests Package Control

About

KDE/Plasma development team relies on kdesrc-build tool to manage their development setup: fetch and update source code, set up environment variables, resolve dependencies, compile and install projects.

This package brings support for kdesrc-build into Sublime Text editor:

  • intelligent syntax highlighting with snippets and plugins makes it easy to edit and navigate between kdesrc-buildrc configuration files.

  • Context-aware auto-completion suggests option names, and their values, be it boolean flags, predefined set of strings, dynamic list of choices or file system paths.

  • LSP-style documentation1 for each option: just hover the option name, or click "More" in the completions popup. Completions and documentation

  • Syntax for output panel of build commands / build results: while this package does not2 provide any *.sublime-build build system definitions, you may easily add your own (with exact kdesrc-build invocation command that fits your needs), and get nice colorful output like in real terminal:

    {
    "cmd": ["kdesrc-build", "--no-include-dependencies", "--no-src", "kirigami"],
    "syntax": "scope:source.build_output.kdesrc-build",
}

    Output panel

  • Support for KDebugSettings data files generated by ecm_qt_install_logging_categories which define logging categories and keep track of their renamings.

If you are working with QML, check out QML plugin for Sublime Text as well!

Installation

The easiest way is to install it from Package Control.

  • Install Package Control itself, if you haven't done already
  • Open up the command palette: Ctrl+Shift+P (Linux, Windows) / Cmd+Shift+P (OS X)
  • Search for Package Control: Install Package
  • Search for kdesrc-build
  • Hit Enter

Using Git

Go to your Sublime Text Packages directory and clone the repository using the command below:

$ git clone https://github.com/ratijas/kdesrc-build-sublime

Manual Download

  • Download the files using the .zip download option
  • Unzip the files (and rename the folder to QML if needed)
  • Copy the folder to your Sublime Text Packages directory

License

This package is licensed under the MIT License.

Footnotes

  1. Documentation's content is extracted from kdesrc-build documentation. It is provided with the package. Maintainers should use gen_conf_options.py script to update documentation database whenever it gets updated upstream. ↩

  2. It is planned, however, to implement a build system that detects which package current buffer belongs to, and rebuild only that package. Someday… ↩