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

sql-formatter

by kufii ALL

A Sublime Text plugin that runs the cli-sql-formatter node library on the current file

Details

Installs

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

Readme

Source
raw.​githubusercontent.​com

sublime-sql-formatter

A Sublime Text plugin that runs the cli-sql-formatter node library on the current file. cli-sql-formatter is in turn a command line interface for the sql-formatter node library.

Installation

Dependencies

This plugin requires node.js, and also requires cli-sql-formatter to be globally installed.

npm install -g cli-sql-formatter

Plugin Installation

This plugin is installable via Package Control

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type sql-formatter. Among the entries you should see sql-formatter. Select this entry to install it.

Commands

Command Palette

  • Format SQL: Runs the formatter with the default dialect defined in your settings.
  • Format SQL With Dialect: Runs the formatter with a dialect of your choosing.

Default Hotkeys

By default, these hotkeys will run the formatter with the default dialect defined in your settings.

  • Linux/Windows: [Ctrl + KQ]
  • Mac: [Cmd + KQ]

Settings

By default the following settings are used:

{
    // The paths to look for executables
    "paths": {
        "linux": [],
        "osx": [],
        "windows": []
    },

    // The default dialect to use for formatting
    // Options:
    // "sql" - Standard SQL
    // "n1ql" - Couchbase N1QL
    // "db2" - IBM DB2
    // "pl/sql" - Oracle PL/SQL
    "default_dialect": "sql",

    // The number of spaces to indent with
    "indent_size": 2,

    // Indent with tabs instead of spaces
    "use_tabs": false
}

You can modify any settings by going to Preferences > Package Settings > sql-formatter > Settings.

Project-Specific Settings Override

To override global plugin configuration for a specific project, add a settings object with an sql-formatter key in your .sublime-project. This file is accessible via Project -> Edit Project.

For example:

{
    "folders": [
        {
            "path": "."
        }
    ],
    "settings": {
        "use_tabs": true
    }
}