prettier-plugin-sql-cst 0.10.1 → 0.10.2

package/README.md

@@ -103,6 +103,20 @@ There are also some SQL-specific options:
 | `sqlKeywordCase` | `upper` | Converts SQL keywords to `upper` or `lower` case, or `preserve` existing. |
 | `sqlParamTypes`  |  `[]`   | Array of bound parameter types: `?`, `?nr`, `:name`, `@name`, `$name`.    |
 
+## FAQ
+
+### The SQL dialect I'm using is not supported. Can you add support for it?
+
+Support for new SQL dialects depends on these dialects being supported by [sql-parser-cst][].
+If you really want to, you can open a new issue for that in the parser repo.
+But be aware that implementing parser support for new dialects takes a lot of work.
+As long as the ongoing implementation of PostgreSQL, MySQL and MariaDB is not finished,
+it's unlikely that work on any other dialect will start.
+
+### How can I format SQL strings inside JavaScript files?
+
+Use [prettier-plugin-embed][] together with `prettier-plugin-sql-cst`.
+
 ## Limitations and development status
 
 Currently this plugin supports two SQL dialects:
@@ -132,4 +146,5 @@ Though the general principles should be mostly in place by now.
 [useTabs]: https://prettier.io/docs/en/options.html#tabs
 [sql-parser-cst]: https://github.com/nene/sql-parser-cst
 [wadler-prettier]: http://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf
+[prettier-plugin-embed]: https://github.com/Sec-ant/prettier-plugin-embed
 [STYLE_GUIDE]: ./STYLE_GUIDE.md

package/dist/PrintFn.d.ts

@@ -8,6 +8,8 @@ export type PrintFn<T, K = PrintableKey<T>> = {
     (path: K[]): Doc[];
     spaced(path: K): Doc[];
     spaced(path: K[]): Doc[];
+    separated(separator: Doc, path: K): Doc[];
+    separated(separator: Doc, path: K[]): Doc[];
 };
 export type PrintableKey<T> = Exclude<keyof T, ReservedKey>;
 type ReservedKey = "type" | "range" | "leading" | "trailing";

package/dist/printSql.js

@@ -28,7 +28,7 @@ function createPrintFn(path, oldPrint) {
             return oldPrint(selector);
         }
     });
-    cachedPrintFn.spaced = function (selector) {
+    cachedPrintFn.separated = function (separator, selector) {
         var node = path.getValue();
         var docs = (0, utils_1.arrayWrap)(selector)
             .filter(function (sel) { return (0, utils_1.isDefined)(node[sel]); })
@@ -43,8 +43,9 @@ function createPrintFn(path, oldPrint) {
             var sel = _a[0], doc = _a[1];
             return ((0, utils_1.isArray)(node[sel]) ? (0, print_utils_1.join)(" ", doc) : doc);
         });
-        return docs.length > 0 ? [(0, print_utils_1.join)(" ", docs)] : [];
+        return docs.length > 0 ? [(0, print_utils_1.join)(separator, docs)] : [];
     };
+    cachedPrintFn.spaced = function (selector) { return cachedPrintFn.separated(" ", selector); };
     return cachedPrintFn;
 }
 function printNode(path, options, print) {

package/dist/syntax/dialects/postgresql.d.ts

@@ -1,3 +1,3 @@
 import { AllPostgresqlNodes } from "sql-parser-cst";
 import { CstToDocMap } from "../../CstToDocMap";
-export declare const postgresqlMap: Partial<CstToDocMap<AllPostgresqlNodes>>;
+export declare const postgresqlMap: CstToDocMap<AllPostgresqlNodes>;

package/dist/syntax/insert.js

@@ -17,7 +17,10 @@ exports.insertMap = {
     default: function (print) { return print("defaultKw"); },
     default_values: function (print) { return print.spaced("defaultValuesKw"); },
     upsert_clause: function (print) {
-        return print.spaced(["onConflictKw", "columns", "where", "doKw", "action"]);
+        return print.spaced(["onConflictKw", "conflictTarget", "where", "doKw", "action"]);
+    },
+    conflict_target_on_constraint: function (print) {
+        return print.spaced(["onConstraintKw", "constraint"]);
     },
     upsert_action_nothing: function (print) { return print("nothingKw"); },
     upsert_action_update: function (print) { return [
@@ -32,4 +35,5 @@ exports.insertMap = {
         print.spaced("onDuplicateKeyUpdateKw"),
         (0, print_utils_1.indent)([print_utils_1.hardline, print("assignments")]),
     ]; },
+    overriding_clause: function (print) { return print.spaced("overridingKw"); },
 };

package/dist/syntax/merge.js

@@ -1,23 +1,15 @@
 "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([
+    merge_stmt: function (print) { return (0, print_utils_1.join)(print_utils_1.line, print("clauses")); },
+    merge_clause: function (print) {
+        return (0, print_utils_1.join)(print_utils_1.line, [
             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));
+            (0, print_utils_1.group)([print("onKw"), (0, print_utils_1.indent)([print_utils_1.line, print("condition")])]),
+        ]);
     },
     merge_when_clause: function (print, node) { return [
         (0, print_utils_1.group)([
@@ -35,8 +27,9 @@ exports.mergeMap = {
             node.columns ? (0, print_utils_1.indent)([print_utils_1.hardline, print("columns")]) : [],
         ]),
         print_utils_1.line,
-        (0, print_utils_1.group)(print("values")),
+        (0, print_utils_1.join)(print_utils_1.hardline, print("clauses")),
     ]; },
     merge_action_insert_row_clause: function (print) { return print("rowKw"); },
     merge_action_update: function (print) { return print.spaced(["updateKw", "set"]); },
+    merge_action_do_nothing: function (print) { return print.spaced(["doNothingKw"]); },
 };

package/dist/syntax/other_clauses.d.ts

@@ -0,0 +1,3 @@
+import { AllOtherClauses } from "sql-parser-cst";
+import { CstToDocMap } from "../CstToDocMap";
+export declare const otherClausesMap: CstToDocMap<AllOtherClauses>;

package/dist/syntax/other_clauses.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.otherClausesMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.otherClausesMap = {
+    // CLUSTER BY clause
+    cluster_by_clause: function (print) {
+        return (0, print_utils_1.group)([print.spaced("clusterByKw"), (0, print_utils_1.indent)([print_utils_1.line, print("columns")])]);
+    },
+    // RETURNING clause
+    returning_clause: function (print) {
+        return (0, print_utils_1.group)([print("returningKw"), (0, print_utils_1.indent)([print_utils_1.line, print("columns")])]);
+    },
+    // WHERE CURRENT OF clause
+    where_current_of_clause: function (print) {
+        return print.spaced(["whereCurrentOfKw", "cursor"]);
+    },
+};

package/dist/syntax/rename_table.d.ts

@@ -0,0 +1,3 @@
+import { AllRenameTableNodes } from "sql-parser-cst";
+import { CstToDocMap } from "../CstToDocMap";
+export declare const renameTableMap: CstToDocMap<AllRenameTableNodes>;

package/dist/syntax/rename_table.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renameTableMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.renameTableMap = {
+    rename_table_stmt: function (print) {
+        return (0, print_utils_1.group)([
+            print.spaced(["renameKw", "tableKw"]),
+            (0, print_utils_1.indent)([print_utils_1.line, print("actions")]),
+        ]);
+    },
+    rename_action: function (print) { return print.spaced(["from", "toKw", "to"]); },
+};

package/dist/syntax/select.js

@@ -1,13 +1,4 @@
 "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.selectMap = void 0;
 var utils_1 = require("../utils");
@@ -33,7 +24,7 @@ exports.selectMap = {
         print.spaced(["asKw", "materializedKw", "expr"]),
         (0, print_utils_1.group)([
             node.search || node.cycle
-                ? (0, print_utils_1.indent)([print_utils_1.line, (0, print_utils_1.join)(print_utils_1.line, print(["search", "cycle"]))])
+                ? (0, print_utils_1.indent)([print_utils_1.line, print.separated(print_utils_1.line, ["search", "cycle"])])
                 : [],
         ]),
     ]; },
@@ -161,12 +152,7 @@ exports.selectMap = {
     order_by_clause: function (print, node) {
         return (0, print_utils_1.group)([
             print.spaced("orderByKw"),
-            (0, print_utils_1.indent)([
-                print_utils_1.line,
-                (0, print_utils_1.join)(print_utils_1.line, __spreadArray([
-                    print("specifications")
-                ], (node.withRollupKw ? print.spaced("withRollupKw") : []), true)),
-            ]),
+            (0, print_utils_1.indent)([print_utils_1.line, print.separated(print_utils_1.line, ["specifications", "withRollupKw"])]),
         ]);
     },
     sort_specification: function (print) {
@@ -181,12 +167,7 @@ exports.selectMap = {
     group_by_clause: function (print, node) {
         return (0, print_utils_1.group)([
             print.spaced(["groupByKw", "distinctKw"]),
-            (0, print_utils_1.indent)([
-                print_utils_1.line,
-                (0, print_utils_1.join)(print_utils_1.line, __spreadArray([
-                    print("columns")
-                ], (node.withRollupKw ? print.spaced("withRollupKw") : []), true)),
-            ]),
+            (0, print_utils_1.indent)([print_utils_1.line, print.separated(print_utils_1.line, ["columns", "withRollupKw"])]),
         ]);
     },
     group_by_rollup: function (print) { return print(["rollupKw", "columns"]); },
@@ -201,10 +182,6 @@ exports.selectMap = {
             (0, print_utils_1.indent)([print_utils_1.line, print("specifications")]),
         ]);
     },
-    // CLUSTER BY clause
-    cluster_by_clause: function (print) {
-        return (0, print_utils_1.group)([print.spaced("clusterByKw"), (0, print_utils_1.indent)([print_utils_1.line, print("columns")])]);
-    },
     // HAVING clause
     having_clause: function (print) {
         return (0, print_utils_1.group)([print("havingKw"), (0, print_utils_1.indent)([print_utils_1.line, print("expr")])]);
@@ -213,10 +190,6 @@ exports.selectMap = {
     qualify_clause: function (print) {
         return (0, print_utils_1.group)([print("qualifyKw"), (0, print_utils_1.indent)([print_utils_1.line, print("expr")])]);
     },
-    // RETURNING clause
-    returning_clause: function (print) {
-        return (0, print_utils_1.group)([print("returningKw"), (0, print_utils_1.indent)([print_utils_1.line, print("columns")])]);
-    },
     // LIMIT clause
     limit_clause: function (print, node) {
         return (0, print_utils_1.group)([

package/dist/syntax/transformMap.d.ts

@@ -1,3 +1,3 @@
 import { Node } from "sql-parser-cst";
 import { CstToDocMap } from "../CstToDocMap";
-export declare const transformMap: Partial<CstToDocMap<Node>>;
+export declare const transformMap: CstToDocMap<Node>;

package/dist/syntax/transformMap.js

@@ -29,6 +29,8 @@ var function_1 = require("./function");
 var index_1 = require("./index");
 var insert_1 = require("./insert");
 var merge_1 = require("./merge");
+var other_clauses_1 = require("./other_clauses");
+var rename_table_1 = require("./rename_table");
 var prepared_statements_1 = require("./prepared_statements");
 var procedural_language_1 = require("./procedural_language");
 var procedure_1 = require("./procedure");
@@ -45,4 +47,4 @@ var bigquery_1 = require("./dialects/bigquery");
 var mysql_1 = require("./dialects/mysql");
 var sqlite_1 = require("./dialects/sqlite");
 var postgresql_1 = require("./dialects/postgresql");
-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(__assign(__assign({}, alias_1.aliasMap), alter_table_1.alterTableMap), analyze_1.analyzeMap), base_1.baseMap), 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), transaction_1.transactionMap), trigger_1.triggerMap), truncate_1.truncateMap), update_1.updateMap), view_1.viewMap), bigquery_1.bigqueryMap), mysql_1.mysqlMap), postgresql_1.postgresqlMap), sqlite_1.sqliteMap);
+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(__assign(__assign(__assign(__assign({}, alias_1.aliasMap), alter_table_1.alterTableMap), analyze_1.analyzeMap), base_1.baseMap), 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), other_clauses_1.otherClausesMap), prepared_statements_1.preparedStatementsMap), proc_clause_1.procClauseMap), procedural_language_1.proceduralLanguageMap), procedure_1.procedureMap), program_1.programMap), rename_table_1.renameTableMap), schema_1.schemaMap), select_1.selectMap), transaction_1.transactionMap), trigger_1.triggerMap), truncate_1.truncateMap), update_1.updateMap), view_1.viewMap), bigquery_1.bigqueryMap), mysql_1.mysqlMap), postgresql_1.postgresqlMap), sqlite_1.sqliteMap);

package/dist/syntax/trigger.js

@@ -22,7 +22,7 @@ exports.triggerMap = {
                 "name",
             ]),
             print("event")
-        ], (node.forEachRowKw ? [print.spaced(["forEachRowKw"])] : []), true), (node.condition ? [print(["condition"])] : []), true), [
+        ], print.spaced(["forEachRowKw"]), true), print(["condition"]), true), [
             print("body"),
         ], false));
     },

package/dist/syntax/truncate.js

@@ -1,6 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.truncateMap = void 0;
+var print_utils_1 = require("../print_utils");
 exports.truncateMap = {
-    truncate_stmt: function (print) { return print.spaced(["truncateKw", "tableKw", "table"]); },
+    truncate_stmt: function (print) {
+        return (0, print_utils_1.group)([
+            print.spaced(["truncateKw", "tableKw"]),
+            (0, print_utils_1.indent)([
+                print_utils_1.line,
+                print.separated(print_utils_1.line, [
+                    "tables",
+                    "restartOrContinueKw",
+                    "cascadeOrRestrictKw",
+                ]),
+            ]),
+        ]);
+    },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.10.1",
+  "version": "0.10.2",
   "description": "Prettier plugin for SQL",
   "author": "Rene Saarsoo <nene@triin.net>",
   "license": "GPL-3.0-or-later",
@@ -32,7 +32,7 @@
   ],
   "dependencies": {
     "prettier": "^3.0.3",
-    "sql-parser-cst": "^0.21.1"
+    "sql-parser-cst": "^0.22.1"
   },
   "devDependencies": {
     "@types/jest": "^29.2.5",