-
-
Notifications
You must be signed in to change notification settings - Fork 23
/
index.ts
408 lines (392 loc) · 11.4 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
/// <reference path="../shim.d.ts" />
import { JSOX } from 'jsox'
import type { AST, Option } from 'node-sql-parser'
import nodeSqlParser from 'node-sql-parser'
import type { Options, ParserOptions, Plugin } from 'prettier'
import { format, type FormatOptions, type ParamTypes } from 'sql-formatter'
import { languages } from './languages.js'
const parser = new nodeSqlParser.Parser()
const SQL_FORMATTER = 'sql-formatter'
const NODE_SQL_PARSER = 'node-sql-parser'
const ENDINGS = {
lf: '\n',
cr: '\r',
crlf: '\r\n',
} as const
export type SqlBaseOptions = Option &
Partial<FormatOptions> & {
language?: string
formatter?: typeof NODE_SQL_PARSER | typeof SQL_FORMATTER
paramTypes?: string
}
export type SqlOptions = ParserOptions<AST> & SqlBaseOptions
export type SqlFormatOptions = Options & SqlBaseOptions
const SqlPlugin: Plugin<AST | string> = {
languages,
parsers: {
sql: {
parse(text, { formatter, type, database }: SqlOptions) {
return formatter === SQL_FORMATTER
? text
: (parser.astify(text, { type, database }) as AST)
},
astFormat: 'sql',
locStart: () => -1,
locEnd: () => -1,
},
},
printers: {
sql: {
print(
path,
{ type, database, endOfLine, paramTypes, ...options }: SqlOptions,
) {
const value = path.node
let formatted =
typeof value === 'string'
? format(value, {
...options,
paramTypes:
paramTypes == null
? undefined
: (JSOX.parse(paramTypes) as ParamTypes),
})
: parser.sqlify(value, { type, database })
// It can never be `auto`
// @see https://github.com/prettier/prettier/blob/ab72a2c11c806f3a8a5ef42314e291843e1b3e68/src/common/end-of-line.js#L3-L9
const ending = ENDINGS[endOfLine as keyof typeof ENDINGS]
formatted = formatted.replaceAll(/\r\n?|\n/g, ending)
return formatted.endsWith(ending) ? formatted : formatted + ending
},
},
},
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: 'bigquery',
description:
'Google Standard SQL (Bigquery): https://cloud.google.com/bigquery',
},
{
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: 'singlestoredb',
description:
'SingleStoreDB: https://docs.singlestore.com/db/v7.8/en/introduction/singlestore-documentation.html',
},
{
value: 'spark',
description: 'Spark: https://spark.apache.org',
},
{
value: 'sqlite',
description: 'SQLite: https://www.sqlite.org',
},
{
value: 'trino',
description: 'Trino: https://trino.io',
},
{
value: 'transactsql',
description:
'SQL Server Transact-SQL: https://docs.microsoft.com/en-us/sql/sql-server/',
},
{
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',
},
],
},
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).',
// TODO: migrate to stringified JSOX instead
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 -- https://github.com/prettier/prettier/blob/953937dc63a8b37d2b7b7b6fc7f83a3201a716e9/src/main/normalize-options.js#L167
exception(value: unknown) {
return (
value == null ||
(Array.isArray(value)
? value.every(
(v: unknown) => typeof v === 'string' || typeof v === 'number',
)
: typeof value === 'object')
)
},
},
paramTypes: {
// since: '0.11.0',
category: 'Config',
type: 'string',
description:
'Specifies `JSOX` **stringified** parameter types to support when parsing SQL prepared statements for `sql-formatter`.',
},
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',
},
],
},
},
}
export default SqlPlugin