prettier-plugin-sql-cst 0.7.0 → 0.8.0

package/README.md

@@ -103,7 +103,10 @@ There are also some SQL-specific options:
 Currently this plugin supports two SQL dialects:
 
 - **SQLite** - full support.
-- **BigQuery** - most of the common SQL syntax is supported (see [#2][] for implementation progress).
+- **BigQuery** - full support.
+
+The specifics of the [SQL formatting style][STYLE_GUIDE] are still very much subject to change.
+Though the general principles should be mostly in place by now.
 
 [prettier]: https://prettier.io/
 [printWidth]: https://prettier.io/docs/en/options.html#print-width

package/dist/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.printers = exports.parsers = exports.languages = exports.options = void 0;
 var sql_parser_cst_1 = require("sql-parser-cst");
 var printSql_1 = require("./printSql");
+var printComment_1 = require("./printComment");
 var embed_1 = require("./embed");
 var utils_1 = require("./utils");
 var transformCst_1 = require("./transform/transformCst");
@@ -42,9 +43,7 @@ exports.printers = {
     "sql-cst": {
         print: printSql_1.printSql,
         embed: embed_1.embed,
-        printComment: function (path) {
-            return path.getValue().text;
-        },
+        printComment: printComment_1.printComment,
         canAttachComment: utils_1.isNode,
         isBlockComment: function (node) { return node.type === "block_comment"; },
     },

package/dist/node_utils.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLanguageClause = exports.isCreateFunctionStmt = 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;
+exports.isLanguageClause = exports.isCreateFunctionStmt = exports.isListExpr = exports.isParenExpr = exports.isAsClause = exports.isArraySubscript = exports.isStringLiteral = exports.isJsonLiteral = exports.isEmpty = exports.isKeyword = exports.isCreateTableStmt = exports.isFuncArgs = exports.isFuncCall = exports.isValuesClause = exports.isProgram = void 0;
 var utils_1 = require("./utils");
 var is = function (type) {
     return function (node) {
         return (0, utils_1.isObject)(node) && node.type === type;
     };
 };
+exports.isProgram = is("program");
 exports.isValuesClause = is("values_clause");
 exports.isFuncCall = is("func_call");
 exports.isFuncArgs = is("func_args");

package/dist/printComment.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printComment = void 0;
+var printComment = function (path) {
+    var node = path.getValue();
+    if (node.type === "line_comment") {
+        if (/^--[^ \t]/.test(node.text)) {
+            return node.text.replace(/^--/, "-- ");
+        }
+        if (/^#[^ \t!]/.test(node.text)) {
+            return node.text.replace(/^#/, "# ");
+        }
+    }
+    return node.text;
+};
+exports.printComment = printComment;

package/dist/print_utils.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.containsNewline = exports.join = exports.stripTrailingHardline = exports.breakParent = exports.ifBreak = exports.lineSuffix = exports.group = exports.indent = exports.softline = exports.hardline = exports.line = void 0;
+exports.hasEmptyLineBetweenNodes = exports.containsNewline = exports.join = exports.stripTrailingHardline = exports.breakParent = exports.ifBreak = exports.lineSuffix = exports.group = exports.indent = exports.softline = exports.hardline = exports.line = void 0;
 var prettier_1 = require("prettier");
 var utils_1 = require("./utils");
 exports.line = (_a = prettier_1.doc.builders, _a.line), exports.hardline = _a.hardline, exports.softline = _a.softline, exports.indent = _a.indent, exports.group = _a.group, exports.lineSuffix = _a.lineSuffix, exports.ifBreak = _a.ifBreak, exports.breakParent = _a.breakParent;
@@ -20,3 +20,10 @@ var containsNewline = function (node, opts) {
     return prettier_1.util.hasNewlineInRange(opts.originalText, node.range[0], node.range[1]);
 };
 exports.containsNewline = containsNewline;
+var hasEmptyLineBetweenNodes = function (node1, node2, opts) {
+    if (!node1.range || !node2.range) {
+        throw new Error("emptyLineBetweenNodes() expects Nodes with range info");
+    }
+    return /\n[ \t]*\r?\n/.test(opts.originalText.slice(node1.range[1], node2.range[0]));
+};
+exports.hasEmptyLineBetweenNodes = hasEmptyLineBetweenNodes;

package/dist/syntax/bigquery.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.bigqueryMap = void 0;
 var print_utils_1 = require("../print_utils");
 exports.bigqueryMap = {
-    bigquery_options: function (print) { return print(["optionsKw", "options"]); },
+    bigquery_options: function (print) { return print.spaced(["optionsKw", "options"]); },
     bigquery_option_default_collate: function (print) {
         return print.spaced(["defaultCollateKw", "collation"]);
     },
@@ -91,4 +91,34 @@ exports.bigqueryMap = {
             print("actions"),
         ]);
     },
+    alter_capacity_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, [
+            print.spaced(["alterCapacityKw", "name"]),
+            print("actions"),
+        ]);
+    },
+    alter_reservation_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, [
+            print.spaced(["alterReservationKw", "name"]),
+            print("actions"),
+        ]);
+    },
+    // ASSERT
+    assert_stmt: function (print) { return print.spaced(["assertKw", "expr", "as"]); },
+    // EXPORT
+    export_data_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray(__spreadArray([
+            print.spaced("exportDataKw")
+        ], print.spaced(["withConnection"]), true), [
+            print.spaced("options"),
+            print.spaced("as"),
+        ], false));
+    },
+    // LOAD
+    load_data_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray([
+            print.spaced(["loadDataKw", "intoKw", "table", "columns"])
+        ], print("clauses"), true));
+    },
+    from_files_options: function (print) { return print.spaced(["fromFilesKw", "options"]); },
 };

package/dist/syntax/dcl.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dclMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.dclMap = {
+    grant_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, [
+            (0, print_utils_1.group)([print("grantKw"), (0, print_utils_1.indent)([print_utils_1.line, print("roles")])]),
+            (0, print_utils_1.group)(print.spaced(["onKw", "resourceType", "resourceName"])),
+            (0, print_utils_1.group)([print("toKw"), (0, print_utils_1.indent)([print_utils_1.line, print("users")])]),
+        ]);
+    },
+    revoke_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, [
+            (0, print_utils_1.group)([print("revokeKw"), (0, print_utils_1.indent)([print_utils_1.line, print("roles")])]),
+            (0, print_utils_1.group)(print.spaced(["onKw", "resourceType", "resourceName"])),
+            (0, print_utils_1.group)([print("fromKw"), (0, print_utils_1.indent)([print_utils_1.line, print("users")])]),
+        ]);
+    },
+};

package/dist/syntax/expr.js

@@ -65,10 +65,24 @@ exports.exprMap = {
         print_utils_1.hardline,
         print("endKw"),
     ]; },
-    case_when: function (print) {
+    case_when: function (print, node) {
+        if ((0, node_utils_1.isProgram)(node.result)) {
+            return [
+                print.spaced(["whenKw", "condition", "thenKw"]),
+                (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("result"))]),
+            ];
+        }
         return print.spaced(["whenKw", "condition", "thenKw", "result"]);
     },
-    case_else: function (print) { return print.spaced(["elseKw", "result"]); },
+    case_else: function (print, node) {
+        if ((0, node_utils_1.isProgram)(node.result)) {
+            return [
+                print("elseKw"),
+                (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("result"))]),
+            ];
+        }
+        return print.spaced(["elseKw", "result"]);
+    },
     member_expr: function (print, node) {
         return (0, node_utils_1.isArraySubscript)(node.property)
             ? print(["object", "property"])

package/dist/syntax/prepared_statements.js

@@ -0,0 +1,25 @@
+"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.preparedStatementsMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.preparedStatementsMap = {
+    execute_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray([
+            (0, print_utils_1.group)([
+                print.spaced(["executeKw", "immediateKw"]),
+                (0, print_utils_1.indent)([print_utils_1.line, print("expr")]),
+            ])
+        ], print(["into", "using"]).map(function (clause) { return (0, print_utils_1.group)(clause); }), true));
+    },
+    execute_into_clause: function (print) { return print.spaced(["intoKw", "variables"]); },
+    execute_using_clause: function (print) { return print.spaced(["usingKw", "values"]); },
+};

package/dist/syntax/procedural_language.js

@@ -1,12 +1,119 @@
 "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.proceduralLanguageMap = void 0;
 var print_utils_1 = require("../print_utils");
 exports.proceduralLanguageMap = {
-    block_stmt: function (print) { return [
+    // BEGIN .. END
+    block_stmt: function (print, node) { return [
         print("beginKw"),
         (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("program"))]),
+        node.exception ? [print_utils_1.hardline, print("exception")] : [],
         print_utils_1.hardline,
         print("endKw"),
     ]; },
+    exception_clause: function (print) { return [
+        print.spaced(["exceptionKw", "whenKw", "condition", "thenKw"]),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("program"))]),
+    ]; },
+    error_category: function (print) { return print("errorKw"); },
+    // DECLARE
+    declare_stmt: function (print) {
+        return (0, print_utils_1.join)(" ", __spreadArray([
+            print("declareKw"),
+            (0, print_utils_1.group)(print("names"))
+        ], print.spaced(["dataType", "default"]), true));
+    },
+    declare_default: function (print) { return print.spaced(["defaultKw", "expr"]); },
+    // SET
+    set_stmt: function (print) { return print.spaced(["setKw", "assignments"]); },
+    // IF
+    if_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray(__spreadArray([], print("clauses"), true), [print.spaced("endIfKw")], false));
+    },
+    if_clause: function (print) { return [
+        (0, print_utils_1.group)([
+            print("ifKw"),
+            (0, print_utils_1.indent)([print_utils_1.line, print("condition")]),
+            print_utils_1.line,
+            print("thenKw"),
+        ]),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("consequent"))]),
+    ]; },
+    elseif_clause: function (print) { return [
+        (0, print_utils_1.group)([
+            print("elseifKw"),
+            (0, print_utils_1.indent)([print_utils_1.line, print("condition")]),
+            print_utils_1.line,
+            print("thenKw"),
+        ]),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("consequent"))]),
+    ]; },
+    else_clause: function (print) { return [
+        print("elseKw"),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("consequent"))]),
+    ]; },
+    // CASE
+    case_stmt: function (print) { return [
+        print.spaced(["caseKw", "expr"]),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.join)(print_utils_1.hardline, print("clauses"))]),
+        print_utils_1.hardline,
+        print.spaced("endCaseKw"),
+    ]; },
+    // LOOP
+    loop_stmt: function (print) { return [
+        print("loopKw"),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("body"))]),
+        print_utils_1.hardline,
+        print.spaced("endLoopKw"),
+    ]; },
+    // REPEAT
+    repeat_stmt: function (print) { return [
+        print("repeatKw"),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("body"))]),
+        print_utils_1.hardline,
+        print.spaced(["untilKw", "condition", "endRepeatKw"]),
+    ]; },
+    // WHILE
+    while_stmt: function (print) { return [
+        print.spaced(["whileKw", "condition", "doKw"]),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("body"))]),
+        print_utils_1.hardline,
+        print.spaced("endWhileKw"),
+    ]; },
+    // FOR .. IN
+    for_stmt: function (print) { return [
+        print.spaced(["forKw", "left", "inKw", "right", "doKw"]),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(print("body"))]),
+        print_utils_1.hardline,
+        print.spaced("endForKw"),
+    ]; },
+    // BREAK/CONTINUE
+    break_stmt: function (print) { return print.spaced(["breakKw", "label"]); },
+    continue_stmt: function (print) { return print.spaced(["continueKw", "label"]); },
+    labeled_stmt: function (print, node) { return [
+        print("beginLabel"),
+        ": ",
+        print("statement"),
+        node.endLabel ? [" ", print(["endLabel"])] : [],
+    ]; },
+    // CALL
+    call_stmt: function (print) { return print.spaced(["callKw", "func"]); },
+    // RETURN
+    return_stmt: function (print) { return print("returnKw"); },
+    // RAISE
+    raise_stmt: function (print) { return print.spaced(["raiseKw", "message"]); },
+    raise_message: function (print) { return [
+        print.spaced("usingMessageKw"),
+        " = ",
+        print("string"),
+    ]; },
 };

package/dist/syntax/program.js

@@ -3,19 +3,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.programMap = void 0;
 var print_utils_1 = require("../print_utils");
 exports.programMap = {
-    program: function (print, node) {
+    program: function (print, node, path, options) {
         return print("statements").map(function (doc, i) {
-            return printStatement(doc, i, node.statements);
+            return printStatement(doc, i, node.statements, options);
         });
     },
 };
-var printStatement = function (doc, i, statements) {
+var printStatement = function (doc, i, statements, options) {
+    var prevNode = statements[i - 1];
     var node = statements[i];
     if (i === 0) {
         return doc;
     }
     else if (node.type !== "empty") {
-        return [";", print_utils_1.hardline, print_utils_1.hardline, doc];
+        if ((0, print_utils_1.hasEmptyLineBetweenNodes)(prevNode, node, options)) {
+            return [";", print_utils_1.hardline, print_utils_1.hardline, doc];
+        }
+        else {
+            return [";", print_utils_1.hardline, doc];
+        }
     }
     else {
         return [";", print_utils_1.hardline, doc];

package/dist/syntax/transformMap.js

@@ -20,6 +20,7 @@ var bigquery_1 = require("./bigquery");
 var constraint_1 = require("./constraint");
 var create_table_1 = require("./create_table");
 var data_type_1 = require("./data_type");
+var dcl_1 = require("./dcl");
 var delete_1 = require("./delete");
 var drop_table_1 = require("./drop_table");
 var explain_1 = require("./explain");
@@ -29,6 +30,7 @@ var function_1 = require("./function");
 var index_1 = require("./index");
 var insert_1 = require("./insert");
 var merge_1 = require("./merge");
+var prepared_statements_1 = require("./prepared_statements");
 var procedural_language_1 = require("./procedural_language");
 var procedure_1 = require("./procedure");
 var proc_clause_1 = require("./proc_clause");
@@ -41,4 +43,4 @@ 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(__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), function_1.functionMap), index_1.indexMap), insert_1.insertMap), merge_1.mergeMap), proc_clause_1.procClauseMap), procedural_language_1.proceduralLanguageMap), procedure_1.procedureMap), program_1.programMap), schema_1.schemaMap), select_1.selectMap), sqlite_1.sqliteMap), transaction_1.transactionMap), trigger_1.triggerMap), 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(__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), dcl_1.dclMap), delete_1.deleteMap), drop_table_1.dropTableMap), explain_1.explainMap), expr_1.exprMap), frame_1.frameMap), function_1.functionMap), index_1.indexMap), insert_1.insertMap), merge_1.mergeMap), prepared_statements_1.preparedStatementsMap), proc_clause_1.procClauseMap), procedural_language_1.proceduralLanguageMap), procedure_1.procedureMap), program_1.programMap), schema_1.schemaMap), select_1.selectMap), sqlite_1.sqliteMap), transaction_1.transactionMap), trigger_1.triggerMap), truncate_1.truncateMap), update_1.updateMap), view_1.viewMap);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.7.0",
+  "version": "0.8.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.14.0"
+    "sql-parser-cst": "^0.14.1"
   },
   "devDependencies": {
     "@types/jest": "^29.2.5",