Home

Writing code

Clone this repo directly into the Packages folder. This one:

Open the Terminal

and execute git clone https://github.com/SublimeLinter/SublimeLinter

Then open subl SublimeLinter.

The files in the top folder of the project (the "views") can be modified and will hot-reload after saving automatically. However, after editing other files, e.g. the backend, the Linter classes, a manual hot reload is necessary.

This should still be very fast. You might want to add a build system for it. E.g.

    "build_systems": [
        {
            "name": "Reload SublimeLinter",
            "target": "sublime_linter_reload",
        },
    ],

All the tools

To install the necessary tools for SublimeLinter, it is recommended to set up a virtual environment within the SublimeLinter folder. These days, I recommend rye as your project manager. Follow the steps below:

1. In the terminal you just used for cloning.
2. Navigate to the SublimeLinter folder.

cd SublimeLinter

3. Setup the environment

rye sync

To run the tests

Install https://github.com/SublimeText/UnitTesting using Package Control

After that various commands are available. (Make sure the current Window points to SublimeLinter!)

Writing documentation

# in case you did not install all the tools
pip install Sphinx sphinx-autobuild
# then
sphinx-autobuild --open-browser docs docs/_build/html

---

Test updating SublimeLinter locally