prettier-plugin-bq 0.2.61 → 1.0.0-beta.2

package/dist/printer.js

@@ -1,10 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.printSQL = exports.isNodeVecChild = exports.isNodeChild = void 0;
-const keywords_1 = require("./keywords");
-const prettier_1 = require("prettier");
-const { builders: { breakParent, group, hardline, ifBreak, indent, join, line, lineSuffix, softline, }, } = prettier_1.doc;
-const isNodeChild = (child) => {
+import { reservedKeywords, globalFunctions, keysFunctions, aeadFunctions, hllCountFunctions, kllQuantilesFunctions, netFunctions, objFunctions, mlFunctions, aiFunctions, vectorIndexFunctions, } from "./keywords.js";
+import { doc } from "prettier";
+const { builders: { breakParent, group, hardline, ifBreak, indent, join, line, lineSuffix, softline, }, } = doc;
+export const isNodeChild = (child) => {
     if (child &&
         typeof child === "object" &&
         Object.keys(child).length === 1 &&
@@ -13,8 +10,7 @@ const isNodeChild = (child) => {
     }
     return false;
 };
-exports.isNodeChild = isNodeChild;
-const isNodeVecChild = (child) => {
+export const isNodeVecChild = (child) => {
     if (child &&
         typeof child === "object" &&
         Object.keys(child).length === 1 &&
@@ -23,7 +19,6 @@ const isNodeVecChild = (child) => {
     }
     return false;
 };
-exports.isNodeVecChild = isNodeVecChild;
 class Printer {
     constructor(path, options, print, node) {
         this.path = path;
@@ -35,7 +30,7 @@ class Printer {
     child(key, transform, consumeLeadingComments, sep) {
         const child = this.children[key];
         let f = (x) => x;
-        if ((0, exports.isNodeChild)(child)) {
+        if (isNodeChild(child)) {
             if (typeof transform === "function") {
                 f = transform;
             }
@@ -48,7 +43,7 @@ class Printer {
                 this.path.call((p) => p.call((p) => f(p.call(this.print, "Node")), key), "children"),
             ];
         }
-        else if ((0, exports.isNodeVecChild)(child)) {
+        else if (isNodeVecChild(child)) {
             if (typeof transform === "function") {
                 f = transform;
             }
@@ -67,7 +62,7 @@ class Printer {
     consumeAllCommentsOfX(key) {
         let res = "";
         const child = this.children[key];
-        if ((0, exports.isNodeChild)(child)) {
+        if (isNodeChild(child)) {
             const leading_comments = child.Node.children.leading_comments;
             if (leading_comments) {
                 res = leading_comments.NodeVec.map((x) => lineSuffix([" ", x.token.literal]));
@@ -112,10 +107,10 @@ class Printer {
         else if (target === "all") {
             const child = this.children[key];
             let firstNodes = [];
-            if ((0, exports.isNodeChild)(child)) {
+            if (isNodeChild(child)) {
                 firstNodes = [getFirstNode(child.Node)];
             }
-            else if ((0, exports.isNodeVecChild)(child)) {
+            else if (isNodeVecChild(child)) {
                 firstNodes = child.NodeVec.map((x) => getFirstNode(x));
             }
             const res = [];
@@ -142,10 +137,10 @@ class Printer {
     getFirstNode(key) {
         const child = this.children[key];
         let firstNode;
-        if ((0, exports.isNodeChild)(child)) {
+        if (isNodeChild(child)) {
             firstNode = getFirstNode(child.Node);
         }
-        else if ((0, exports.isNodeVecChild)(child) && child.NodeVec.length > 0) {
+        else if (isNodeVecChild(child) && child.NodeVec.length > 0) {
             firstNode = getFirstNode(child.NodeVec[0]);
         }
         else {
@@ -178,7 +173,7 @@ class Printer {
     }
     len(key) {
         const nodeVec = this.children[key];
-        if ((0, exports.isNodeVecChild)(nodeVec)) {
+        if (isNodeVecChild(nodeVec)) {
             return nodeVec.NodeVec.length;
         }
         return 0;
@@ -204,10 +199,10 @@ class Printer {
             if (upperOrLower === "upper") {
                 literal = literal.toUpperCase();
             }
-            else if (!this.node.notGlobal && this.includedIn(keywords_1.reservedKeywords)) {
+            else if (!this.node.notGlobal && this.includedIn(reservedKeywords)) {
                 literal = literal.toUpperCase();
             }
-            else if (this.options.printPseudoColumnsInUpperCase &&
+            else if (this.options.printKeywordsInUpperCase &&
                 (literal.match(/^_PARTITION/i) ||
                     literal.match(/^_TABLE_/i) ||
                     literal.match(/^_FILE_/i) ||
@@ -231,7 +226,7 @@ class Printer {
     }
     setBreakRecommended(key) {
         const child = this.children[key];
-        if ((0, exports.isNodeChild)(child)) {
+        if (isNodeChild(child)) {
             child.Node.breakRecommended = true;
         }
     }
@@ -242,10 +237,10 @@ class Printer {
          * e.g. when grouping a part of `this.child(key)`.
          */
         const child = this.children[key];
-        if ((0, exports.isNodeChild)(child)) {
+        if (isNodeChild(child)) {
             child.Node.groupRecommended = true;
         }
-        else if ((0, exports.isNodeVecChild)(child)) {
+        else if (isNodeVecChild(child)) {
             child.NodeVec.forEach((x) => {
                 x.groupRecommended = true;
             });
@@ -253,7 +248,7 @@ class Printer {
     }
     setLiteral(key, literal) {
         const child = this.children[key];
-        if ((0, exports.isNodeChild)(child)) {
+        if (isNodeChild(child)) {
             const token = child.Node.token;
             if (token) {
                 token.literal = literal;
@@ -262,10 +257,10 @@ class Printer {
     }
     setNotRoot(key) {
         const child = this.children[key];
-        if ((0, exports.isNodeChild)(child)) {
+        if (isNodeChild(child)) {
             child.Node.notRoot = true;
         }
-        else if ((0, exports.isNodeVecChild)(child)) {
+        else if (isNodeVecChild(child)) {
             child.NodeVec.forEach((x) => {
                 x.notRoot = true;
             });
@@ -273,7 +268,7 @@ class Printer {
     }
     setNotGlobal(key) {
         const child = this.children[key];
-        if ((0, exports.isNodeChild)(child)) {
+        if (isNodeChild(child)) {
             child.Node.notGlobal = true;
         }
     }
@@ -281,7 +276,7 @@ class Printer {
         if (this.hasLeadingComments(key))
             return true;
         const child = this.children[key];
-        if (!(0, exports.isNodeChild)(child))
+        if (!isNodeChild(child))
             return false; // unnexpected pattern
         const token = child.Node.token;
         if (!token)
@@ -308,13 +303,13 @@ class Printer {
         if (!this.options.printKeywordsInUpperCase) {
             return;
         }
-        if ((0, exports.isNodeChild)(child)) {
+        if (isNodeChild(child)) {
             const token = child.Node.token;
             if (token) {
                 token.literal = token.literal.toUpperCase();
             }
         }
-        else if ((0, exports.isNodeVecChild)(child)) {
+        else if (isNodeVecChild(child)) {
             child.NodeVec.forEach((x) => {
                 const token = x.token;
                 if (token) {
@@ -331,10 +326,10 @@ const getFirstNode = (node, includeComment = false) => {
             !includeComment) {
             continue;
         }
-        if ((0, exports.isNodeChild)(v)) {
+        if (isNodeChild(v)) {
             candidates.push(getFirstNode(v.Node, includeComment));
         }
-        else if ((0, exports.isNodeVecChild)(v)) {
+        else if (isNodeVecChild(v)) {
             // NOTE maybe you don't have to check 2nd, 3rd, or latter node
             v.NodeVec.forEach((x) => candidates.push(getFirstNode(x, includeComment)));
         }
@@ -355,40 +350,57 @@ const getFirstNode = (node, includeComment = false) => {
     }
     return res;
 };
-const printSQL = (path, options, print) => {
+const getLastNode = (node, includeComment = false) => {
+    const candidates = [];
+    for (const [k, v] of Object.entries(node.children)) {
+        if (["leading_comments", "trailing_comments"].includes(k) &&
+            !includeComment) {
+            continue;
+        }
+        if (isNodeChild(v)) {
+            candidates.push(getLastNode(v.Node, includeComment));
+        }
+        else if (isNodeVecChild(v)) {
+            // NOTE maybe you don't have to check 2nd, 3rd, or latter node
+            v.NodeVec.forEach((x) => candidates.push(getLastNode(x, includeComment)));
+        }
+    }
+    let res = node;
+    for (const c of candidates) {
+        if (!c.token) {
+            continue;
+        }
+        if (!res.token) {
+            res = c;
+            continue;
+        }
+        if (res.token.line < c.token.line ||
+            (c.token.line === res.token.line && res.token.column < c.token.column)) {
+            res = c;
+        }
+    }
+    return res;
+};
+export const printSQL = (path, options, print) => {
     const node = path.node;
     if (Array.isArray(node)) {
         for (let i = 0; i < node.length - 1; i++) {
-            const endNode = node[i];
-            if ("semicolon" in endNode.children) {
-                // end of statement
-                const semicolon = endNode.children.semicolon;
-                if (semicolon) {
-                    let endLine = semicolon.Node.token.line;
-                    const trailing_comments = semicolon.Node.children.trailing_comments;
-                    if (trailing_comments) {
-                        const comments = trailing_comments.NodeVec;
-                        const len = comments.length;
-                        const last_comments = comments[len - 1];
-                        endLine = last_comments.token.line;
-                        const endLiteral = last_comments.token.literal;
-                        const newLines = endLiteral.match(/\n/g);
-                        if (newLines) {
-                            endLine += newLines.length;
-                        }
-                    }
-                    // start of statement
-                    const startNode = getFirstNode(node[i + 1], true);
-                    let startLine;
-                    if (startNode.token) {
-                        startLine = startNode.token.line;
-                    }
-                    else {
-                        // EOF
-                        startLine = endLine + 1;
-                    }
-                    node[i].emptyLines = startLine - endLine - 1; // >= -1
+            if ("semicolon" in node[i].children ||
+                node[i].node_type === "StandAloneExpr") {
+                const endNode = getLastNode(node[i], true);
+                if (!endNode.token)
+                    continue;
+                const endLine = endNode.token.line;
+                const startNode = getFirstNode(node[i + 1], true);
+                let startLine;
+                if (startNode.token) {
+                    startLine = startNode.token.line;
+                }
+                else {
+                    // EOF
+                    startLine = endLine + 1;
                 }
+                node[i].emptyLines = startLine - endLine - 1; // >= -1
             }
         }
         return path.map(print);
@@ -632,6 +644,8 @@ const printSQL = (path, options, print) => {
             return printSetStatement(path, options, print, node);
         case "SingleTokenStatement":
             return printSingleTokenStatement(path, options, print, node);
+        case "StandAloneExpr":
+            return printStandAloneExpr(path, options, print, node);
         case "StringLiteral":
             return printStringLiteral(path, options, print, node);
         case "StructLiteral":
@@ -644,8 +658,14 @@ const printSQL = (path, options, print) => {
             return printTableSamplePipeOperator(path, options, print, node);
         case "TableSampleRatio":
             return printTableSampleRatio(path, options, print, node);
-        case "Template":
+        case "TemplateExpr":
             return printIdentifier(path, options, print, node);
+        case "TemplateExprContinue":
+            return printTemplateExprContinue(path, options, print, node);
+        case "TemplateExprEnd":
+            return printTemplateExprEnd(path, options, print, node);
+        case "TemplateExprStart":
+            return printTemplateExprStart(path, options, print, node);
         case "TransactionStatement":
             return printTransactionStatement(path, options, print, node);
         case "TrainingDataCustomHolidayClause":
@@ -698,7 +718,6 @@ const printSQL = (path, options, print) => {
             throw new Error(`Not implemented node type: ${JSON.stringify(node)}`);
     }
 };
-exports.printSQL = printSQL;
 const printAccessOperator = (path, options, print, node) => {
     const p = new Printer(path, options, print, node);
     const docs = {
@@ -1531,7 +1550,7 @@ const printCallingFunctionGeneral = (path, options, print, node) => {
     };
     if (func.node_type === "Identifier") {
         // SUBSTR("foo", 0, 2)
-        if (keywords_1.globalFunctions.includes(func.token.literal.toUpperCase())) {
+        if (globalFunctions.includes(func.token.literal.toUpperCase())) {
             func.isPreDefinedFunction = true;
         }
     }
@@ -1543,61 +1562,61 @@ const printCallingFunctionGeneral = (path, options, print, node) => {
             // KEYS.NEW_KEYSET('AEAD_AES_GCM_256')
             switch (parent.token.literal.toUpperCase()) {
                 case "SAFE":
-                    if (keywords_1.globalFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (globalFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
                     break;
                 case "KEYS":
-                    if (keywords_1.keysFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (keysFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
                     break;
                 case "AEAD":
-                    if (keywords_1.aeadFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (aeadFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
                     break;
                 case "NET":
-                    if (keywords_1.netFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (netFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
                     break;
                 case "HLL_COUNT":
-                    if (keywords_1.hllCountFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (hllCountFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
                     break;
                 case "KLL_QUANTILES":
-                    if (keywords_1.kllQuantilesFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (kllQuantilesFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
                     break;
                 case "OBJ":
-                    if (keywords_1.objFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (objFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
                     break;
                 case "ML":
-                    if (keywords_1.mlFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (mlFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
                     break;
                 case "AI":
-                    if (keywords_1.aiFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (aiFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
                     break;
                 case "VECTOR_INDEX":
-                    if (keywords_1.vectorIndexFunctions.includes(func.token.literal.toUpperCase())) {
+                    if (vectorIndexFunctions.includes(func.token.literal.toUpperCase())) {
                         func.isPreDefinedFunction = true;
                         toUpper(parent.token);
                     }
@@ -1611,63 +1630,63 @@ const printCallingFunctionGeneral = (path, options, print, node) => {
             if (grandParent.token.literal.toUpperCase() === "SAFE") {
                 switch (parent.token.literal.toUpperCase()) {
                     case "KEYS":
-                        if (keywords_1.keysFunctions.includes(func.token.literal.toUpperCase())) {
+                        if (keysFunctions.includes(func.token.literal.toUpperCase())) {
                             func.isPreDefinedFunction = true;
                             toUpper(parent.token);
                             toUpper(grandParent.token);
                         }
                         break;
                     case "AEAD":
-                        if (keywords_1.aeadFunctions.includes(func.token.literal.toUpperCase())) {
+                        if (aeadFunctions.includes(func.token.literal.toUpperCase())) {
                             func.isPreDefinedFunction = true;
                             toUpper(parent.token);
                             toUpper(grandParent.token);
                         }
                         break;
                     case "NET":
-                        if (keywords_1.netFunctions.includes(func.token.literal.toUpperCase())) {
+                        if (netFunctions.includes(func.token.literal.toUpperCase())) {
                             func.isPreDefinedFunction = true;
                             toUpper(parent.token);
                             toUpper(grandParent.token);
                         }
                         break;
                     case "HLL_COUNT":
-                        if (keywords_1.hllCountFunctions.includes(func.token.literal.toUpperCase())) {
+                        if (hllCountFunctions.includes(func.token.literal.toUpperCase())) {
                             func.isPreDefinedFunction = true;
                             toUpper(parent.token);
                             toUpper(grandParent.token);
                         }
                         break;
                     case "KLL_QUANTILES":
-                        if (keywords_1.kllQuantilesFunctions.includes(func.token.literal.toUpperCase())) {
+                        if (kllQuantilesFunctions.includes(func.token.literal.toUpperCase())) {
                             func.isPreDefinedFunction = true;
                             toUpper(parent.token);
                             toUpper(grandParent.token);
                         }
                         break;
                     case "OBJ":
-                        if (keywords_1.objFunctions.includes(func.token.literal.toUpperCase())) {
+                        if (objFunctions.includes(func.token.literal.toUpperCase())) {
                             func.isPreDefinedFunction = true;
                             toUpper(parent.token);
                             toUpper(grandParent.token);
                         }
                         break;
                     case "ML":
-                        if (keywords_1.mlFunctions.includes(func.token.literal.toUpperCase())) {
+                        if (mlFunctions.includes(func.token.literal.toUpperCase())) {
                             func.isPreDefinedFunction = true;
                             toUpper(parent.token);
                             toUpper(grandParent.token);
                         }
                         break;
                     case "AI":
-                        if (keywords_1.aiFunctions.includes(func.token.literal.toUpperCase())) {
+                        if (aiFunctions.includes(func.token.literal.toUpperCase())) {
                             func.isPreDefinedFunction = true;
                             toUpper(parent.token);
                             toUpper(grandParent.token);
                         }
                         break;
                     case "VECTOR_INDEX":
-                        if (keywords_1.vectorIndexFunctions.includes(func.token.literal.toUpperCase())) {
+                        if (vectorIndexFunctions.includes(func.token.literal.toUpperCase())) {
                             func.isPreDefinedFunction = true;
                             toUpper(parent.token);
                             toUpper(grandParent.token);
@@ -1684,13 +1703,11 @@ const printCallingFunctionGeneral = (path, options, print, node) => {
             // NORMALIZE
             if (["NORMALIZE", "NORMALIZE_AND_CASEFOLD"].includes(func_literal) &&
                 2 <= p.len("args")) {
-                toUpper(args.NodeVec[1].token);
+                toUpper(args.NodeVec[node.isChained ? 0 : 1].token);
             }
             // XXX_DIFF
             if (["DATE_DIFF", "DATETIME_DIFF", "TIME_DIFF", "TIMESTAMP_DIFF"].includes(func_literal)) {
-                const node = args.NodeVec[2];
-                if (node)
-                    node.isDatePart = true; // not chained function
+                args.NodeVec[node.isChained ? 1 : 2].isDatePart = true;
             }
             // XXX_TRUNC
             if ([
@@ -1699,15 +1716,11 @@ const printCallingFunctionGeneral = (path, options, print, node) => {
                 "TIME_TRUNC",
                 "TIMESTAMP_TRUNC",
             ].includes(func_literal)) {
-                const node = args.NodeVec[1];
-                if (node)
-                    node.isDatePart = true; // not chained function
+                args.NodeVec[node.isChained ? 0 : 1].isDatePart = true;
             }
             // LAST_DAY
             if (func_literal === "LAST_DAY" && 2 <= p.len("args")) {
-                const node = args.NodeVec[1];
-                if (node)
-                    node.isDatePart = true; // not chained function
+                args.NodeVec[node.isChained ? 0 : 1].isDatePart = true;
             }
         }
     }
@@ -2965,6 +2978,7 @@ const printFromStatement = (path, options, print, node) => {
 };
 const printFunctionChain = (path, options, print, node) => {
     const p = new Printer(path, options, print, node);
+    node.children.right.Node.isChained = true;
     const docs = {
         left: p.child("left"),
         leading_comments: printLeadingComments(path, options, print, node),
@@ -4530,6 +4544,14 @@ const printSingleTokenStatement = (path, options, print, node) => {
         p.newLine(),
     ];
 };
+const printStandAloneExpr = (path, options, print, node) => {
+    const p = new Printer(path, options, print, node);
+    const docs = {
+        self: "", // eslint-disable-line unicorn/no-unused-properties
+        expr: p.child("expr"),
+    };
+    return [docs.expr, p.newLine()];
+};
 const printStringLiteral = (path, options, print, node) => {
     const p = new Printer(path, options, print, node);
     const docs = {
@@ -4654,6 +4676,79 @@ const printTableSampleRatio = (path, options, print, node) => {
         docs.rparen,
     ];
 };
+const printTemplateExprContinue = (path, options, print, node) => {
+    const p = new Printer(path, options, print, node);
+    p.setNotRoot("exprs");
+    p.setGroupRecommended("exprs");
+    const docs = {
+        leading_comments: printLeadingComments(path, options, print, node),
+        self: p.self("asItIs"),
+        trailing_comments: printTrailingComments(path, options, print, node),
+        exprs: p.child("exprs", (x) => [line, x]),
+    };
+    return [
+        docs.leading_comments,
+        docs.self,
+        docs.trailing_comments,
+        indent(docs.exprs),
+    ];
+};
+const printTemplateExprEnd = (path, options, print, node) => {
+    const p = new Printer(path, options, print, node);
+    const docs = {
+        leading_comments: printLeadingComments(path, options, print, node),
+        self: p.self("asItIs"),
+        trailing_comments: printTrailingComments(path, options, print, node),
+    };
+    return [docs.leading_comments, docs.self, docs.trailing_comments];
+};
+const printTemplateExprStart = (path, options, print, node) => {
+    const p = new Printer(path, options, print, node);
+    p.setNotRoot("exprs");
+    p.setGroupRecommended("exprs");
+    const docs = {
+        leading_comments: printLeadingComments(path, options, print, node),
+        self: p.self("asItIs"),
+        trailing_comments: printTrailingComments(path, options, print, node),
+        exprs: p.child("exprs", (x) => [line, x]),
+        continues: p.child("continues", (x) => [line, x]),
+        end: p.child("end"),
+        as: "", // eslint-disable-line unicorn/no-unused-properties
+        alias: printAlias(path, options, print, node),
+        order: printOrder(path, options, print, node),
+        null_order: "", // eslint-disable-line unicorn/no-unused-properties
+        // do not use printComma here
+        // additional trailing comma may break your code
+        comma: p.child("comma", undefined, "all"),
+        with_offset: p.child("with_offset", undefined, "all"),
+        pivot: printPivotOrUnpivotOperator(path, options, print, node),
+        unpivot: "", // eslint-disable-line unicorn/no-unused-properties
+        match_recognize: p.child("match_recognize", undefined, "all"),
+    };
+    return [
+        docs.leading_comments,
+        group([
+            docs.self,
+            indent(docs.exprs),
+            docs.continues,
+            0 < p.children.exprs.NodeVec.length ||
+                0 < p.children.continues.NodeVec.length
+                ? line
+                : "",
+            docs.end,
+            docs.trailing_comments,
+            docs.alias,
+            docs.order,
+            docs.pivot,
+            docs.comma,
+            p.has("match_recognize") ? " " : "",
+            docs.match_recognize,
+            p.has("with_offset") ? " " : "",
+            docs.with_offset,
+        ]),
+        p.newLine(),
+    ];
+};
 const printTransactionStatement = (path, options, print, node) => {
     const p = new Printer(path, options, print, node);
     const docs = {