ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Side-by-Side Settings

by jgbishop ST3

Plug-in for Sublime Text that makes it easy to view default and user settings side-by-side. Works for key bindings and other plug-ins too!

Labels utilities

Details

Installs

  • Total 3K
  • Win 2K
  • OS X 849
  • Linux 457
Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9
Windows 0 3 0 3 3 0 2 1 0 1 0 6 3 2 1 2 0 1 3 1 2 1 0 1 0 2 1 1 4 1 3 0 0 3 4 5 5 5 1 2 4 5 4 4 2 2
OS X 0 1 0 0 2 3 2 0 0 1 3 1 2 1 0 0 1 0 1 3 1 1 0 0 0 1 3 5 0 0 0 0 2 1 1 1 0 0 0 2 2 1 1 0 1 0
Linux 0 1 0 1 1 0 0 0 1 1 1 0 1 1 0 0 0 0 1 0 0 4 0 0 0 0 1 1 1 0 1 0 1 1 2 1 0 0 0 0 1 0 1 1 0 0

Readme

Source
raw.​githubusercontent.​com

Side-by-Side Settings

A Sublime Text plugin for viewing default and user settings side by side in a new window. It also works for key bindings and plug-in specific settings, making it much easier to configure Sublime Text.

Installation

There are two options for installing this package:

Package Control (Recommended)

Side-by-Side Settings is available on Package Control. If you do not have the Package Control plug-in installed in Sublime Text, you should (it's super cool)! Simply follow these instructions to install it. Once it has been installed, search for and select Side-by-Side Settings in the Install Package command window.

Git Clone

You can also clone this repository into your Sublime Text Packages directory using Git, if you feel so inclined. If you do use Git, make sure to clone using the appropriate folder name of Side-by-Side Settings (so that the menu items work as expected). Here's an example git clone command using SSH:

git clone git@github.com:jgbishop/sxs-settings.git "Side-by-Side Settings"

Usage

Side-by-Side Settings adds three new commands to the command palette (two if you are using Sublime Text 2):

  • Side-by-Side: Select a File - Opens a panel displaying all of the .sublime-settings and .sublime-keymap files in the Sublime Text environment (Sublime Text 3 only)
  • Side-by-Side: Sublime Settings - Opens both default and user Sublime Text settings side by side in a new window
  • Side-by-Side: Sublime Key Bindings - Opens both default and user Sublime Text key bindings side by side in a new window

Select a File Command

This command is only available in Sublime Text 3.

The “select a file” command opens a quick panel that displays all of the .sublime-settings and .sublime-keymap files that Sublime Text knows about (note that files located in the Packages/User directory are filtered out of this list; more on why it does this in a second). When a file in the quick panel is selected, it becomes the “left” (or “top”, depending on your settings) panel in the comparison window. The “right” (or “bottom”) panel will contain the corresponding user settings file, typically located in the Packages/User directory (hence why files in User are filtered out).

Side-by-Side Settings tries to do the correct thing depending on the file you select in the quick panel. If the file you select is a platform-specific settings file (e.g. Default/Preferences (Windows).sublime-settings), the corresponding user file that gets opened will be Preferences.sublime-settings (in the Packages/User directory). This is due to the fact that platform- specific files in the User directory are ignored by Sublime Text. Likewise, if you select any .sublime-keymap file, the appropriate platform-specific .sublime-keymap file in the User directory will be opened.

Easily Closing a Side-by-Side Window

To close the window that opens up when a Side-by-Side Settings command is issued, simply issue the same command a second time. The window that opened up will be closed for you! This is a particularly helpful feature when a command is bound to a keyboard shortcut.

Default Keyboard Shortcut

By default, the key-chord Ctrl+K, Ctrl+S is bound to the “select a file” command. If you wish to bind any of the commands to a different key, here are the internal command names to use:

  • sxs_select_file
  • sxs_settings
  • sxs_key_bindings

Here's an example key binding:

{ "keys": ["ctrl+k", "ctrl+p"], "command": "sxs_settings" }

Plug-in Settings

Side-by-Side Settings currently supports the following plug-in specific settings:

display_using_rows: This option specifies whether or not to arrange the side-by-side views vertically instead of horizontally. The default value for this option is false.

open_in_distraction_free: This option allows the side-by-side window to open in distraction free mode, essentially resulting in a full-screen window. This option defaults to false.

Reporting Bugs & Suggesting Features

If you spot a bug in this plug-in, or you have a feature request, please open an issue over on the issues page at GitHub.

Acknowledgements

Thanks to Jeremy Bolding for providing several plug-in suggestions.