prettier-plugin-sql-cst 0.2.0 → 0.3.0

package/README.md

@@ -40,6 +40,24 @@ ORDER BY client.name
 LIMIT 100
 ```
 
+## Formatting philosophy
+
+- Adapt formatting based on expression length.
+- Stick to one style and avoid configuration options.
+- Format embedded languages (like JSON data and JavaScript programs).
+- When unsure, preserve existing syntax.
+
+## Non-whitespace formatting
+
+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.
+
+There are some opinionated non-whitespace changes though:
+
+- UPPERCASE all keywords.
+- Add `AS` keyword to all alias definitions.
+
 ## Getting started
 
 Install it as any other Prettier plugin:
@@ -51,15 +69,39 @@ npm install --save-dev prettier prettier-plugin-sql-cst
 Then use it on SQL files though Prettier command line tool or Prettier extension
 for your editor of choice.
 
+## Choosing an SQL dialect
+
+By default the plugin will determine SQL dialect based on file extension:
+
+- `.sql` or `.sqlite` - SQLite
+- `.bigquery` - BigQuery
+
+You can override this behavior with a prettier configuration:
+
+```json
+{
+  "overrides": [
+    {
+      "files": ["*.sql"],
+      "options": { "parser": "bigquery" }
+    }
+  ]
+}
+```
+
+The plugin provides the following parsers:
+
+- `sqlite`
+- `bigquery`
+
 ## Configuration
 
 The standard Prettier options [printWidth][], [tabWidth][], [useTabs][] apply.
 There are also some SQL-specific options:
 
-| API Option       |  Default   | Description                                            |
-| ---------------- | :--------: | ------------------------------------------------------ |
-| `sqlKeywordCase` | `preserve` | Converts SQL keywords to `upper` or `lower` case.      |
-| `sqlAliasAs`     | `preserve` | Uses AS keyword in aliases either `always` or `never`. |
+| API Option       | Default | Description                                                               |
+| ---------------- | :-----: | ------------------------------------------------------------------------- |
+| `sqlKeywordCase` | `upper` | Converts SQL keywords to `upper` or `lower` case, or `preserve` existing. |
 
 ## Limitations and development status
 
@@ -75,22 +117,6 @@ Formatting of the following SQL statements is fully implemented:
 - 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).
-It only manipulates whitespace.
-
-This will likely change in the future, with the goal of being more opinionated.
-Some possibilities:
-
-- capitalize all keywords
-- ensure all alias definitions use the `AS` keyword.
-- ensure consistent use of quotes (e.g. always quote keywords)
-- eliminate redundant parenthesis.
-
-The exact formatting style is also very much still in flux.
-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/
 [printWidth]: https://prettier.io/docs/en/options.html#print-width
 [tabWidth]: https://prettier.io/docs/en/options.html#tab-width

package/dist/embedJson.js

@@ -0,0 +1,43 @@
+"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.embedJson = void 0;
+var node_utils_1 = require("./node_utils");
+var print_utils_1 = require("./print_utils");
+var embedJson = function (path, print, textToDoc, options) {
+    var node = path.getValue();
+    var parent = path.getParentNode();
+    if ((0, node_utils_1.isStringLiteral)(node) && (0, node_utils_1.isJsonLiteral)(parent)) {
+        if (containsTripleQuote(node.value) ||
+            containsBackslash(node.value) ||
+            isRawString(node)) {
+            // Give up for now. Don't format JSON inside the string.
+            // Tackle these corner-case in the future.
+            return null;
+        }
+        var json = textToDoc(node.value, __assign(__assign({}, options), { parser: "json" }));
+        var inlineQuote = containsSingleQuote(node.value) ? "'''" : "'";
+        return [
+            (0, print_utils_1.ifBreak)("'''", inlineQuote),
+            (0, print_utils_1.indent)([print_utils_1.softline, (0, print_utils_1.stripTrailingHardline)(json)]),
+            print_utils_1.softline,
+            (0, print_utils_1.ifBreak)("'''", inlineQuote),
+        ];
+    }
+    return null;
+};
+exports.embedJson = embedJson;
+var containsSingleQuote = function (json) { return /'/.test(json); };
+var containsTripleQuote = function (json) { return /'''/.test(json); };
+var containsBackslash = function (json) { return /\\/.test(json); };
+var isRawString = function (node) { return /^R/i.test(node.text); };

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 embedJson_1 = require("./embedJson");
 var utils_1 = require("./utils");
 var transformCst_1 = require("./transform/transformCst");
 var options_1 = require("./options");
@@ -11,12 +12,12 @@ exports.languages = [
     {
         extensions: [".sql", ".sqlite"],
         name: "SQLite SQL",
-        parsers: ["sql-parser-cst-sqlite"],
+        parsers: ["sqlite"],
     },
     {
         extensions: [".bigquery"],
         name: "BigQuery SQL",
-        parsers: ["sql-parser-cst-bigquery"],
+        parsers: ["bigquery"],
     },
 ];
 var createParser = function (dialect) { return ({
@@ -33,12 +34,13 @@ var createParser = function (dialect) { return ({
     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"),
+    sqlite: createParser("sqlite"),
+    bigquery: createParser("bigquery"),
 };
 exports.printers = {
     "sql-cst": {
         print: printSql_1.printSql,
+        embed: embedJson_1.embedJson,
         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.isKeyword = exports.isCreateTableStmt = exports.isFuncCall = exports.isValuesClause = void 0;
+exports.isStringLiteral = exports.isJsonLiteral = exports.isEmpty = exports.isKeyword = exports.isCreateTableStmt = exports.isFuncCall = exports.isValuesClause = void 0;
 var utils_1 = require("./utils");
 var is = function (type) {
     return function (node) {
@@ -11,3 +11,6 @@ exports.isValuesClause = is("values_clause");
 exports.isFuncCall = is("func_call");
 exports.isCreateTableStmt = is("create_table_stmt");
 exports.isKeyword = is("keyword");
+exports.isEmpty = is("empty");
+exports.isJsonLiteral = is("json_literal");
+exports.isStringLiteral = is("string_literal");

package/dist/options.js

@@ -6,7 +6,7 @@ exports.options = {
         type: "choice",
         category: "SQL",
         since: "0.1.0",
-        default: "preserve",
+        default: "upper",
         description: "Enforces upper/lower case for SQL keywords",
         choices: [
             {
@@ -17,16 +17,4 @@ exports.options = {
             { value: "lower", description: "forces all keywords to lowercase" },
         ],
     },
-    sqlAliasAs: {
-        type: "choice",
-        category: "SQL",
-        since: "0.1.1",
-        default: "preserve",
-        description: "Enforce or forbid use of AS keyword in aliases",
-        choices: [
-            { value: "preserve", description: "keeps existing style" },
-            { value: "always", description: "always includes AS keyword" },
-            { value: "never", description: "never include AS keyword" },
-        ],
-    },
 };

package/dist/print_utils.js

@@ -1,11 +1,12 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.containsNewline = exports.join = exports.lineSuffix = exports.group = exports.indent = exports.softline = exports.hardline = exports.line = void 0;
+exports.containsNewline = exports.join = exports.stripTrailingHardline = 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.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;
 var origJoin = prettier_1.doc.builders.join;
+exports.stripTrailingHardline = prettier_1.doc.utils.stripTrailingHardline;
 /** Improved join() that also accepts a non-array docs parameter */
 var join = function (sep, docs) {
     return (0, utils_1.isArray)(docs) ? origJoin(sep, docs) : docs;

package/dist/syntax/data_type.js

@@ -12,4 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.dataTypeMap = void 0;
 exports.dataTypeMap = {
     data_type: function (print) { return __spreadArray([print.spaced("nameKw")], print(["params"]), true); },
+    generic_type_params: function (print) { return ["<", print("params"), ">"]; },
+    array_type_param: function (print) { return print("dataType"); },
+    struct_type_param: function (print) { return print.spaced(["name", "dataType"]); },
 };

package/dist/syntax/expr.js

@@ -12,10 +12,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.exprMap = void 0;
 var print_utils_1 = require("../print_utils");
 var node_utils_1 = require("../node_utils");
+var utils_1 = require("../utils");
 exports.exprMap = {
     list_expr: function (print, node, path) {
         var parent = path.getParentNode();
-        return (0, print_utils_1.join)([",", (0, node_utils_1.isValuesClause)(parent) ? print_utils_1.hardline : print_utils_1.line], print("items").map(function (it) { return (0, print_utils_1.group)(it); }));
+        var children = print("items").map(function (it) { return (0, print_utils_1.group)(it); });
+        var lineType = (0, node_utils_1.isValuesClause)(parent) ? print_utils_1.hardline : print_utils_1.line;
+        // When last item is type:empty, we're dealing with a trailing comma.
+        // Don't add a space (or newline) after it.
+        // We still want to print it though, as it might have comments attached.
+        if ((0, node_utils_1.isEmpty)((0, utils_1.last)(node.items))) {
+            return [
+                (0, print_utils_1.join)([",", lineType], children.slice(0, -1)),
+                ",",
+                (0, utils_1.last)(children),
+            ];
+        }
+        else {
+            return (0, print_utils_1.join)([",", lineType], children);
+        }
     },
     paren_expr: function (print, node, path) {
         var parent = path.getParentNode();
@@ -28,7 +43,9 @@ exports.exprMap = {
         }
         return print.spaced(["left", "operator", "right"]);
     },
-    prefix_op_expr: function (print) { return print.spaced(["operator", "expr"]); },
+    prefix_op_expr: function (print, node) {
+        return ((0, utils_1.isString)(node.operator) ? print : print.spaced)(["operator", "expr"]);
+    },
     postfix_op_expr: function (print) { return print.spaced(["expr", "operator"]); },
     between_expr: function (print) {
         return print.spaced(["left", "betweenKw", "begin", "andKw", "end"]);
@@ -61,10 +78,28 @@ exports.exprMap = {
     cast_expr: function (print) { return print(["castKw", "args"]); },
     cast_arg: function (print) { return print.spaced(["expr", "asKw", "dataType"]); },
     raise_expr: function (print) { return print(["raiseKw", "args"]); },
+    interval_expr: function (print) { return print.spaced(["intervalKw", "expr", "unit"]); },
+    interval_unit_range: function (print) {
+        return print.spaced(["fromUnitKw", "toKw", "toUnitKw"]);
+    },
+    array_expr: function (print) {
+        return (0, print_utils_1.group)(["[", (0, print_utils_1.indent)([print_utils_1.softline, print("expr")]), print_utils_1.softline, "]"]);
+    },
+    struct_expr: function (print) {
+        return (0, print_utils_1.group)(["(", (0, print_utils_1.indent)([print_utils_1.softline, print("expr")]), print_utils_1.softline, ")"]);
+    },
+    typed_expr: function (print) { return print(["dataType", "expr"]); },
     number_literal: function (print) { return print("text"); },
     boolean_literal: function (print) { return print("valueKw"); },
     string_literal: function (print) { return print("text"); },
     null_literal: function (print) { return print("nullKw"); },
+    numeric_literal: function (print) { return print.spaced(["numericKw", "string"]); },
+    bignumeric_literal: function (print) { return print.spaced(["bignumericKw", "string"]); },
+    date_literal: function (print) { return print.spaced(["dateKw", "string"]); },
+    time_literal: function (print) { return print.spaced(["timeKw", "string"]); },
+    datetime_literal: function (print) { return print.spaced(["datetimeKw", "string"]); },
+    timestamp_literal: function (print) { return print.spaced(["timestampKw", "string"]); },
+    json_literal: function (print) { return print.spaced(["jsonKw", "string"]); },
     identifier: function (print) { return print("text"); },
 };
 var isBooleanOp = function (_a) {

package/dist/syntax/program.js

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

package/dist/syntax/select.js

@@ -24,7 +24,7 @@ exports.selectMap = {
     ]; },
     select_clause: function (print) {
         return (0, print_utils_1.group)([
-            print.spaced(["selectKw", "distinctKw"]),
+            print.spaced(["selectKw", "distinctKw", "asStructOrValueKw"]),
             (0, print_utils_1.indent)([print_utils_1.line, print("columns")]),
         ]);
     },
@@ -66,6 +66,7 @@ exports.selectMap = {
     group_by_clause: function (print) {
         return (0, print_utils_1.group)([print.spaced("groupByKw"), (0, print_utils_1.indent)([print_utils_1.line, print("columns")])]);
     },
+    group_by_rollup: function (print) { return print(["rollupKw", "columns"]); },
     partition_by_clause: function (print) {
         return (0, print_utils_1.group)([
             print.spaced("partitionByKw"),
@@ -75,6 +76,9 @@ exports.selectMap = {
     having_clause: function (print) {
         return (0, print_utils_1.group)([print("havingKw"), (0, print_utils_1.indent)([print_utils_1.line, print("expr")])]);
     },
+    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: function (print) {
         return (0, print_utils_1.group)([print("returningKw"), (0, print_utils_1.indent)([print_utils_1.line, print("columns")])]);
     },

package/dist/transform/aliasAs.js

@@ -1,36 +1,12 @@
 "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.processAliasAs = void 0;
 var sql_parser_cst_1 = require("sql-parser-cst");
-var processAliasAs = function (cst, options) {
+// Adds AS keyword to aliases if none exists
+var processAliasAs = function (cst) {
     var mutateAliases = (0, sql_parser_cst_1.cstVisitor)({
         alias: function (node) {
-            var _a, _b;
-            switch (options.sqlAliasAs) {
-                case "preserve":
-                    // do nothing
-                    break;
-                case "always":
-                    // Add AS keyword if none exists
-                    node.asKw = node.asKw || { type: "keyword", name: "AS", text: "AS" };
-                    break;
-                case "never":
-                    // Remove AS keyword and ensure comments attached to it don't get lost
-                    if (node.asKw && (((_a = node.leading) === null || _a === void 0 ? void 0 : _a.length) || ((_b = node.trailing) === null || _b === void 0 ? void 0 : _b.length))) {
-                        var comments = __spreadArray(__spreadArray([], (node.leading || []), true), (node.trailing || []), true);
-                        node.alias.leading = __spreadArray(__spreadArray([], comments, true), (node.alias.leading || []), true);
-                    }
-                    node.asKw = undefined;
-            }
+            node.asKw = node.asKw || { type: "keyword", name: "AS", text: "AS" };
         },
     });
     mutateAliases(cst);

package/dist/transform/transformCst.js

@@ -3,5 +3,5 @@ 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)); };
+var transformCst = function (cst, options) { return (0, comments_1.moveCommentsToRoot)((0, aliasAs_1.processAliasAs)(cst)); };
 exports.transformCst = transformCst;

package/dist/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.arrayWrap = exports.isNode = exports.isEmptyArray = exports.isArray = exports.isObject = exports.isString = exports.isDefined = void 0;
+exports.last = exports.arrayWrap = exports.isNode = exports.isEmptyArray = exports.isArray = exports.isObject = exports.isString = exports.isDefined = void 0;
 var isDefined = function (value) {
     return value !== undefined;
 };
@@ -26,3 +26,5 @@ var isCommentType = function (type) {
 };
 var arrayWrap = function (x) { return ((0, exports.isArray)(x) ? x : [x]); };
 exports.arrayWrap = arrayWrap;
+var last = function (arr) { return arr[arr.length - 1]; };
+exports.last = last;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.2.0",
+  "version": "0.3.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.11.0"
+    "sql-parser-cst": "^0.11.1"
   },
   "devDependencies": {
     "@types/jest": "^29.2.5",