prettier-plugin-sql-cst 0.4.0 → 0.6.0

package/README.md

@@ -49,7 +49,6 @@ LIMIT 100;
 
 Currently this plugin preserves most of the syntax elements
 and concentrates mainly on the layout of whitespace.
-For example it does not add/remove paratheses.
 
 See [STYLE_GUIDE][] for overview of the SQL formatting style used.
 
@@ -61,7 +60,7 @@ Install it as any other Prettier plugin:
 npm install --save-dev prettier prettier-plugin-sql-cst
 ```
 
-Then use it on SQL files though Prettier command line tool or Prettier extension
+Then use it on SQL files through Prettier command line tool or Prettier extension
 for your editor of choice.
 
 ## Choosing an SQL dialect
@@ -100,8 +99,9 @@ There are also some SQL-specific options:
 
 ## Limitations and development status
 
-Currently this plugin supports the most common everyday **SQLite** and **BigQuery** syntax.
-Formatting of the following SQL statements is fully implemented:
+Currently this plugin supports full **SQLite** syntax.
+It also supports most of the **BigQuery** syntax.
+Specifically the formatting of the following BigQuery SQL statements is fully implemented:
 
 - SELECT
 - UPDATE
@@ -110,7 +110,7 @@ Formatting of the following SQL statements is fully implemented:
 - TRUNCATE
 - CREATE / DROP / ALTER TABLE
 - CREATE / DROP VIEW
-- CREATE / DROP INDEX
+- transactions (BEGIN, COMMIT, ROLLBACK)
 
 [prettier]: https://prettier.io/
 [printWidth]: https://prettier.io/docs/en/options.html#print-width

package/dist/node_utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAsClause = exports.isArraySubscript = exports.isStringLiteral = exports.isJsonLiteral = exports.isEmpty = exports.isKeyword = exports.isCreateTableStmt = exports.isFuncCall = exports.isValuesClause = void 0;
+exports.isListExpr = exports.isParenExpr = exports.isAsClause = exports.isArraySubscript = exports.isStringLiteral = exports.isJsonLiteral = exports.isEmpty = exports.isKeyword = exports.isCreateTableStmt = exports.isFuncArgs = exports.isFuncCall = exports.isValuesClause = void 0;
 var utils_1 = require("./utils");
 var is = function (type) {
     return function (node) {
@@ -9,6 +9,7 @@ var is = function (type) {
 };
 exports.isValuesClause = is("values_clause");
 exports.isFuncCall = is("func_call");
+exports.isFuncArgs = is("func_args");
 exports.isCreateTableStmt = is("create_table_stmt");
 exports.isKeyword = is("keyword");
 exports.isEmpty = is("empty");
@@ -16,3 +17,5 @@ exports.isJsonLiteral = is("json_literal");
 exports.isStringLiteral = is("string_literal");
 exports.isArraySubscript = is("array_subscript");
 exports.isAsClause = is("as_clause");
+exports.isParenExpr = is("paren_expr");
+exports.isListExpr = is("list_expr");

package/dist/syntax/analyze.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyzeMap = void 0;
+exports.analyzeMap = {
+    analyze_stmt: function (print) { return print.spaced(["analyzeKw", "tableKw", "tables"]); },
+};

package/dist/syntax/create_table.js

@@ -25,6 +25,7 @@ exports.createTableMap = {
                 "temporaryKw",
                 "externalKw",
                 "snapshotKw",
+                "virtualKw",
                 "tableKw",
                 "ifNotExistsKw",
                 "name",
@@ -44,6 +45,7 @@ exports.createTableMap = {
     with_partition_columns_clause: function (print) {
         return print.spaced(["withPartitionColumnsKw", "columns"]);
     },
+    create_table_using_clause: function (print) { return print.spaced(["usingKw", "module"]); },
 };
 var printClauses = function (print, node) {
     if (node.clauses.length === 1 && (0, node_utils_1.isAsClause)(node.clauses[0])) {

package/dist/syntax/explain.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.explainMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.explainMap = {
+    explain_stmt: function (print) {
+        return (0, print_utils_1.group)([
+            print.spaced(["explainKw", "queryPlanKw"]),
+            (0, print_utils_1.indent)([print_utils_1.line, print("statement")]),
+        ]);
+    },
+};

package/dist/syntax/expr.js

@@ -33,6 +33,15 @@ exports.exprMap = {
         }
     },
     paren_expr: function (print, node, path) {
+        // discard unnecessary nested ((parentheses))
+        if ((0, node_utils_1.isParenExpr)(node.expr)) {
+            return print("expr");
+        }
+        // Discard unnecessary parenthesis around function arguments
+        if ((0, node_utils_1.isListExpr)(path.getParentNode(0)) &&
+            (0, node_utils_1.isFuncArgs)(path.getParentNode(1))) {
+            return print("expr");
+        }
         var parent = path.getParentNode();
         var lineStyle = (0, node_utils_1.isCreateTableStmt)(parent) ? print_utils_1.hardline : print_utils_1.softline;
         return (0, print_utils_1.group)(["(", (0, print_utils_1.indent)([lineStyle, print("expr")]), lineStyle, ")"]);
@@ -84,8 +93,11 @@ exports.exprMap = {
     filter_arg: function (print) { return print.spaced(["filterKw", "where"]); },
     over_arg: function (print) { return print.spaced(["overKw", "window"]); },
     cast_expr: function (print) { return print(["castKw", "args"]); },
-    cast_arg: function (print) { return print.spaced(["expr", "asKw", "dataType"]); },
+    cast_arg: function (print) { return print.spaced(["expr", "asKw", "dataType", "format"]); },
+    cast_format: function (print) { return print.spaced(["formatKw", "string", "timezone"]); },
+    cast_format_timezone: function (print) { return print.spaced(["atTimeZoneKw", "timezone"]); },
     raise_expr: function (print) { return print(["raiseKw", "args"]); },
+    raise_expr_type: function (print) { return print("typeKw"); },
     interval_expr: function (print) { return print.spaced(["intervalKw", "expr", "unit"]); },
     interval_unit_range: function (print) {
         return print.spaced(["fromUnitKw", "toKw", "toUnitKw"]);
@@ -109,6 +121,7 @@ exports.exprMap = {
     timestamp_literal: function (print) { return print.spaced(["timestampKw", "string"]); },
     json_literal: function (print) { return print.spaced(["jsonKw", "string"]); },
     identifier: function (print) { return print("text"); },
+    variable: function (print) { return print("text"); },
 };
 var isBooleanOp = function (_a) {
     var name = _a.name;

package/dist/syntax/procedural_language.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.proceduralLanguageMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.proceduralLanguageMap = {
+    block_stmt: function (print) { return [
+        print("beginKw"),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("program"))]),
+        print_utils_1.hardline,
+        print("endKw"),
+    ]; },
+};

package/dist/syntax/sqlite.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sqliteMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.sqliteMap = {
+    attach_database_stmt: function (print) {
+        return print.spaced(["attachKw", "databaseKw", "file", "asKw", "schema"]);
+    },
+    detach_database_stmt: function (print) {
+        return print.spaced(["detachKw", "databaseKw", "schema"]);
+    },
+    vacuum_stmt: function (print) {
+        return print.spaced(["vacuumKw", "schema", "intoKw", "file"]);
+    },
+    reindex_stmt: function (print) { return print.spaced(["reindexKw", "table"]); },
+    pragma_stmt: function (print) { return print.spaced(["pragmaKw", "pragma"]); },
+    pragma_assignment: function (print) { return (0, print_utils_1.join)(" = ", print(["name", "value"])); },
+    pragma_func_call: function (print) { return print(["name", "args"]); },
+};

package/dist/syntax/transaction.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transactionMap = void 0;
+exports.transactionMap = {
+    start_transaction_stmt: function (print) {
+        return print.spaced(["startKw", "behaviorKw", "transactionKw"]);
+    },
+    commit_transaction_stmt: function (print) {
+        return print.spaced(["commitKw", "transactionKw"]);
+    },
+    rollback_transaction_stmt: function (print) {
+        return print.spaced(["rollbackKw", "transactionKw", "savepoint"]);
+    },
+    rollback_to_savepoint: function (print) {
+        return print.spaced(["toKw", "savepointKw", "savepoint"]);
+    },
+    savepoint_stmt: function (print) { return print.spaced(["savepointKw", "savepoint"]); },
+    release_savepoint_stmt: function (print) {
+        return print.spaced(["releaseKw", "savepointKw", "savepoint"]);
+    },
+};

package/dist/syntax/transformMap.js

@@ -14,6 +14,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformMap = void 0;
 var alias_1 = require("./alias");
 var alter_table_1 = require("./alter_table");
+var analyze_1 = require("./analyze");
 var base_1 = require("./base");
 var bigquery_1 = require("./bigquery");
 var constraint_1 = require("./constraint");
@@ -21,14 +22,19 @@ var create_table_1 = require("./create_table");
 var data_type_1 = require("./data_type");
 var delete_1 = require("./delete");
 var drop_table_1 = require("./drop_table");
+var explain_1 = require("./explain");
 var expr_1 = require("./expr");
 var frame_1 = require("./frame");
 var index_1 = require("./index");
 var insert_1 = require("./insert");
+var procedural_language_1 = require("./procedural_language");
 var proc_clause_1 = require("./proc_clause");
 var program_1 = require("./program");
 var select_1 = require("./select");
+var sqlite_1 = require("./sqlite");
+var transaction_1 = require("./transaction");
+var trigger_1 = require("./trigger");
 var truncate_1 = require("./truncate");
 var update_1 = require("./update");
 var view_1 = require("./view");
-exports.transformMap = __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, alias_1.aliasMap), alter_table_1.alterTableMap), base_1.baseMap), bigquery_1.bigqueryMap), constraint_1.constraintMap), create_table_1.createTableMap), data_type_1.dataTypeMap), delete_1.deleteMap), drop_table_1.dropTableMap), expr_1.exprMap), frame_1.frameMap), index_1.indexMap), insert_1.insertMap), proc_clause_1.procClauseMap), program_1.programMap), select_1.selectMap), truncate_1.truncateMap), update_1.updateMap), view_1.viewMap);
+exports.transformMap = __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, alias_1.aliasMap), alter_table_1.alterTableMap), analyze_1.analyzeMap), base_1.baseMap), bigquery_1.bigqueryMap), constraint_1.constraintMap), create_table_1.createTableMap), data_type_1.dataTypeMap), delete_1.deleteMap), drop_table_1.dropTableMap), explain_1.explainMap), expr_1.exprMap), frame_1.frameMap), index_1.indexMap), insert_1.insertMap), proc_clause_1.procClauseMap), procedural_language_1.proceduralLanguageMap), program_1.programMap), select_1.selectMap), sqlite_1.sqliteMap), transaction_1.transactionMap), trigger_1.triggerMap), truncate_1.truncateMap), update_1.updateMap), view_1.viewMap);

package/dist/syntax/trigger.js

@@ -0,0 +1,44 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.triggerMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.triggerMap = {
+    create_trigger_stmt: function (print, node) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray(__spreadArray(__spreadArray([
+            print.spaced([
+                "createKw",
+                "temporaryKw",
+                "triggerKw",
+                "ifNotExistsKw",
+                "name",
+            ]),
+            print("event")
+        ], (node.forEachRowKw ? [print.spaced(["forEachRowKw"])] : []), true), (node.condition ? [print(["condition"])] : []), true), [
+            print("body"),
+        ], false));
+    },
+    trigger_event: function (print) {
+        return (0, print_utils_1.group)([
+            print.spaced(["timeKw", "eventKw", "ofKw"]),
+            (0, print_utils_1.indent)([
+                print_utils_1.line,
+                (0, print_utils_1.join)(print_utils_1.line, __spreadArray(__spreadArray([], print(["columns"]), true), [print.spaced(["onKw", "table"])], false)),
+            ]),
+        ]);
+    },
+    trigger_condition: function (print) {
+        return (0, print_utils_1.group)([print("whenKw"), (0, print_utils_1.indent)([print_utils_1.line, print("expr")])]);
+    },
+    drop_trigger_stmt: function (print) {
+        return print.spaced(["dropTriggerKw", "ifExistsKw", "trigger"]);
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Prettier plugin for SQL",
   "author": "Rene Saarsoo <nene@triin.net>",
   "license": "GPL-3.0-or-later",
@@ -29,7 +29,7 @@
   ],
   "dependencies": {
     "prettier": "^2.8.2",
-    "sql-parser-cst": "^0.12.0"
+    "sql-parser-cst": "^0.13.0"
   },
   "devDependencies": {
     "@types/jest": "^29.2.5",