Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: upgrade to sql-formatter v15, add dataTypeCase and keywordCase options #328

Merged
merged 3 commits into from
Dec 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/lighter-toy-top.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"prettier-plugin-sql": minor
---

feat: upgrade to sql-formatter v15, add `dataTypeCase` and `keywordCase` options
2 changes: 2 additions & 0 deletions packages/sql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ interface SqlOptions {
| 'trino'
// default `sql`
keywordCase: 'preserve' | 'upper' | 'lower' // default `preserve`
dataTypeCase: 'preserve' | 'upper' | 'lower' // default `preserve`
functionCase: 'preserve' | 'upper' | 'lower' // default `preserve`
identifierCase: 'preserve' | 'upper' | 'lower' // default `preserve`, experimental
indentStyle: 'standard' | 'tabularLeft' | 'tabularRight' // default `standard`
logicalOperatorNewline: 'before' | 'after' // default `before`
Expand Down
2 changes: 1 addition & 1 deletion packages/sql/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"dependencies": {
"jsox": "^1.2.118",
"node-sql-parser": "^4.11.0",
"sql-formatter": "^14.0.0",
"sql-formatter": "^15.0.0",
"tslib": "^2.6.2"
},
"publishConfig": {
Expand Down
58 changes: 51 additions & 7 deletions packages/sql/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -206,19 +206,63 @@ const SqlPlugin: Plugin<AST | string> = {
type: 'choice',
default: 'preserve',
description:
'Converts reserved keywords and builtin function names to upper or lowercase for `sql-formatter`',
'Converts reserved keywords to upper- or lowercase for `sql-formatter`',
choices: [
{
value: 'preserve',
description: 'preserves the original case',
description: 'preserves the original case of reserved keywords',
},
{
value: 'upper',
description: 'converts to uppercase',
description: 'converts reserved keywords to uppercase',
},
{
value: 'lower',
description: 'converts to lowercase',
description: 'converts reserved keywords to lowercase',
},
],
},
dataTypeCase: {
// since: '0.18.0',
category: 'Output',
type: 'choice',
default: 'preserve',
description:
'Converts data types to upper- or lowercase for `sql-formatter`',
choices: [
{
value: 'preserve',
description: 'preserves the original case of data types',
},
{
value: 'upper',
description: 'converts data types to uppercase',
},
{
value: 'lower',
description: 'converts data types to lowercase',
},
],
},
functionCase: {
// since: '0.18.0',
category: 'Output',
type: 'choice',
default: 'preserve',
description:
'Converts functions to upper- or lowercase for `sql-formatter`',
choices: [
{
value: 'preserve',
description: 'preserves the original case of functions',
},
{
value: 'upper',
description: 'converts functions to uppercase',
},
{
value: 'lower',
description: 'converts functions to lowercase',
},
],
},
Expand All @@ -232,15 +276,15 @@ const SqlPlugin: Plugin<AST | string> = {
choices: [
{
value: 'preserve',
description: 'preserves the original case',
description: 'preserves the original case of identifiers',
},
{
value: 'upper',
description: 'converts to uppercase',
description: 'converts identifiers to uppercase',
},
{
value: 'lower',
description: 'converts to lowercase',
description: 'converts identifiers to lowercase',
},
],
},
Expand Down
6 changes: 2 additions & 4 deletions packages/sql/test/__snapshots__/fixtures.spec.ts.snap
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`parser and printer > should format all fixtures > 144.sql 1`] = `
"CREATE TABLE
\\"test\\" (\\"id\\" uuid NOT NULL)
"CREATE TABLE \\"test\\" (\\"id\\" uuid NOT NULL)
WITH
(oids = false);
"
`;

exports[`parser and printer > should format all fixtures > 233.sql 1`] = `
"CREATE TABLE
\\"test\\" (\\"id\\" uuid NOT NULL)
"CREATE TABLE \\"test\\" (\\"id\\" uuid NOT NULL)
karlhorky marked this conversation as resolved.
Show resolved Hide resolved
WITH
(oids = false);
"
Expand Down
8 changes: 4 additions & 4 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading