Sublime Format

A code formatting plugin for Sublime Text… because you have better things to worry about than manually formatting your code.

Contents

• Usage
• Installation
• Commands
• Key Bindings

Usage

As this plugin merely acts as proxy for external formatters, each formatter will require its own tool and options for code formatting.

There are no default formatters included in the plugin, and each formatter must be manually enabled in the plugin preferences. For example, this is the configuration for the formatting of Haskell and Rust source code:

{
    "formatters": {
        "Haskell": {
            "command": ["fourmolu", "--indentation", "$tab_size", "--stdin-input-file", "$file"],
            "selector": "source.haskell"
        },
        "Rust": {
            "command": ["rustfmt"],
            "selector": "source.rust",
            "format_on_save": true
        }
    }
}

The Sublime Text documentation describes the concept of scopes and selector matching. To find the scope at a given position, go to: Menu → Tools → Developer → Show Scope Name.

Installation

Package Control

1. Install Package Control
2. Run Package Control: Add Repository in the Command Palette
3. Add the repository: https://github.com/Rypac/sublime-format.git
4. Run Package Control: Install Package in the Command Palette
5. Install sublime-format

Manual

1. Select the Settings > Browse Packages… menu item
2. Browse up a directory and then into the Installed Packages/ directory
3. Download Format.sublime-package and copy it into the Installed Packages/ directory

Clone Repository

1. Select the Settings > Browse Packages… menu item

2. Within the Packages/ directory, clone the repository:

   git clone https://github.com/Rypac/sublime-format.git Format
   

Commands

Command	Description
Format: Format File	Format the current file
Format: Format Selection	Format the current selection(s)
Format: Enable Formatter	Select source file types to enable formatting
Format: Disable Formatter	Select source file types to disable formatting
Format: Enable Format on Save	Select source file types to enable formatting on save
Format: Disable Format on Save	Select source file types to disable formatting on save
Preferences: Format Settings	Edit plugin settings
Preferences: Format Key Bindings	Edit plugin key bindings

Key Bindings

To avoid potential conflicts, this plugin does not enable key bindings by default.

The following is an example that uses a single key binding to format either the entire file or a selection, based on the selection_empty context.

[
    {
        "keys": ["primary+k", "primary+f"],
        "command": "format_file",
        "context": [
            { "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true }
        ]
    },
    {
        "keys": ["primary+k", "primary+f"],
        "command": "format_selection",
        "context": [
            { "key": "selection_empty", "operator": "equal", "operand": false, "match_all": true }
        ]
    }
]