|
options: { |
|
formatter: { |
|
since: '0.1.0', |
|
category: 'Config', |
|
type: 'choice', |
|
default: SQL_FORMATTER, |
|
description: 'Choose which formatter to be used', |
|
choices: [ |
|
{ |
|
value: SQL_FORMATTER, |
|
description: 'use `sql-formatter` as formatter', |
|
}, |
|
{ |
|
value: NODE_SQL_PARSER, |
|
description: 'use `node-sql-parser` as formatter', |
|
}, |
|
], |
|
}, |
|
language: { |
|
since: '0.1.0', |
|
category: 'Config', |
|
type: 'choice', |
|
default: 'sql', |
|
description: 'SQL Formatter dialect for `sql-formatter`', |
|
choices: [ |
|
{ |
|
value: 'sql', |
|
description: 'Standard SQL: https://en.wikipedia.org/wiki/SQL:2011', |
|
}, |
|
{ |
|
value: 'mariadb', |
|
description: 'MariaDB: https://mariadb.com', |
|
}, |
|
{ |
|
value: 'mysql', |
|
description: 'MySQL: https://www.mysql.com', |
|
}, |
|
{ |
|
value: 'postgresql', |
|
description: 'PostgreSQL: https://www.postgresql.org', |
|
}, |
|
{ |
|
value: 'db2', |
|
description: 'IBM DB2: https://www.ibm.com/analytics/db2', |
|
}, |
|
{ |
|
value: 'plsql', |
|
description: |
|
'Oracle PL/SQL: https://www.oracle.com/database/technologies/appdev/plsql.html', |
|
}, |
|
{ |
|
value: 'n1ql', |
|
description: |
|
'Couchbase N1QL: https://www.couchbase.com/products/n1ql', |
|
}, |
|
{ |
|
value: 'redshift', |
|
description: |
|
'Amazon Redshift: https://docs.aws.amazon.com/redshift/latest/dg/cm_chap_SQLCommandRef.html', |
|
}, |
|
{ |
|
value: 'spark', |
|
description: 'Spark: https://spark.apache.org', |
|
}, |
|
{ |
|
value: 'tsql', |
|
description: |
|
'SQL Server Transact-SQL: https://docs.microsoft.com/en-us/sql/sql-server/', |
|
}, |
|
], |
|
}, |
|
keywordCase: { |
|
since: '0.7.0', |
|
category: 'Output', |
|
type: 'choice', |
|
default: 'preserve', |
|
description: |
|
'Converts reserved keywords and builtin function names to upper or lowercase for `sql-formatter`', |
|
choices: [ |
|
{ |
|
value: 'preserve', |
|
description: 'preserves the original case', |
|
}, |
|
{ |
|
value: 'upper', |
|
description: 'converts to uppercase', |
|
}, |
|
{ |
|
value: 'lower', |
|
description: 'converts to lowercase', |
|
}, |
|
], |
|
}, |
|
uppercase: { |
|
since: '0.1.0', |
|
category: 'Output', |
|
type: 'boolean', |
|
deprecated: '0.7.0', |
|
description: 'Use `keywordCase` option instead', |
|
}, |
|
indentStyle: { |
|
since: '0.7.0', |
|
category: 'Format', |
|
type: 'choice', |
|
default: 'standard', |
|
description: `Switches between different indentation styles for \`sql-formatter\`. |
|
|
|
Caveats of using \`"tabularLeft"\` and \`"tabularRight"\`: |
|
|
|
- \`tabWidth\` option is ignored. Indentation will always be 10 spaces, regardless of what is specified by \`tabWidth\``, |
|
choices: [ |
|
{ |
|
value: 'standard', |
|
description: |
|
'indents code by the amount specified by `tabWidth` option', |
|
}, |
|
{ |
|
value: 'tabularLeft', |
|
description: |
|
'indents in tabular style with 10 spaces, aligning keywords to left', |
|
}, |
|
{ |
|
value: 'tabularRight', |
|
description: |
|
'indents in tabular style with 10 spaces, aligning keywords to right', |
|
}, |
|
], |
|
}, |
|
logicalOperatorNewline: { |
|
since: '0.7.0', |
|
category: 'Format', |
|
type: 'choice', |
|
default: 'before', |
|
description: |
|
'Decides newline placement before or after logical operators (AND, OR, XOR)', |
|
choices: [ |
|
{ |
|
value: 'before', |
|
description: 'adds newline before the operator', |
|
}, |
|
{ |
|
value: 'after', |
|
description: 'adds newline after the operator', |
|
}, |
|
], |
|
}, |
|
aliasAs: { |
|
since: '0.7.0', |
|
category: 'Format', |
|
type: 'choice', |
|
default: 'preserve', |
|
description: |
|
'Enforces consistent use of `AS` keywords in alias declarations for `sql-formatter`', |
|
choices: [ |
|
{ |
|
value: 'preserve', |
|
description: 'does nothing', |
|
}, |
|
{ |
|
value: 'always', |
|
description: 'enforces `AS` usage for all aliases', |
|
}, |
|
{ |
|
value: 'never', |
|
description: 'forbids `AS` usage for all aliases', |
|
}, |
|
{ |
|
value: 'select', |
|
description: |
|
'enforces `AS` usage in column aliases of `SELECT` and forbids it for table name aliases', |
|
}, |
|
], |
|
}, |
|
tabulateAlias: { |
|
since: '0.7.0', |
|
category: 'Format', |
|
type: 'boolean', |
|
default: false, |
|
description: |
|
'Aligns column aliases into a single column for `sql-formatter`. Does not effect table name aliases.', |
|
}, |
|
commaPosition: { |
|
since: '0.7.0', |
|
category: 'Format', |
|
type: 'choice', |
|
default: 'after', |
|
description: |
|
'Defines where to place commas in lists of columns for `sql-formatter`', |
|
choices: [ |
|
{ |
|
value: 'after', |
|
description: 'places comma at the end of line', |
|
}, |
|
{ |
|
value: 'before', |
|
description: 'places comma at the start of line', |
|
}, |
|
{ |
|
value: 'tabular', |
|
description: 'aligns commas in a column at the end of line', |
|
}, |
|
], |
|
}, |
|
expressionWidth: { |
|
since: '0.7.0', |
|
category: 'Format', |
|
type: 'int', |
|
default: 50, |
|
description: |
|
'Determines maximum length of parenthesized expressions for `sql-formatter`', |
|
}, |
|
linesBetweenQueries: { |
|
since: '0.1.0', |
|
category: 'Format', |
|
type: 'int', |
|
default: 1, |
|
description: |
|
'Decides how many empty lines to leave between SQL statements for `sql-formatter`', |
|
}, |
|
denseOperators: { |
|
since: '0.7.0', |
|
category: 'Format', |
|
type: 'boolean', |
|
default: false, |
|
description: |
|
'Decides whitespace around operators for `sql-formatter`. Does not apply to logical operators (AND, OR, XOR).', |
|
}, |
|
newlineBeforeSemicolon: { |
|
since: '0.7.0', |
|
category: 'Format', |
|
type: 'boolean', |
|
default: false, |
|
description: |
|
'Whether to place query separator (`;`) on a separate line for `sql-formatter`', |
|
}, |
|
params: { |
|
since: '0.7.0', |
|
category: 'Format', |
|
type: 'choice', |
|
description: |
|
'Specifies parameter values to fill in for placeholders inside SQL for `sql-formatter`. This option is designed to be used through API (though nothing really prevents usage from command line).', |
|
choices: [ |
|
{ |
|
value: Array, |
|
description: |
|
'`Array` of strings and/or numbers for position placeholders', |
|
}, |
|
{ |
|
value: Object, |
|
description: |
|
'`Object` of name-value pairs for named (and indexed) placeholders', |
|
}, |
|
], |
|
// @ts-expect-error |
|
exception(value: unknown) { |
|
return ( |
|
value == null || |
|
(Array.isArray(value) |
|
? value.every( |
|
(v: unknown) => typeof v === 'string' || typeof v === 'number', |
|
) |
|
: typeof value === 'object') |
|
) |
|
}, |
|
}, |
|
type: { |
|
since: '0.1.0', |
|
category: 'Config', |
|
type: 'choice', |
|
default: 'table', |
|
description: 'Check the SQL with Authority List for `node-sql-parser`', |
|
choices: [ |
|
{ |
|
value: 'table', |
|
description: '`table` mode', |
|
}, |
|
{ |
|
value: 'column', |
|
description: '`column` mode', |
|
}, |
|
], |
|
}, |
|
database: { |
|
since: '0.1.0', |
|
category: 'Config', |
|
type: 'choice', |
|
default: 'mysql', |
|
description: 'SQL dialect for `node-sql-parser`', |
|
choices: [ |
|
{ |
|
value: 'bigquery', |
|
description: 'BigQuery: https://cloud.google.com/bigquery', |
|
}, |
|
{ |
|
value: 'db2', |
|
description: 'IBM DB2: https://www.ibm.com/analytics/db2', |
|
}, |
|
{ |
|
value: 'hive', |
|
description: 'Hive: https://hive.apache.org', |
|
}, |
|
{ |
|
value: 'mariadb', |
|
description: 'MariaDB: https://mariadb.com', |
|
}, |
|
{ |
|
value: 'mysql', |
|
description: 'MySQL: https://www.mysql.com', |
|
}, |
|
{ |
|
value: 'postgresql', |
|
description: 'PostgreSQL: https://www.postgresql.org', |
|
}, |
|
{ |
|
value: 'transactsql', |
|
description: |
|
'TransactSQL: https://docs.microsoft.com/en-us/sql/t-sql', |
|
}, |
|
{ |
|
value: 'flinksql', |
|
description: |
|
'FlinkSQL: https://ci.apache.org/projects/flink/flink-docs-stable', |
|
}, |
|
], |
|
}, |
|
}, |
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
![lgtm-com[bot] avatar](https://avatars.githubusercontent.com/in/17324?v=4 "lgtm-com[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent