sql-formatter
A Sublime Text plugin that runs the cli-sql-formatter node library on the current file
Details
Installs
- Total 41K
- Win 20K
- Mac 16K
- Linux 5K
| Apr 3 | Apr 2 | Apr 1 | Mar 31 | Mar 30 | Mar 29 | Mar 28 | Mar 27 | Mar 26 | Mar 25 | Mar 24 | Mar 23 | Mar 22 | Mar 21 | Mar 20 | Mar 19 | Mar 18 | Mar 17 | Mar 16 | Mar 15 | Mar 14 | Mar 13 | Mar 12 | Mar 11 | Mar 10 | Mar 9 | Mar 8 | Mar 7 | Mar 6 | Mar 5 | Mar 4 | Mar 3 | Mar 2 | Mar 1 | Feb 28 | Feb 27 | Feb 26 | Feb 25 | Feb 24 | Feb 23 | Feb 22 | Feb 21 | Feb 20 | Feb 19 | Feb 18 | Feb 17 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 9 | 10 | 10 | 2 | 2 | 4 | 15 | 8 | 12 | 11 | 11 | 2 | 3 | 7 | 5 | 7 | 9 | 12 | 0 | 3 | 7 | 11 | 8 | 8 | 5 | 4 | 1 | 6 | 9 | 9 | 7 | 5 | 5 | 4 | 7 | 9 | 12 | 8 | 7 | 1 | 6 | 5 | 7 | 9 | 14 | 9 |
| Mac | 3 | 8 | 11 | 7 | 1 | 4 | 9 | 17 | 7 | 10 | 3 | 3 | 5 | 13 | 4 | 8 | 5 | 9 | 0 | 1 | 11 | 7 | 8 | 8 | 11 | 0 | 0 | 3 | 5 | 10 | 5 | 8 | 3 | 1 | 7 | 9 | 4 | 11 | 8 | 1 | 5 | 4 | 12 | 9 | 8 | 5 |
| Linux | 2 | 1 | 3 | 1 | 0 | 1 | 5 | 0 | 3 | 2 | 1 | 1 | 1 | 0 | 1 | 1 | 5 | 1 | 1 | 0 | 2 | 3 | 2 | 1 | 2 | 0 | 0 | 1 | 2 | 4 | 0 | 2 | 0 | 1 | 0 | 1 | 1 | 1 | 3 | 0 | 0 | 3 | 0 | 1 | 0 | 3 |
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:
Within Sublime Text, bring up the Command Palette and type
install. Among the commands you should seePackage 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.When the plugin list appears, type
sql-formatter. Among the entries you should seesql-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
}
}