prettier-plugin-sql-cst 0.1.1 → 0.2.0

package/README.md

@@ -53,26 +53,27 @@ for your editor of choice.
 
 ## Configuration
 
-The standard Prettier options apply. There's also one SQL-specific option:
+The standard Prettier options [printWidth][], [tabWidth][], [useTabs][] apply.
+There are also some SQL-specific options:
 
 | API Option       |  Default   | Description                                            |
 | ---------------- | :--------: | ------------------------------------------------------ |
-| `printWidth`     |    `80`    | [Same as in Prettier][prettier-print-width]            |
-| `tabWidth`       |    `2`     | [Same as in Prettier][prettier-tab-width]              |
-| `useTabs`        |  `false`   | [Same as in Prettier][prettier-use-tabs]               |
 | `sqlKeywordCase` | `preserve` | Converts SQL keywords to `upper` or `lower` case.      |
 | `sqlAliasAs`     | `preserve` | Uses AS keyword in aliases either `always` or `never`. |
 
 ## Limitations and development status
 
-Currently this plugin only supports subset of **SQLite** syntax.
+Currently this plugin supports most of **SQLite** syntax.
+(It also supports some **BigQuery**, but only the syntax that's subset of SQLite.)
 Formatting of the following SQL statements is fully implemented:
 
 - SELECT
 - UPDATE
 - INSERT
 - DELETE
-- CREATE TABLE
+- CREATE / DROP / ALTER TABLE
+- CREATE / DROP VIEW
+- CREATE / DROP INDEX
 
 Unlike Prettier for JavaScript, this plugin currently preserves all the syntax elements.
 For example it does not add/remove paratheses or modify the case of keywords (by default).
@@ -91,8 +92,8 @@ The overall goal is to have no options to configure different styles,
 but rather to develop one opinionated style of formatting SQL.
 
 [prettier]: https://prettier.io/
-[prettier-print-width]: https://prettier.io/docs/en/options.html#print-width
-[prettier-tab-width]: https://prettier.io/docs/en/options.html#tab-width
-[prettier-use-tabs]: https://prettier.io/docs/en/options.html#tabs
+[printWidth]: https://prettier.io/docs/en/options.html#print-width
+[tabWidth]: https://prettier.io/docs/en/options.html#tab-width
+[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

package/dist/index.js

@@ -4,31 +4,37 @@ exports.printers = exports.parsers = exports.languages = exports.options = void
 var sql_parser_cst_1 = require("sql-parser-cst");
 var printSql_1 = require("./printSql");
 var utils_1 = require("./utils");
-var comments_1 = require("./comments");
-var aliasAs_1 = require("./aliasAs");
+var transformCst_1 = require("./transform/transformCst");
 var options_1 = require("./options");
 Object.defineProperty(exports, "options", { enumerable: true, get: function () { return options_1.options; } });
 exports.languages = [
     {
-        extensions: [".sql"],
-        name: "SQL",
-        parsers: ["sql-parser-cst"],
+        extensions: [".sql", ".sqlite"],
+        name: "SQLite SQL",
+        parsers: ["sql-parser-cst-sqlite"],
+    },
+    {
+        extensions: [".bigquery"],
+        name: "BigQuery SQL",
+        parsers: ["sql-parser-cst-bigquery"],
     },
 ];
-exports.parsers = {
-    "sql-parser-cst": {
-        parse: function (text, parsers, options) {
-            return (0, comments_1.moveCommentsToRoot)((0, aliasAs_1.processAliasAs)((0, sql_parser_cst_1.parse)(text, {
-                dialect: "sqlite",
-                includeRange: true,
-                includeComments: true,
-                filename: options.filepath,
-            }), options));
-        },
-        astFormat: "sql-cst",
-        locStart: function (node) { var _a; return (_a = node.range) === null || _a === void 0 ? void 0 : _a[0]; },
-        locEnd: function (node) { var _a; return (_a = node.range) === null || _a === void 0 ? void 0 : _a[1]; },
+var createParser = function (dialect) { return ({
+    parse: function (text, parsers, options) {
+        return (0, transformCst_1.transformCst)((0, sql_parser_cst_1.parse)(text, {
+            dialect: dialect,
+            includeRange: true,
+            includeComments: true,
+            filename: options.filepath,
+        }), options);
     },
+    astFormat: "sql-cst",
+    locStart: function (node) { var _a; return (_a = node.range) === null || _a === void 0 ? void 0 : _a[0]; },
+    locEnd: function (node) { var _a; return (_a = node.range) === null || _a === void 0 ? void 0 : _a[1]; },
+}); };
+exports.parsers = {
+    "sql-parser-cst-sqlite": createParser("sqlite"),
+    "sql-parser-cst-bigquery": createParser("bigquery"),
 };
 exports.printers = {
     "sql-cst": {

package/dist/printSql.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.printSql = void 0;
 var utils_1 = require("./utils");
-var syntax_1 = require("./syntax");
+var transformMap_1 = require("./syntax/transformMap");
 var print_utils_1 = require("./print_utils");
 function printSql(path, options, oldPrint) {
     return printNode(path, options, createPrintFn(path, oldPrint));
@@ -58,7 +58,7 @@ function printNode(path, options, print) {
     if (!(node === null || node === void 0 ? void 0 : node.type)) {
         throw new Error("No type field on node: ".concat(JSON.stringify(node)));
     }
-    var fn = syntax_1.transformMap[node.type];
+    var fn = transformMap_1.transformMap[node.type];
     if (!fn) {
         throw new Error("Unexpected node type: ".concat(node.type));
     }

package/dist/syntax/alter_table.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.alterTableMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.alterTableMap = {
+    alter_table_stmt: function (print) { return [
+        print.spaced(["alterTableKw", "table"]),
+        print_utils_1.hardline,
+        print("actions"),
+    ]; },
+    alter_action_rename_table: function (print) { return print.spaced(["renameKw", "newName"]); },
+    alter_action_rename_column: function (print) {
+        return print.spaced(["renameKw", "oldName", "toKw", "newName"]);
+    },
+    alter_action_add_column: function (print) { return print.spaced(["addKw", "column"]); },
+    alter_action_drop_column: function (print) { return print.spaced(["dropKw", "column"]); },
+};

package/dist/syntax/drop_table.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dropTableMap = void 0;
+exports.dropTableMap = {
+    drop_table_stmt: function (print) {
+        return print.spaced(["dropKw", "tableKw", "ifExistsKw", "tables"]);
+    },
+};

package/dist/syntax/expr.js

@@ -44,6 +44,7 @@ exports.exprMap = {
     },
     case_else: function (print) { return print.spaced(["elseKw", "result"]); },
     member_expr: function (print) { return [print("object"), ".", print("property")]; },
+    bigquery_quoted_member_expr: function (print) { return ["`", print("expr"), "`"]; },
     func_call: function (print) {
         var fnCall = print(["name", "args"]);
         var extras = print(["filter", "over"]);

package/dist/syntax/index.js

@@ -1,28 +1,32 @@
 "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];
+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 t;
-    };
-    return __assign.apply(this, arguments);
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformMap = void 0;
-var alias_1 = require("./alias");
-var base_1 = require("./base");
-var constraint_1 = require("./constraint");
-var create_table_1 = require("./create_table");
-var data_type_1 = require("./data_type");
-var delete_1 = require("./delete");
-var expr_1 = require("./expr");
-var frame_1 = require("./frame");
-var insert_1 = require("./insert");
-var proc_clause_1 = require("./proc_clause");
-var program_1 = require("./program");
-var select_1 = require("./select");
-var update_1 = require("./update");
-exports.transformMap = __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, alias_1.aliasMap), base_1.baseMap), constraint_1.constraintMap), create_table_1.createTableMap), data_type_1.dataTypeMap), delete_1.deleteMap), expr_1.exprMap), frame_1.frameMap), insert_1.insertMap), proc_clause_1.procClauseMap), program_1.programMap), select_1.selectMap), update_1.updateMap);
+exports.indexMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.indexMap = {
+    create_index_stmt: function (print, node) {
+        return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray([
+            print.spaced([
+                "createKw",
+                "indexTypeKw",
+                "indexKw",
+                "ifNotExistsKw",
+                "name",
+                "onKw",
+                "table",
+                "columns",
+            ])
+        ], (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"]);
+    },
+};

package/dist/syntax/program.js

@@ -12,7 +12,7 @@ var printLineWith = function (print) {
             return print(childPath);
         }
         else if (i < all.length - 1 || node.type !== "empty") {
-            return [";", print_utils_1.hardline, print(childPath)];
+            return [";", print_utils_1.hardline, print_utils_1.hardline, print(childPath)];
         }
         else {
             return [";", print(childPath)];

package/dist/syntax/select.js

@@ -28,6 +28,8 @@ exports.selectMap = {
             (0, print_utils_1.indent)([print_utils_1.line, print("columns")]),
         ]);
     },
+    except_columns: function (print) { return print.spaced(["expr", "exceptKw", "columns"]); },
+    replace_columns: function (print) { return print.spaced(["expr", "replaceKw", "columns"]); },
     from_clause: function (print) {
         return (0, print_utils_1.group)([print("fromKw"), (0, print_utils_1.indent)([print_utils_1.line, print("expr")])]);
     },

package/dist/syntax/transformMap.js

@@ -0,0 +1,32 @@
+"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.transformMap = void 0;
+var alias_1 = require("./alias");
+var alter_table_1 = require("./alter_table");
+var base_1 = require("./base");
+var constraint_1 = require("./constraint");
+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 expr_1 = require("./expr");
+var frame_1 = require("./frame");
+var index_1 = require("./index");
+var insert_1 = require("./insert");
+var proc_clause_1 = require("./proc_clause");
+var program_1 = require("./program");
+var select_1 = require("./select");
+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({}, alias_1.aliasMap), alter_table_1.alterTableMap), base_1.baseMap), 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), update_1.updateMap), view_1.viewMap);

package/dist/syntax/view.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.viewMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.viewMap = {
+    create_view_stmt: function (print) { return [
+        print.spaced([
+            "createKw",
+            "temporaryKw",
+            "viewKw",
+            "ifNotExistsKw",
+            "name",
+            "columns",
+            "asKw",
+        ]),
+        (0, print_utils_1.indent)([print_utils_1.hardline, (0, print_utils_1.group)(print("expr"))]),
+    ]; },
+    drop_view_stmt: function (print) {
+        return print.spaced(["dropKw", "viewKw", "ifExistsKw", "views"]);
+    },
+};

package/dist/{comments.js → transform/comments.js}

@@ -21,7 +21,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.moveCommentsToRoot = void 0;
-var visitAllNodes_1 = require("./visitAllNodes");
+var visitAllNodes_1 = require("../visitAllNodes");
 /**
  * Gathers comments from .leading and .trailing fields of all nodes
  * into a single .comments field in root Program node.

package/dist/transform/transformCst.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformCst = void 0;
+var comments_1 = require("./comments");
+var aliasAs_1 = require("./aliasAs");
+var transformCst = function (cst, options) { return (0, comments_1.moveCommentsToRoot)((0, aliasAs_1.processAliasAs)(cst, options)); };
+exports.transformCst = transformCst;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Prettier plugin for SQL",
   "author": "Rene Saarsoo <nene@triin.net>",
   "license": "GPL-3.0-or-later",