sql-formatter
A Sublime Text plugin that runs the cli-sql-formatter node library on the current file
Details
Installs
- Total 43K
- Win 21K
- Mac 17K
- Linux 5K
Oct 14 | Oct 13 | Oct 12 | Oct 11 | Oct 10 | Oct 9 | Oct 8 | Oct 7 | Oct 6 | Oct 5 | Oct 4 | Oct 3 | Oct 2 | Oct 1 | Sep 30 | Sep 29 | Sep 28 | 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 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 6 | 5 | 0 | 0 | 5 | 3 | 4 | 4 | 7 | 2 | 1 | 8 | 3 | 3 | 6 | 4 | 5 | 0 | 4 | 10 | 7 | 9 | 7 | 1 | 0 | 7 | 6 | 7 | 4 | 6 | 2 | 4 | 13 | 3 | 1 | 7 | 6 | 0 | 1 | 9 | 10 | 8 | 2 | 5 | 1 | 0 |
Mac | 0 | 3 | 1 | 4 | 8 | 6 | 7 | 5 | 4 | 1 | 0 | 5 | 8 | 3 | 5 | 6 | 3 | 2 | 9 | 18 | 8 | 6 | 7 | 0 | 3 | 3 | 10 | 7 | 9 | 6 | 3 | 3 | 7 | 8 | 8 | 8 | 3 | 4 | 1 | 4 | 5 | 5 | 8 | 5 | 2 | 2 |
Linux | 1 | 2 | 1 | 0 | 1 | 2 | 0 | 1 | 2 | 0 | 2 | 1 | 1 | 0 | 0 | 6 | 0 | 2 | 2 | 2 | 0 | 2 | 0 | 1 | 1 | 2 | 3 | 1 | 0 | 0 | 1 | 1 | 0 | 1 | 0 | 3 | 1 | 0 | 0 | 0 | 1 | 2 | 2 | 3 | 0 | 0 |
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
}
}