prettier-plugin-sql-cst 0.6.0 → 0.7.0

package/README.md

@@ -96,21 +96,14 @@ There are also some SQL-specific options:
 | API Option       | Default | Description                                                               |
 | ---------------- | :-----: | ------------------------------------------------------------------------- |
 | `sqlKeywordCase` | `upper` | Converts SQL keywords to `upper` or `lower` case, or `preserve` existing. |
+| `sqlParamTypes`  |  `[]`   | Array of bound parameter types: `?`, `?nr`, `:name`, `@name`, `$name`.    |
 
 ## Limitations and development status
 
-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:
+Currently this plugin supports two SQL dialects:
 
-- SELECT
-- UPDATE
-- INSERT
-- DELETE
-- TRUNCATE
-- CREATE / DROP / ALTER TABLE
-- CREATE / DROP VIEW
-- transactions (BEGIN, COMMIT, ROLLBACK)
+- **SQLite** - full support.
+- **BigQuery** - most of the common SQL syntax is supported (see [#2][] for implementation progress).
 
 [prettier]: https://prettier.io/
 [printWidth]: https://prettier.io/docs/en/options.html#print-width
@@ -119,3 +112,4 @@ Specifically the formatting of the following BigQuery SQL statements is fully im
 [sql-parser-cst]: https://github.com/nene/sql-parser-cst
 [wadler-prettier]: http://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf
 [STYLE_GUIDE]: ./STYLE_GUIDE.md
+[#2]: https://github.com/nene/prettier-plugin-sql-cst/issues/2

package/dist/embed.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.embed = void 0;
+var embedJs_1 = require("./embedJs");
+var embedJson_1 = require("./embedJson");
+var embed = function () {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    return embedJson_1.embedJson.apply(void 0, args) || embedJs_1.embedJs.apply(void 0, args);
+};
+exports.embed = embed;

package/dist/embedJs.js

@@ -0,0 +1,53 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.embedJs = void 0;
+var node_utils_1 = require("./node_utils");
+var print_utils_1 = require("./print_utils");
+var embedJs = function (path, print, textToDoc, options) {
+    var node = path.getValue();
+    var parent = path.getParentNode(0);
+    var grandParent = path.getParentNode(1);
+    if ((0, node_utils_1.isStringLiteral)(node) &&
+        (0, node_utils_1.isAsClause)(parent) &&
+        (0, node_utils_1.isCreateFunctionStmt)(grandParent) &&
+        grandParent.clauses.some(isJavaScriptLanguageClause)) {
+        var quotes = detectQuotes(node.value);
+        if (!quotes) {
+            // Give up for now. Don't format JavaScript inside the string.
+            // Perhaps tackle this corner-case in the future.
+            return null;
+        }
+        var js = textToDoc(node.value, __assign(__assign({}, options), { parser: "babel" }));
+        return [
+            quotes[0],
+            (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.stripTrailingHardline)(js)]),
+            print_utils_1.hardline,
+            quotes[1],
+        ];
+    }
+    return null;
+};
+exports.embedJs = embedJs;
+var isJavaScriptLanguageClause = function (clause) { return (0, node_utils_1.isLanguageClause)(clause) && clause.name.name === "js"; };
+// Whether to quote the code with single- or double-quotes.
+// Returns undefined when neither can be used without escaping.
+var detectQuotes = function (js) {
+    if (!/'''/.test(js)) {
+        return ["r'''", "'''"];
+    }
+    if (!/"""/.test(js)) {
+        return ['r"""', '"""'];
+    }
+    return undefined;
+};

package/dist/index.js

@@ -3,7 +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 embedJson_1 = require("./embedJson");
+var embed_1 = require("./embed");
 var utils_1 = require("./utils");
 var transformCst_1 = require("./transform/transformCst");
 var options_1 = require("./options");
@@ -27,6 +27,7 @@ var createParser = function (dialect) { return ({
             includeRange: true,
             includeComments: true,
             filename: options.filepath,
+            paramTypes: options.sqlParamTypes,
         }), text);
     },
     astFormat: "sql-cst",
@@ -40,7 +41,7 @@ exports.parsers = {
 exports.printers = {
     "sql-cst": {
         print: printSql_1.printSql,
-        embed: embedJson_1.embedJson,
+        embed: embed_1.embed,
         printComment: function (path) {
             return path.getValue().text;
         },

package/dist/node_utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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 = void 0;
 var utils_1 = require("./utils");
 var is = function (type) {
     return function (node) {
@@ -19,3 +19,5 @@ exports.isArraySubscript = is("array_subscript");
 exports.isAsClause = is("as_clause");
 exports.isParenExpr = is("paren_expr");
 exports.isListExpr = is("list_expr");
+exports.isCreateFunctionStmt = is("create_function_stmt");
+exports.isLanguageClause = is("language_clause");

package/dist/options.js

@@ -17,4 +17,13 @@ exports.options = {
             { value: "lower", description: "forces all keywords to lowercase" },
         ],
     },
+    sqlParamTypes: {
+        type: "string",
+        array: true,
+        category: "SQL",
+        since: "0.7.0",
+        default: [{ value: [] }],
+        description: "Syntax for bound parameters",
+        // Possible values in array: "?" | "?nr" | ":name" | "$name" | "@name"
+    },
 };

package/dist/syntax/bigquery.js

@@ -1,9 +1,94 @@
 "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.bigqueryMap = void 0;
+var print_utils_1 = require("../print_utils");
 exports.bigqueryMap = {
     bigquery_options: function (print) { return print(["optionsKw", "options"]); },
     bigquery_option_default_collate: function (print) {
         return print.spaced(["defaultCollateKw", "collation"]);
     },
+    // ROW ACCESS POLICY
+    create_row_access_policy_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray([
+            print.spaced([
+                "createKw",
+                "orReplaceKw",
+                "rowAccessPolicyKw",
+                "ifNotExistsKw",
+                "name",
+                "onKw",
+                "table",
+            ])
+        ], print("clauses"), true));
+    },
+    row_access_policy_grant_clause: function (print) {
+        return print.spaced(["grantToKw", "grantees"]);
+    },
+    row_access_policy_filter_clause: function (print) {
+        return print.spaced(["filterUsingKw", "expr"]);
+    },
+    drop_row_access_policy_stmt: function (print) {
+        return print.spaced([
+            "dropKw",
+            "allKw",
+            "rowAccessPolicyKw",
+            "ifExistsKw",
+            "name",
+            "onKw",
+            "table",
+        ]);
+    },
+    // CAPACITY
+    create_capacity_stmt: function (print) { return [
+        print.spaced(["createKw", "capacityKw", "name"]),
+        print_utils_1.hardline,
+        print("options"),
+    ]; },
+    drop_capacity_stmt: function (print) {
+        return print.spaced(["dropKw", "capacityKw", "ifExistsKw", "name"]);
+    },
+    // RESERVATION
+    create_reservation_stmt: function (print) { return [
+        print.spaced(["createKw", "reservationKw", "name"]),
+        print_utils_1.hardline,
+        print("options"),
+    ]; },
+    drop_reservation_stmt: function (print) {
+        return print.spaced(["dropKw", "reservationKw", "ifExistsKw", "name"]);
+    },
+    // ASSIGNMENT
+    create_assignment_stmt: function (print) { return [
+        print.spaced(["createKw", "assignmentKw", "name"]),
+        print_utils_1.hardline,
+        print("options"),
+    ]; },
+    drop_assignment_stmt: function (print) {
+        return print.spaced(["dropKw", "assignmentKw", "ifExistsKw", "name"]);
+    },
+    // ALTER ORGANIZATION
+    alter_organization_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, [print.spaced("alterOrganizationKw"), print("actions")]);
+    },
+    // ALTER PROJECT
+    alter_project_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, [
+            print.spaced(["alterProjectKw", "name"]),
+            print("actions"),
+        ]);
+    },
+    alter_bi_capacity_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, [
+            print.spaced(["alterBiCapacityKw", "name"]),
+            print("actions"),
+        ]);
+    },
 };

package/dist/syntax/expr.js

@@ -122,6 +122,7 @@ exports.exprMap = {
     json_literal: function (print) { return print.spaced(["jsonKw", "string"]); },
     identifier: function (print) { return print("text"); },
     variable: function (print) { return print("text"); },
+    parameter: function (print) { return print("text"); },
 };
 var isBooleanOp = function (_a) {
     var name = _a.name;

package/dist/syntax/function.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.functionMap = void 0;
+var print_utils_1 = require("../print_utils");
+var node_utils_1 = require("../node_utils");
+exports.functionMap = {
+    create_function_stmt: function (print, node) { return [
+        print.spaced([
+            "createKw",
+            "orReplaceKw",
+            "temporaryKw",
+            "tableKw",
+            "functionKw",
+            "ifNotExistsKw",
+            "name",
+        ]),
+        print("params"),
+        hasOnlyAsClause(node)
+            ? [" ", (0, print_utils_1.group)(print("clauses"))]
+            : [
+                print_utils_1.hardline,
+                (0, print_utils_1.join)(print_utils_1.hardline, print("clauses").map(function (cls) { return (0, print_utils_1.group)(cls); })),
+            ],
+    ]; },
+    function_param: function (print) { return print.spaced(["name", "dataType"]); },
+    drop_function_stmt: function (print) {
+        return print.spaced(["dropKw", "tableKw", "functionKw", "ifExistsKw", "name"]);
+    },
+};
+var hasOnlyAsClause = function (node) {
+    return node.clauses.length === 1 && (0, node_utils_1.isAsClause)(node.clauses[0]);
+};

package/dist/syntax/index.js

@@ -27,6 +27,15 @@ exports.indexMap = {
         ], (node.clauses.length > 0 ? [(0, print_utils_1.join)(print_utils_1.hardline, print("clauses"))] : []), true));
     },
     drop_index_stmt: function (print) {
-        return print.spaced(["dropKw", "indexKw", "ifExistsKw", "indexes"]);
+        return print.spaced([
+            "dropKw",
+            "indexTypeKw",
+            "indexKw",
+            "ifExistsKw",
+            "indexes",
+            "onKw",
+            "table",
+        ]);
     },
+    verbose_all_columns: function (print) { return print.spaced("allColumnsKw"); },
 };

package/dist/syntax/merge.js

@@ -0,0 +1,42 @@
+"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.mergeMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.mergeMap = {
+    merge_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.line, __spreadArray([
+            print.spaced(["mergeKw", "intoKw", "target"]),
+            print.spaced(["usingKw", "source"]),
+            (0, print_utils_1.group)([print("onKw"), (0, print_utils_1.indent)([print_utils_1.line, print("condition")])])
+        ], print("clauses").map(function (clause) { return (0, print_utils_1.group)(clause); }), true));
+    },
+    merge_when_clause: function (print, node) { return [
+        (0, print_utils_1.group)([
+            print.spaced(["whenKw", "matchedKw", "byKw"]),
+            node.condition ? (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.group)(print("action"))]),
+    ]; },
+    merge_when_condition: function (print) { return print.spaced(["andKw", "expr"]); },
+    merge_action_delete: function (print) { return print("deleteKw"); },
+    merge_action_insert: function (print, node) { return [
+        (0, print_utils_1.group)([
+            print("insertKw"),
+            node.columns ? (0, print_utils_1.indent)([print_utils_1.hardline, print("columns")]) : [],
+        ]),
+        print_utils_1.line,
+        (0, print_utils_1.group)(print("values")),
+    ]; },
+    merge_action_insert_row_clause: function (print) { return print("rowKw"); },
+    merge_action_update: function (print) { return print.spaced(["updateKw", "set"]); },
+};

package/dist/syntax/proc_clause.js

@@ -1,9 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.procClauseMap = void 0;
+var node_utils_1 = require("../node_utils");
 var print_utils_1 = require("../print_utils");
 exports.procClauseMap = {
-    as_clause: function (print) { return [print("asKw"), (0, print_utils_1.indent)([print_utils_1.hardline, print("expr")])]; },
+    returns_clause: function (print) { return print.spaced(["returnsKw", "dataType"]); },
+    determinism_clause: function (print) { return print.spaced("deterministicKw"); },
+    language_clause: function (print) { return print.spaced(["languageKw", "name"]); },
+    as_clause: function (print, node) {
+        if ((0, node_utils_1.isStringLiteral)(node.expr)) {
+            return print.spaced(["asKw", "expr"]);
+        }
+        return [print("asKw"), (0, print_utils_1.indent)([print_utils_1.hardline, print("expr")])];
+    },
     with_connection_clause: function (print) {
         return print.spaced(["withConnectionKw", "connection"]);
     },

package/dist/syntax/procedure.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.procedureMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.procedureMap = {
+    create_procedure_stmt: function (print, node) { return [
+        print.spaced([
+            "createKw",
+            "orReplaceKw",
+            "procedureKw",
+            "ifNotExistsKw",
+            "name",
+        ]),
+        print("params"),
+        print_utils_1.hardline,
+        (0, print_utils_1.join)(print_utils_1.hardline, print("clauses").map(function (clause) { return (0, print_utils_1.group)(clause); })),
+    ]; },
+    procedure_param: function (print) { return print.spaced(["mode", "name", "dataType"]); },
+    drop_procedure_stmt: function (print) {
+        return print.spaced(["dropKw", "procedureKw", "ifExistsKw", "name"]);
+    },
+};

package/dist/syntax/schema.js

@@ -0,0 +1,28 @@
+"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.schemaMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.schemaMap = {
+    create_schema_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray([
+            print.spaced(["createSchemaKw", "ifNotExistsKw", "name"])
+        ], print("options"), true));
+    },
+    drop_schema_stmt: function (print) {
+        return print.spaced(["dropSchemaKw", "ifExistsKw", "name", "behaviorKw"]);
+    },
+    alter_schema_stmt: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray([
+            print.spaced(["alterSchemaKw", "ifExistsKw", "name"])
+        ], print("actions"), true));
+    },
+};

package/dist/syntax/transformMap.js

@@ -25,11 +25,15 @@ var drop_table_1 = require("./drop_table");
 var explain_1 = require("./explain");
 var expr_1 = require("./expr");
 var frame_1 = require("./frame");
+var function_1 = require("./function");
 var index_1 = require("./index");
 var insert_1 = require("./insert");
+var merge_1 = require("./merge");
 var procedural_language_1 = require("./procedural_language");
+var procedure_1 = require("./procedure");
 var proc_clause_1 = require("./proc_clause");
 var program_1 = require("./program");
+var schema_1 = require("./schema");
 var select_1 = require("./select");
 var sqlite_1 = require("./sqlite");
 var transaction_1 = require("./transaction");
@@ -37,4 +41,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({}, 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);
+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);

package/dist/syntax/view.js

@@ -24,4 +24,9 @@ exports.viewMap = {
     drop_view_stmt: function (print) {
         return print.spaced(["dropKw", "materializedKw", "viewKw", "ifExistsKw", "views"]);
     },
+    alter_view_stmt: function (print) { return [
+        print.spaced(["alterKw", "materializedKw", "viewKw", "ifExistsKw", "name"]),
+        print_utils_1.hardline,
+        (0, print_utils_1.join)(print_utils_1.hardline, print("actions")),
+    ]; },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.6.0",
+  "version": "0.7.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.13.0"
+    "sql-parser-cst": "^0.14.0"
   },
   "devDependencies": {
     "@types/jest": "^29.2.5",