Merge pull request #223 from inferrinizzard/vscode/v6

Update VSCode Extension with v6 setting changes

Author: nene

vscode/package.json

@@ -2,7 +2,7 @@
   "name": "prettier-sql-vscode",
   "displayName": "Prettier SQL VSCode",
   "description": "VSCode Extension to format SQL files",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "publisher": "inferrinizzard",
   "author": {
     "name": "inferrinizzard"
@@ -65,7 +65,7 @@
     "vsce": "vsce"
   },
   "dependencies": {
-    "prettier-sql": "^5.1.0"
+    "sql-formatter": "^6.1.2"
   },
   "devDependencies": {
     "@types/glob": "^7.1.4",
@@ -120,6 +120,7 @@
             "postgresql",
             "redshift",
             "spark",
+            "sqlite",
             "tsql"
           ],
           "default": "sql",
@@ -141,17 +142,22 @@
           "default": true,
           "markdownDescription": "Override for `insertSpaces` if `#Prettier-SQL.ignoreTabSettings#` is active"
         },
-        "Prettier-SQL.uppercaseKeywords": {
-          "type": "boolean",
-          "default": true,
-          "markdownDescription": "Whether to print keywords in ALL CAPS or lowercase"
+        "Prettier-SQL.keywordCase": {
+          "type": "string",
+          "enum": [
+            "preserve",
+            "upper",
+            "lower"
+          ],
+          "default": "preserve",
+          "markdownDescription": "Whether to print keywords in ALL CAPS, lowercase, or preserve existing"
         },
-        "Prettier-SQL.keywordPosition": {
+        "Prettier-SQL.indentStyle": {
           "type": "string",
           "enum": [
             "standard",
-            "tenSpaceLeft",
-            "tenSpaceRight"
+            "tabularLeft",
+            "tabularRight"
           ],
           "enumDescriptions": [
             "Standard SQL format, with cascading indents",
@@ -161,19 +167,25 @@
           "default": "standard",
           "markdownDescription": "Where to place keywords"
         },
-        "Prettier-SQL.breakBeforeBooleanOperator": {
-          "type": "boolean",
-          "default": false,
+        "Prettier-SQL.logicalOperatorNewline": {
+          "type": "string",
+          "enum": [
+            "before",
+            "after"
+          ],
+          "default": "before",
           "markdownDescription": "Whether to break before or after AND and OR"
         },
         "Prettier-SQL.aliasAS": {
           "type": "string",
           "enum": [
+            "preserve",
             "always",
             "select",
             "never"
           ],
           "enumDescriptions": [
+            "Preserve existing AS usage",
             "Use AS in SELECT clauses and for tables",
             "Use AS only in SELECT clauses",
             "Do not use AS for aliases"
@@ -201,41 +213,17 @@
           "default": "after",
           "markdownDescription": "Where to place commas for SELECT and GROUP BY clauses"
         },
-        "Prettier-SQL.keywordNewline.newlineMode": {
-          "type": "string",
-          "enum": [
-            "always",
-            "lineWidth",
-            "itemCount",
-            "never"
-          ],
-          "markdownEnumDescriptions": [
-            "Always break keywords items onto a newline",
-            "Break onto newline when line width > `#Prettier-SQL.lineWidth#` ",
-            "Break onto newline when item count > `#Prettier-SQL.itemCount#` ",
-            "Place all selected columns on the same line as keyword"
-          ],
-          "minimum": 1,
-          "default": "always",
-          "markdownDescription": "Rule for when to break keyword clauses onto a newline"
-        },
-        "Prettier-SQL.keywordNewline.itemCount": {
-          "type": "number",
-          "minimum": 1,
-          "default": 3,
-          "markdownDescription": "Breaks keywords clauses onto newline after n items when `#Prettier-SQL.keywordNewline#` is set to itemCount"
-        },
-        "Prettier-SQL.parenOptions.openParenNewline": {
+        "Prettier-SQL.parenOptions.newlineBeforeOpenParen": {
           "type": "boolean",
           "default": false,
           "markdownDescription": "Place (, Open Paren, CASE on newline when creating a new block"
         },
-        "Prettier-SQL.parenOptions.closeParenNewline": {
+        "Prettier-SQL.parenOptions.newlineBeforeCloseParen": {
           "type": "boolean",
           "default": true,
           "markdownDescription": "Place ), Close Paren, END on newline when closing a block"
         },
-        "Prettier-SQL.lineWidth": {
+        "Prettier-SQL.expressionWidth": {
           "type": "integer",
           "default": 50,
           "minimum": 0,
@@ -252,7 +240,7 @@
           "default": false,
           "markdownDescription": "Strip whitespace around operators such as + or >="
         },
-        "Prettier-SQL.semicolonNewline": {
+        "Prettier-SQL.newlineBeforeSemicolon": {
           "type": "boolean",
           "default": false,
           "markdownDescription": "Whether to place semicolon on its own line or on previous line"

vscode/src/extension.ts

@@ -1,17 +1,18 @@
 import * as vscode from 'vscode';
-import { format } from 'prettier-sql';
+import { format } from 'sql-formatter';
 import type {
+  SqlLanguage,
+  KeywordCase,
+  IndentStyle,
   AliasMode,
   CommaPosition,
-  FormatterLanguage,
-  KeywordMode,
-  NewlineMode,
-} from 'prettier-sql';
+  LogicalOperatorNewline,
+} from 'sql-formatter';
 
 const getConfigs = (
   settings: vscode.WorkspaceConfiguration,
   formattingOptions: vscode.FormattingOptions | { tabSize: number; insertSpaces: boolean },
-  language: FormatterLanguage
+  language: SqlLanguage
 ) => {
   const ignoreTabSettings = settings.get<boolean>('ignoreTabSettings');
   const { tabSize, insertSpaces } = ignoreTabSettings // override tab settings if ignoreTabSettings is true
@@ -26,34 +27,28 @@ const getConfigs = (
   const formatConfigs = {
     language:
       language === 'sql' // override default SQL language mode if SQLFlavourOverride is set
-        ? settings.get<FormatterLanguage>('SQLFlavourOverride') ?? 'sql'
+        ? settings.get<SqlLanguage>('SQLFlavourOverride') ?? 'sql'
         : language,
     indent,
-    uppercase: settings.get<boolean>('uppercaseKeywords'),
-    keywordPosition: settings.get<KeywordMode>('keywordPosition'),
-    breakBeforeBooleanOperator: settings.get<boolean>('breakBeforeBooleanOperator'),
+    keywordCase: settings.get<KeywordCase>('keywordCase'),
+    indentStyle: settings.get<IndentStyle>('indentStyle'),
+    logicalOperatorNewline: settings.get<LogicalOperatorNewline>('logicalOperatorNewline'),
     aliasAs: settings.get<AliasMode>('aliasAS'),
     tabulateAlias: settings.get<boolean>('tabulateAlias'),
     commaPosition: settings.get<CommaPosition>('commaPosition'),
-    newline: (newlineSetting =>
-      newlineSetting === 'itemCount'
-        ? settings.get<number>('itemCount') // pass itemCount number if keywordNewline is itemCount mode
-        : (newlineSetting as NewlineMode))(settings.get<string>('keywordNewline')),
-    parenOptions: {
-      openParenNewline: settings.get<boolean>('parenOptions.openParenNewline'),
-      closeParenNewline: settings.get<boolean>('parenOptions.closeParenNewline'),
-    },
-    lineWidth: settings.get<number>('lineWidth'),
+    newlineBeforeOpenParen: settings.get<boolean>('newlineBeforeOpenParen'),
+    newlineBeforeCloseParen: settings.get<boolean>('newlineBeforeCloseParen'),
+    expressionWidth: settings.get<number>('expressionWidth'),
     linesBetweenQueries: settings.get<number>('linesBetweenQueries'),
     denseOperators: settings.get<boolean>('denseOperators'),
-    semicolonNewline: settings.get<boolean>('semicolonNewline'),
+    newlineBeforeSemicolon: settings.get<boolean>('newlineBeforeSemicolon'),
   };
 
   return formatConfigs;
 };
 
 export function activate(context: vscode.ExtensionContext) {
-  const formatProvider = (language: FormatterLanguage) => ({
+  const formatProvider = (language: SqlLanguage) => ({
     provideDocumentFormattingEdits(
       document: vscode.TextDocument,
       options: vscode.FormattingOptions
@@ -84,14 +79,15 @@ export function activate(context: vscode.ExtensionContext) {
     },
   });
 
-  const languages: { [lang: string]: FormatterLanguage } = {
+  const languages: { [lang: string]: SqlLanguage } = {
     'sql': 'sql',
     'plsql': 'plsql',
     'mysql': 'mysql',
     'postgres': 'postgresql',
-    'hql': 'sql',
-    'hive-sql': 'sql',
+    'hql': 'hive',
+    'hive-sql': 'hive',
     'sql-bigquery': 'bigquery',
+    'sqlite': 'sqlite',
   };
   // add Prettier-SQL as a format provider for each language
   Object.entries(languages).forEach(([vscodeLang, prettierLang]) =>

vscode/yarn.lock

@@ -1896,6 +1896,13 @@ slash@^3.0.0:
   resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634"
   integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==
 
+sql-formatter@^6.1.2:
+  version "6.1.2"
+  resolved "https://registry.yarnpkg.com/sql-formatter/-/sql-formatter-6.1.2.tgz#78b05021c641020312a5f144ec313b38e7663258"
+  integrity sha512-09AiPmA6zDq82IBXOj5kN33VeAqaV92enkoonlhJge0fmfTESiYs3pwsntGKxa1C89xj/9MoHlNeqMmCr23BJw==
+  dependencies:
+    argparse "^2.0.1"
+
 string-width@^1.0.1:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/string-width/-/string-width-1.0.2.tgz#118bdf5b8cdc51a2a7e70d211e07e2b0b9b107d3"