CodeKit plug-in for Sublime Text

Installation

CodeKit Commands should be installed via Package Control.

---

How it works

Activating Projects

Auto-Activate Projects (default behavior)

When you open a project in Sublime Text, CodeKit will automatically open for you, if it's not already open, and then set the active project in CodeKit based on the current file you're working on. So if you have a few different projects open, even files in different projects but in the same window, this plug-in will keep CodeKit focused on the project you're focused on so you don't have to.

Notice If you hold the shift key down while CodeKit is starting it will Safe Start which clears existing project data.

Auto-activate will look for a config.codekit file in the active file's directory or walk up the directory tree until it either finds a config.codekit file and sends a signal to CodeKit or reaches the OS root directory and does nothing. Some path caching is done to prevent lots of unnecessary directory walks when you're switching between files in the same directory tree.

Manually Activate Projects

You can disable auto project-switching by unchecking Preferences>Package Settings>CodeKit Commands>Enable Auto Switch CodeKit Project and manually change the active project in CodeKit from Sublime via the Command Palette commands CodeKit Select project or CodeKit Select framework.

Auto Quit CodeKit (off by default)

In the Preferences>Package Settings>CodeKit Commands you can enable Auto Quit CodeKit which will quit CodeKit if you command+q Sublime Text or if you close every window in Sublime Text.

New Projects

If you're currently working on a project or framework that CodeKit doesn't know about, simply run the command CodeKit Add project or CodeKit Add framework from the Command Palette. You'll then be presented with a list of root level folders from Sublime Text's sidebar, once you select one it will be added to CodeKit.

Alternatively you can right click on a folder in the side bar and select CodeKit Commands > Create CodeKit Project or CodeKit Commands > Create CodeKit Framework and add that specific folder to CodeKit.

Pausing CodeKit

Auto-Pausing CodeKit (off by default)

This plug-in can auto-pause CodeKit when you're not focused on Sublime Text. This can be useful if you use the CLI or third-party tools to handle source control. Just enable auto-pausing in the settings "pause_codekit_on_view_deactivate": true.

CodeKit states:

Before you perform any action that will change large numbers of files at once (switching branches, rebasing, pull requests, etc.) you MUST tell CodeKit to ignore file changes.

Manually Pausing CodeKit

You can use the CodeKit pause and CodeKit unpause commands from the Command Palette.

Heads Up: These two commands are hidden from the Command Palette when auto-pausing is enabled since they're useless otherwise.

Info: More details about why it's good practice to pause and other critical things to know about CodeKit can be found here.

Launching and refreshing browsers

You have access to browser refreshing, style sheet reloading, browser specific previewing all from the Command Palette. Just type CodeKit in the Command Palette to see the full list.

Info: Any new commands added will always be prefixed with CodeKit for easy viewing/access.