prettier-plugin-bq 1.0.0-beta.1 → 1.0.0-beta.3

package/README.md

@@ -0,0 +1,58 @@
+# prettier-plugin-bq
+
+`prettier-plugin-bq` is a [prettier](https://prettier.io/) plugin for **GoogleSQL**, which is a dialect of BigQuery.
+
+## Features
+
+- support [pipe syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/pipe-syntax)
+- support [procedural language](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) (a.k.a BigQuery Scripting)
+- try to handle jinja templates (though not perfect)
+
+## Install
+
+```
+npm install --save-dev prettier prettier-plugin-bq
+```
+
+## Usage
+
+You can format `.sql` and `.bq` file by the following command.
+
+```
+npx prettier --write ./xxx.sql --plugin=prettier-plugin-bq
+```
+
+If you want to omit `--plugin=prettier-plugin-bq`, add the plugin to your `.prettierrc`.
+
+```jsonc
+// .prettierrc
+{
+  "plugins": ["prettier-plugin-bq"]
+}
+```
+
+For more information, please read the prettier document.
+
+## Configuration
+
+`prettier-plugin-bq` supports the options below.
+
+| API Option               | CLI Option                   | Default | Description                                                                                                    |
+| ------------------------ | ---------------------------- | ------- | -------------------------------------------------------------------------------------------------------------- |
+| indentCte                | indent-cte                   | true    | Indent CTEs in with clause.                                                                                    |
+| printBlankLineAfterCte   | print-blank-line-after-cte   | false   | Print blank line after CTE in with clause.                                                                     |
+| printKeywordsInUpperCase | print-keywords-in-upper-case | true    | Print keywords, built-in functions and pseudo columns (e.g. `_PARTITIONDATE`, `_PARTITIONTIME`) in upper case. |
+
+> [!NOTE]
+>
+> `printPseudoColumnsInUpperCase` was merged into printKeywordsInUpperCase.
+
+## Coding style
+
+This plugin doesn't follow any famous style guides,
+because none of them account for GoogleSQL's latest syntax (such as pipe syntax).
+
+## Feedback
+
+I'm not ready to accept pull requests, but your feedback is always welcome.
+If you find any bugs, please feel free to create an issue.

package/dist/index.d.ts

@@ -1 +1,51 @@
-export {};
+declare const languages: {
+    extensions: string[];
+    name: string;
+    parsers: string[];
+}[];
+declare const parsers: {
+    "sql-parse": {
+        parse: (text: string) => import("bq2cst").UnknownNode[];
+        astFormat: string;
+    };
+};
+declare const printers: {
+    "sql-ast": {
+        print: (path: import("prettier").AstPath, options: {
+            [x: string]: unknown;
+        }, print: (path: import("prettier").AstPath) => import("prettier").Doc) => import("prettier").Doc;
+    };
+};
+declare const options: {
+    formatMultilineComment: {
+        type: string;
+        category: string;
+        default: boolean;
+        description: string;
+    };
+    indentCte: {
+        type: string;
+        category: string;
+        default: boolean;
+        description: string;
+    };
+    printBlankLineAfterCte: {
+        type: string;
+        category: string;
+        default: boolean;
+        description: string;
+    };
+    printKeywordsInUpperCase: {
+        type: string;
+        category: string;
+        default: boolean;
+        description: string;
+    };
+    printPseudoColumnsInUpperCase: {
+        type: string;
+        category: string;
+        default: boolean;
+        description: string;
+    };
+};
+export { languages, parsers, printers, options };

package/dist/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.options = exports.printers = exports.parsers = exports.languages = void 0;
 const bq2cst_1 = require("bq2cst");
 const printer_1 = require("./printer");
 const languages = [
@@ -9,17 +10,20 @@ const languages = [
         parsers: ["sql-parse"],
     },
 ];
+exports.languages = languages;
 const parsers = {
     "sql-parse": {
         parse: (text) => (0, bq2cst_1.parse)(text),
         astFormat: "sql-ast",
     },
 };
+exports.parsers = parsers;
 const printers = {
     "sql-ast": {
         print: printer_1.printSQL,
     },
 };
+exports.printers = printers;
 const CATEGORY_BQ = "BQ";
 const options = {
     formatMultilineComment: {
@@ -44,19 +48,14 @@ const options = {
         type: "boolean",
         category: CATEGORY_BQ,
         default: true,
-        description: "Print reserved keywords and functions in upper case.",
+        description: "Print keywords, built-in functions and pseudo columns in upper case.",
     },
     printPseudoColumnsInUpperCase: {
         type: "boolean",
         category: CATEGORY_BQ,
         default: true,
-        description: "Print pseudo columns in upper case.",
+        description: "Deprecated: This option was merged into printKeywordsInUpperCase.",
     },
 };
-module.exports = {
-    languages,
-    parsers,
-    printers,
-    options,
-};
+exports.options = options;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,mCAA+B;AAC/B,uCAAqC;AAErC,MAAM,SAAS,GAAG;IAChB;QACE,UAAU,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,CAAC,WAAW,CAAC;KACvB;CACF,CAAC;AAEF,MAAM,OAAO,GAAG;IACd,WAAW,EAAE;QACX,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAA,cAAK,EAAC,IAAI,CAAC;QACpC,SAAS,EAAE,SAAS;KACrB;CACF,CAAC;AAEF,MAAM,QAAQ,GAAG;IACf,SAAS,EAAE;QACT,KAAK,EAAE,kBAAQ;KAChB;CACF,CAAC;AAEF,MAAM,WAAW,GAAG,IAAI,CAAC;AAEzB,MAAM,OAAO,GAAG;IACd,sBAAsB,EAAE;QACtB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,2BAA2B;KACzC;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,4BAA4B;KAC1C;IACD,sBAAsB,EAAE;QACtB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,4CAA4C;KAC1D;IACD,wBAAwB,EAAE;QACxB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,sDAAsD;KACpE;IACD,6BAA6B,EAAE;QAC7B,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,qCAAqC;KACnD;CACF,CAAC;AAEF,MAAM,CAAC,OAAO,GAAG;IACf,SAAS;IACT,OAAO;IACP,QAAQ;IACR,OAAO;CACR,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAA+B;AAC/B,uCAAqC;AAErC,MAAM,SAAS,GAAG;IAChB;QACE,UAAU,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,CAAC,WAAW,CAAC;KACvB;CACF,CAAC;AAoDO,8BAAS;AAlDlB,MAAM,OAAO,GAAG;IACd,WAAW,EAAE;QACX,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAA,cAAK,EAAC,IAAI,CAAC;QACpC,SAAS,EAAE,SAAS;KACrB;CACF,CAAC;AA6CkB,0BAAO;AA3C3B,MAAM,QAAQ,GAAG;IACf,SAAS,EAAE;QACT,KAAK,EAAE,kBAAQ;KAChB;CACF,CAAC;AAuC2B,4BAAQ;AArCrC,MAAM,WAAW,GAAG,IAAI,CAAC;AAEzB,MAAM,OAAO,GAAG;IACd,sBAAsB,EAAE;QACtB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,2BAA2B;KACzC;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,4BAA4B;KAC1C;IACD,sBAAsB,EAAE;QACtB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,4CAA4C;KAC1D;IACD,wBAAwB,EAAE;QACxB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,IAAI;QACb,WAAW,EACT,sEAAsE;KACzE;IACD,6BAA6B,EAAE;QAC7B,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,IAAI;QACb,WAAW,EACT,mEAAmE;KACtE;CACF,CAAC;AAEqC,0BAAO"}

package/dist/printer.js

@@ -207,7 +207,7 @@ class Printer {
             else if (!this.node.notGlobal && this.includedIn(keywords_1.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) ||
@@ -355,40 +355,57 @@ const getFirstNode = (node, includeComment = false) => {
     }
     return res;
 };
+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 ((0, exports.isNodeChild)(v)) {
+            candidates.push(getLastNode(v.Node, includeComment));
+        }
+        else if ((0, exports.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;
+};
 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 +649,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 +663,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":
@@ -4525,6 +4550,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 = {
@@ -4649,6 +4682,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 = {