Preset Command

by benweier ALL

A Sublime Text plugin for managing collections of settings presets. Compatible with ST 3

Details

Version 2.0.0
Homepage github.com
Issues github.com
Modified 8 years ago
Last Seen 1 hour ago
First Seen 12 years ago

Installs

Total 560
Win 319
Mac 171
Linux 70

	Nov 21	Nov 20	Nov 19	Nov 18	Nov 17	Nov 16	Nov 15	Nov 14	Nov 13	Nov 12	Nov 11	Nov 10	Nov 9	Nov 8	Nov 7	Nov 6	Nov 5	Nov 4	Nov 3	Nov 2	Nov 1	Oct 31	Oct 30	Oct 29	Oct 28	Oct 27	Oct 26	Oct 25	Oct 24	Oct 23	Oct 22	Oct 21	Oct 20	Oct 19	Oct 18	Oct 17	Oct 16	Oct 15	Oct 14	Oct 13	Oct 12	Oct 11	Oct 10	Oct 9	Oct 8
Windows	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Mac	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Linux	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0

Readme

Source: raw.githubusercontent.com

About

Preset Command is a Sublime Text plugin to manage collections of presets, by quickly and easily applying application or plugin settings from the command palette or with keyboard shortcuts.

Preset Command is non-persistent insofar that it does not track which preset is active or the state of your settings, allowing you to set up chains of presets that can be used in conjunction with other presets. For example, a Theme and Color Scheme preset may be used with a Proxy preset without interfering with each other.

Installation

Install Preset Command through Package Control or download and extract into your Packages folder.

Getting Started

To get started with Preset Command, run Manage Presets from the Command Palette. This will open an empty file to begin adding presets.

{
    "presets":
    [
        {
            "name": "Default",
            "description": "Default theme and color scheme",
            "settings": {
                "Preferences.sublime-settings": {
                    "color_scheme": "Packages/Color Scheme - Default/Monokai.tmTheme",
                    "theme": "Default.sublime-theme"
                }
            }
        }
    ]
}

This won't do much if you're already using the default settings but it gives you a simple template to follow to begin using Preset Command. It can do more than just themes and color schemes too! Anything you can set through a Sublime Text .sublime-settings file, even plugins like Package Control, Emmet, or Soda Theme can be set through Preset Command.

Multiple settings files can be changed in a single preset, simply provide more than one filename settings object.

{
    "presets":
    [
        {
            "name": "Work Mode",
            "description": "Hi Ho, Hi Ho",
            "settings": {
                "Preferences.sublime-settings": {
                    "default_line_ending": "unix",
                    "ensure_newline_at_eof_on_save": true,
                    "tab_size": 4,
                    "trim_trailing_white_space_on_save": true
                },
                "Package Control.sublime-settings": {
                    "http_proxy": "example.proxy:1234",
                    "https_proxy": "example.proxy:1234"
                }
            }
        }
    ]
}

Usage

Preset Command: List Presets to select a preset from the command palette. Default shortcut: ctrl+f4 (Windows/Linux) super+f4 (OSX). This command is only available if at least 1 preset is enabled.

Preset Command: Manage Presets to open your Presets.sublime-settings file for editing. This file contains an array of JSON objects as detailed below.

Preset Command: Enable Preset to list your currently disabled presets. Select one to enable it for use in the List Presets command. This command is only available if at least 1 preset is already disabled.

Preset Command: Disable Preset to list your currently enabled presets. Select one to disable it from the List Presets command. This command is only available if at least 1 preset is enabled.

Preset Structure

Preset objects have the following properties:

name: String. Required. The name of your preset shown in the command palette, and also can be passed to the preset_command_by_name command in order to run it directly. It is recommended, but not enforced, that each preset be assigned a unique name.

description: String. Required. A short description of the preset, shown in the command palette for your own organisation.

settings: Object. Optional. Contains one or more 'filename': { settings } objects that the preset will save when activated. Multiple filename settings objects may be provided and the settings will applied in order.

run: Array. Optional. Contains one or more Sublime Text commands (packaged or plugin) to execute. Arguments not supported.

Settings Examples

The following are examples of using settings in a preset.

Going into a presentation and need to make your text easier to read on the projector?

{
    "presets":
    [
        {
            "name": "Projector Mode",
            "description": "Bigger is better",
            "settings": {
                "Preferences.sublime-settings": {
                    "font_size": 30,
                    "line_numbers": false,
                    "draw_indent_guides": false
                }
            }
        }
    ]
}

Do you like to customise Sublime Text's appearance depending on where you are or the time of day?

(This example works if you have Soda Theme and Colour Schemes)

{
    "presets":
    [
        {
            "name": "Dark",
            "description": "Like a smooth cup of coffee...",
            "settings": {
                "Preferences.sublime-settings": {
                    "theme": "Soda Dark.sublime-theme",
                    "color_scheme": "Packages/User/Monokai Soda.tmTheme",
                    "soda_classic_tabs": true,
                    "soda_folder_icons": true
                }
            }
        },
        {
            "name": "Light",
            "description": "Classic Soda. Refreshing!",
            "settings": {
                "Preferences.sublime-settings": {
                    "theme": "Soda Light.sublime-theme",
                    "color_scheme": "Packages/User/Espresso Soda.tmTheme",
                    "soda_classic_tabs": false,
                    "soda_folder_icons": false
                }
            }
        }
    ]
}

Using Package Control with a proxy at work but not at home?

When assigning an empty setting value (e.g. "http_proxy": "") through Preset Command, Sublime Text will remove the named setting from the file which will revert back to its default value.

{
    "presets":
    [
        {
            "name": "Home",
            "description": "No proxy",
            "settings": {
                "Package Control.sublime-settings": {
                    "http_proxy": "",
                    "https_proxy": ""
                }
            }
        },
        {
            "name": "Work",
            "description": "Proxy",
            "settings": {
                "Package Control.sublime-settings": {
                    "http_proxy": "example.proxy:1234",
                    "https_proxy": "example.proxy:1234"
                }
            }
        }
    ]
}

Run Examples

Preset Command can also run commands just like you would from a shortcut or menu item, and can be used together with a settings object in the same preset. Passing command arguments is not supported.

Commands are executed in Sublime Text's Window scope so commands that perform actions in open files (such as text manipulation) will not work. This is outside the intended design of Preset Command and it is recommended to use Sublime Text's built-in Macro feature to order to achieve this goal.

Want nothing but the code?

{
    "presets":
    [
        {
            "name": "Code Mode",
            "description": "From the 'I hate fullscreen' department",
            "run": ["toggle_menu", "toggle_side_bar", "toggle_minimap"]
        }
    ]
}

This will toggle the menu, sidebar, and minimap from their current state but won't set a specific state.

Activate a Preset by name

Presets can be activated by passing the preset name directly to preset_command_by_name and bound to a keyboard shortcut.

Example

[
    { "keys": ["ctrl+f4", "ctrl+d"], "command": "preset_command_by_name", "args": { "name": "Dark" } },
    { "keys": ["ctrl+f4", "ctrl+l"], "command": "preset_command_by_name", "args": { "name": "Light" } }
]

{
    "presets":
    [
        {
            "name": "Dark",
            "description": "Like a smooth cup of coffee...",
            "settings": {
                "Preferences.sublime-settings": {
                    "theme": "Soda Dark.sublime-theme",
                    "color_scheme": "Packages/User/Monokai Soda.tmTheme",
                    "soda_classic_tabs": true,
                    "soda_folder_icons": true
                }
            }
        },
        {
            "name": "Light",
            "description": "Classic Soda. Refreshing!",
            "settings": {
                "Preferences.sublime-settings": {
                    "theme": "Soda Light.sublime-theme",
                    "color_scheme": "Packages/User/Espresso Soda.tmTheme",
                    "soda_classic_tabs": false,
                    "soda_folder_icons": false
                }
            }
        }
    ]
}