SublimeDirectorySettings

A Sublime Text package that enables per-directory configuration of Sublime Text preferences.

Table of Contents

• Why?
• Features
• Requirements
• Installation
  • Package Control
  • Manual
• Usage
  • General Settings Files
  • Syntax-Specific Settings Files
  • Settings File Format
  • Example

Why?

Sublime Text can be configured easily without having to go through a dozen different menus and windows: Just adjust a single JSON file and be done with it. However, out of the box, configuration is limited to one global settings file and a single settings file per project. On top of that, syntax-specific settings for a project cannot be adjusted. SublimeDirectorySettings takes care of all these limitations by enabling flexible per-directory configuration.

Features

• Sublime Text settings are automatically adjusted using per-directory settings files.
• In addition to the general per-directory configuration functionality, settings can further be split by syntax.
• The complete directory tree is searched to discover and merge settings files.

Requirements

Note: The correct version is automatically picked if SublimeDirectorySettings is installed with Package Control.

Installation

Package Control

To install SublimeDirectorySettings with Package Control, select the package DirectorySettings. Check out the Package Control installation instructions if you need help.

Manual

Following steps can be used if you prefer to manually manage your Sublime Text packages:

1. Download SublimeDirectorySettings.
2. Extract the downloaded archive.
3. Rename the extracted directory to DirectorySettings.
4. Move the directory to your Sublime Text packages directory. You can access the Sublime Text packages directory by opening the command palette and entering Browse Packages.

Usage

Note: SublimeDirectorySettings operates in the scope of individual windows/tabs. As a result, application-global settings cannot be controlled. Check the Sublime Text documentation for more details.

General Settings Files

Simply place a file called Preferences.sublime-settings inside a directory. Any Sublime Text window/tab for a file inside that directory (and subdirectories) will be configured accordingly. Settings files that are lower in the directory tree have higher priority and override settings that are defined in files higher up.

Syntax-Specific Settings Files

You can also split per-directory settings by syntax. For example, to apply settings to JavaScript files inside a directory, use following steps:

1. Open a JavaScript file with Sublime Text.
2. Access the command palette and enter Settings Syntax Specific. This will open a syntax-specific settings file for JavaScript.
3. Note the name of the open settings file. It will be JavaScript.sublime-settings in this example.
4. Create an equally named file inside the desired directory.

The syntax-specific settings files follow the same discovery and merge logic as the general settings files.

Settings File Format

The settings files for SublimeDirectorySettings have the same format as the Sublime Text settings files. For example:

{
    "tab_size": 4,
    "rulers": [80],
    "translate_tabs_to_spaces": true
}

Example

example/
    js/
        Preferences.sublime-settings
        form.js
    Preferences.sublime-settings
    HTML.sublime-settings
    JavaScript.sublime-settings
    index.html

• The window/tab for file example/index.html is configured using settings from example/Preferences.sublime-settings and example/HTML.sublime-settings.
• The window/tab for file example/js/form.js is configured using settings from example/js/Preferences.sublime-settings, example/Preferences.sublime-settings and example/JavaScript.sublime-settings.