prettier-plugin-sql-cst 0.22.0 → 0.23.0

package/README.md

@@ -29,10 +29,9 @@ SELECT
   client.name AS client_name,
   organization.name AS org_name,
   count(orders.id) AS nr_of_orders
-FROM
-  client
-  LEFT JOIN organization ON client.organization_id = organization.id
-  LEFT JOIN orders ON orders.client_id = client.id
+FROM client
+LEFT JOIN organization ON client.organization_id = organization.id
+LEFT JOIN orders ON orders.client_id = client.id
 WHERE
   client.status = 'active'
   AND client.id IN (28, 214, 457)
@@ -182,7 +181,7 @@ There are also several SQL-specific options:
 
   _Since 0.17.0_
 
-- **`sqlParamTypes`**: `("?", "?nr", "$nr", ":name", "$name", "@name" "@``@name``")[]` (default `[]`)
+- **`sqlParamTypes`**: ``("?", "?nr", "$nr", ":name", "$name", "@name", "@`name`")[]`` (default `[]`)
 
   Array of bound parameter types to support.
 

package/dist/index.js

@@ -307,6 +307,7 @@ var isFuncArgs = is("func_args");
 var isCreateTableStmt = is("create_table_stmt");
 var isKeyword = is("keyword");
 var isEmpty = is("empty");
+var isIdentifier = is("identifier");
 var isJsonLiteral = is("json_literal");
 var isJsonbLiteral = is("jsonb_literal");
 var isStringLiteral = is("string_literal");
@@ -317,18 +318,22 @@ var isMemberExpr = is("member_expr");
 var isSelectStmt = is("select_stmt");
 var isCompoundSelectStmt = is("compound_select_stmt");
 var isListExpr = is("list_expr");
+var isJoinExpr = is("join_expr");
 var isCreateFunctionStmt = is("create_function_stmt");
 var isAlterFunctionStmt = is("alter_function_stmt");
 var isDropFunctionStmt = is("drop_function_stmt");
 var isCreateProcedureStmt = is("create_procedure_stmt");
 var isAlterProcedureStmt = is("alter_procedure_stmt");
 var isDropProcedureStmt = is("drop_procedure_stmt");
+var isDoStmt = is("do_stmt");
 var isAlterActionRename = is("alter_action_rename");
 var isLanguageClause = is("language_clause");
 var isDynamicallyLoadedFunction = is("dynamically_loaded_function");
 var isBigqueryQuotedMemberExpr = is("bigquery_quoted_member_expr");
 var isCreateTriggerStmt = is("create_trigger_stmt");
 var isExecuteClause = is("execute_clause");
+var isExecuteImmediateStmt = is("execute_immediate_stmt");
+var isExecuteExpr = is("execute_expr");
 var isFunctionSignature = is("function_signature");
 var isDataTypeName = is("data_type_name");
 var isIntervalDataType = is("interval_data_type");
@@ -364,8 +369,11 @@ var castMap = {
 // src/syntax/comment.ts
 var commentMap = {
   comment_stmt: (print) => group([
-    print.spaced(["commentKw", "onKw", "target", "isKw"]),
-    indent([line, print("message")])
+    print.spaced(["commentKw", "onKw"]),
+    line,
+    print("target"),
+    line,
+    print.spaced(["isKw", "message"])
   ]),
   comment_target_aggregate: (print) => group([print.spaced(["aggregateKw", "name"]), print(["params"])]),
   comment_target_function: (print) => group([print.spaced(["functionKw", "name"]), print(["params"])]),
@@ -682,10 +690,16 @@ var exprMap = {
     if (isParenExpr(node.expr)) {
       return print("expr");
     }
-    if (isListExpr(path.getParentNode(0)) && isFuncArgs(path.getParentNode(1)) && !isSelectStmt(node.expr) && !isCompoundSelectStmt(node.expr)) {
+    const parent = path.getParentNode(0);
+    const grandParent = path.getParentNode(1);
+    if (isListExpr(parent) && isFuncArgs(grandParent) && // TODO: We really should parse the DISTINCT (...) expression as a separate thing.
+    // For now this check here patches up the deficiency in the parser.
+    !grandParent.distinctKw && !isSelectStmt(node.expr) && !isCompoundSelectStmt(node.expr)) {
       return print("expr");
     }
-    const parent = path.getParentNode();
+    if (isEmptyParenExpr(node)) {
+      return ["(", print("expr"), ")"];
+    }
     const lineStyle = isCreateTableStmt(parent) && print.dynamicLine() === hardline ? hardline : softline;
     return group(["(", indent([lineStyle, print("expr")]), lineStyle, ")"]);
   },
@@ -696,7 +710,13 @@ var exprMap = {
     if (node.operator === "") {
       return print.spaced(["left", "right"]);
     }
-    return print.spaced(["left", "operator", "right"]);
+    if (isString(node.operator) && isCompactOp(node.operator)) {
+      return print(["left", "operator", "right"]);
+    }
+    return group([
+      print("left"),
+      group([" ", print.spaced("operator"), indent([line, print("right")])])
+    ]);
   },
   prefix_op_expr: (print, node) => (isString(node.operator) ? print : print.spaced)(["operator", "expr"]),
   postfix_op_expr: (print) => print.spaced(["expr", "operator"]),
@@ -708,13 +728,18 @@ var exprMap = {
     print("endKw")
   ],
   case_when: (print, node) => {
+    const whenThen = group([
+      group([print("whenKw"), indent([line, print("condition")])]),
+      line,
+      print("thenKw")
+    ]);
     if (isProgram(node.result)) {
       return [
-        print.spaced(["whenKw", "condition", "thenKw"]),
+        whenThen,
         indent([hardline, stripTrailingHardline(print("result"))])
       ];
     }
-    return print.spaced(["whenKw", "condition", "thenKw", "result"]);
+    return group([whenThen, indent([line, print("result")])]);
   },
   case_else: (print, node) => {
     if (isProgram(node.result)) {
@@ -723,7 +748,7 @@ var exprMap = {
         indent([hardline, stripTrailingHardline(print("result"))])
       ];
     }
-    return print.spaced(["elseKw", "result"]);
+    return group([print("elseKw"), indent([line, print("result")])]);
   },
   member_expr: (print, node) => isArraySubscript(node.property) ? print(["object", "property"]) : [print("object"), ".", print("property")],
   bigquery_quoted_member_expr: (print) => ["`", print("expr"), "`"],
@@ -861,6 +886,20 @@ var isFunctionContext = (node, parent) => {
   return isFuncCall(node) || isFunctionSignature(node) || isCreateFunctionStmt(node) || isCreateProcedureStmt(node) || isAlterActionRename(node) && (isAlterFunctionStmt(parent) || isAlterProcedureStmt(parent)) || isExecuteClause(node) && isCreateTriggerStmt(parent);
 };
 var isBooleanOp = ({ name }) => name === "AND" || name === "OR";
+var isCompactOp = (op) => op === "->" || op === "->>";
+var hasComments = (node) => (node.leading?.length ?? 0) > 0 || (node.trailing?.length ?? 0) > 0;
+var isEmptyParenExpr = (node) => {
+  if (hasComments(node) || hasComments(node.expr)) {
+    return false;
+  }
+  if (isFuncArgs(node.expr)) {
+    return node.expr.args.items.length === 0 && !node.expr.distinctKw && !node.expr.nullHandlingKw && !node.expr.orderBy && !node.expr.limit && !node.expr.having;
+  }
+  if (isListExpr(node.expr)) {
+    return node.expr.items.length === 0;
+  }
+  return false;
+};
 
 // src/syntax/extension.ts
 var extensionMap = {
@@ -948,21 +987,27 @@ var hasOnlyAsClause = (node) => node.clauses.length === 1 && isAsClause(node.cla
 
 // src/syntax/index.ts
 var indexMap = {
-  create_index_stmt: (print) => group(
+  create_index_stmt: (print, node) => group(
     join(print.dynamicLine(), [
-      print.spaced([
-        "createKw",
-        "orReplaceKw",
-        "indexTypeKw",
-        "indexKw",
-        "concurrentlyKw",
-        "ifNotExistsKw",
-        "name",
-        "onKw",
-        "table",
-        "using",
-        "columns"
-      ]),
+      group(
+        join(line, [
+          print.spaced([
+            "createKw",
+            "orReplaceKw",
+            "indexTypeKw",
+            "indexKw",
+            "concurrentlyKw",
+            "ifNotExistsKw",
+            "name"
+          ]),
+          print.spaced([
+            "onKw",
+            "table",
+            ...node.using ? [] : ["columns"]
+          ]),
+          ...node.using ? [print.spaced(["using", "columns"])] : []
+        ])
+      ),
       ...print("clauses")
     ])
   ),
@@ -1362,7 +1407,7 @@ var proceduralLanguageMap = {
   // CALL
   call_stmt: (print) => group(print.spaced(["callKw", "func"])),
   // RETURN
-  return_stmt: (print) => group(print.spaced(["returnKw", "expr"])),
+  return_stmt: (print, node) => node.expr ? group([print("returnKw"), indent([line, print("expr")])]) : print("returnKw"),
   return_next_stmt: (print) => group(print.spaced(["returnNextKw", "expr"])),
   return_query_stmt: (print, node) => {
     if (node.expr.type === "execute_expr") {
@@ -1555,11 +1600,16 @@ var selectMap = {
     print.spaced(["defaultKw", "defaultValue"])
   ]),
   // SELECT clause
-  select_clause: (print, node, path, opts) => group([
-    print.spaced(["selectKw", "modifiers"]),
-    node.columns ? indent([line, print("columns")]) : [],
-    containsNewline(node, opts) ? breakParent : []
-  ]),
+  select_clause: (print, node, path, opts) => {
+    if (hasSingleColumn(node)) {
+      return group(print.spaced(["selectKw", "modifiers", "columns"]));
+    }
+    return group([
+      print.spaced(["selectKw", "modifiers"]),
+      node.columns ? indent([line, print("columns")]) : [],
+      containsNewline(node, opts) ? breakParent : []
+    ]);
+  },
   select_all: (print) => print.spaced(["allKw"]),
   select_distinct: (print) => print.spaced(["distinctKw"]),
   select_distinct_on: (print) => group([print.spaced(["distinctOnKw", "columns"])]),
@@ -1568,7 +1618,7 @@ var selectMap = {
   except_columns: (print) => print.spaced(["expr", "exceptKw", "columns"]),
   replace_columns: (print) => print.spaced(["expr", "replaceKw", "columns"]),
   // FROM clause
-  from_clause: (print) => group([print("fromKw"), indent([line, print("expr")])]),
+  from_clause: (print, node) => hasCommaJoin(node.expr) ? group([print("fromKw"), indent([line, print("expr")])]) : print.spaced(["fromKw", "expr"]),
   join_expr: (print, node) => {
     if (node.operator === ",") {
       return join([",", hardline], print(["left", "right"]));
@@ -1596,7 +1646,10 @@ var selectMap = {
   not_indexed_table: (print) => print.spaced(["table", "notIndexedKw"]),
   unnest_expr: (print) => print(["unnestKw", "expr"]),
   unnest_with_offset_expr: (print) => print.spaced(["unnest", "withOffsetKw"]),
-  pivot_expr: (print) => [print("left"), hardline, print(["pivotKw", "args"])],
+  pivot_expr: (print) => [
+    print("left"),
+    indent([hardline, print(["pivotKw", "args"])])
+  ],
   pivot_for_in: (print) => group(
     join(line, [
       group(print("aggregations")),
@@ -1606,11 +1659,13 @@ var selectMap = {
   ),
   unpivot_expr: (print, node) => [
     print("left"),
-    hardline,
-    (node.nullHandlingKw ? print.spaced : print)([
-      "unpivotKw",
-      "nullHandlingKw",
-      "args"
+    indent([
+      hardline,
+      (node.nullHandlingKw ? print.spaced : print)([
+        "unpivotKw",
+        "nullHandlingKw",
+        "args"
+      ])
     ])
   ],
   unpivot_for_in: (print) => group(
@@ -1622,13 +1677,18 @@ var selectMap = {
   ),
   tablesample_expr: (print) => group([
     print("left"),
-    line,
-    print.spaced(["tablesampleKw", "method", "args", "repeatable"])
+    indent([
+      line,
+      print.spaced(["tablesampleKw", "method", "args", "repeatable"])
+    ])
   ]),
   tablesample_method: (print) => print.spaced(["methodKw"]),
   tablesample_percent: (print) => print.spaced(["percent", "percentKw"]),
   tablesample_repeatable: (print) => print.spaced(["repeatableKw", "seed"]),
-  for_system_time_as_of_expr: (print) => group([print("left"), line, print.spaced(["forSystemTimeAsOfKw", "expr"])]),
+  for_system_time_as_of_expr: (print) => group([
+    print("left"),
+    indent([line, print.spaced(["forSystemTimeAsOfKw", "expr"])])
+  ]),
   partitioned_table: (print) => print.spaced(["table", "partitionKw", "partitions"]),
   dual_table: (print) => print("dualKw"),
   lateral_derived_table: (print) => print.spaced(["lateralKw", "expr"]),
@@ -1749,6 +1809,13 @@ var printLimitValues = (print, node) => {
     return print("count");
   }
 };
+var hasSingleColumn = (node) => {
+  if (!node.columns) {
+    return false;
+  }
+  return node.columns.items.filter((item) => !isEmpty(item)).length === 1;
+};
+var hasCommaJoin = (node) => isJoinExpr(node) && (node.operator === "," || hasCommaJoin(node.left));
 
 // src/syntax/sequence.ts
 var sequenceMap = {
@@ -2199,51 +2266,61 @@ function printNode(path, options2, print) {
 var printComment = (path) => {
   const node = path.node;
   if (node.type === "line_comment") {
-    if (/^--[^ \t]/.test(node.text)) {
+    if (/^--[^ \t-]/.test(node.text)) {
       return node.text.replace(/^--/, "-- ");
     }
-    if (/^#[^ \t!]/.test(node.text)) {
+    if (/^#[^ \t!#]/.test(node.text)) {
       return node.text.replace(/^#/, "# ");
     }
   }
   return node.text;
 };
 
+// src/languageClause.ts
+var isJavaScriptLanguageClause = (clause) => isLanguageClause(clause) && languageName(clause.name) === "js";
+var isSqlLanguageClause = (clause) => isLanguageClause(clause) && languageName(clause.name).toLowerCase() === "sql";
+var isPlpgsqlLanguageClause = (clause) => isLanguageClause(clause) && languageName(clause.name).toLowerCase() === "plpgsql";
+var languageName = (node) => isIdentifier(node) ? node.name : node.value;
+
+// src/formatBigqueryString.ts
+var formatBigqueryString = (node, options2) => {
+  return async (textToDoc) => {
+    const quotes = detectQuotes(node.value);
+    if (!quotes) {
+      return void 0;
+    }
+    const code = await textToDoc(node.value, options2);
+    return [
+      quotes[0],
+      indent([hardline, stripTrailingHardline(code)]),
+      hardline,
+      quotes[1]
+    ];
+  };
+};
+var detectQuotes = (code) => {
+  if (!/'''/.test(code)) {
+    return ["r'''", "'''"];
+  }
+  if (!/"""/.test(code)) {
+    return ['r"""', '"""'];
+  }
+  return void 0;
+};
+
 // src/embedJs.ts
 var embedJs = (path, options2) => {
   const node = path.node;
   const parent = path.getParentNode(0);
   const grandParent = path.getParentNode(1);
   if (isStringLiteral(node) && isAsClause(parent) && isCreateFunctionStmt(grandParent) && grandParent.clauses.some(isJavaScriptLanguageClause)) {
-    return async (textToDoc) => {
-      const quotes = detectQuotes(node.value);
-      if (!quotes) {
-        return void 0;
-      }
-      const js = await textToDoc(node.value, {
-        ...options2,
-        parser: "babel"
-      });
-      return [
-        quotes[0],
-        indent([hardline, stripTrailingHardline(js)]),
-        hardline,
-        quotes[1]
-      ];
-    };
+    return formatBigqueryString(node, {
+      ...options2,
+      parser: "babel"
+    });
   }
   return null;
 };
-var isJavaScriptLanguageClause = (clause) => isLanguageClause(clause) && clause.name.name === "js";
-var detectQuotes = (js) => {
-  if (!/'''/.test(js)) {
-    return ["r'''", "'''"];
-  }
-  if (!/"""/.test(js)) {
-    return ['r"""', '"""'];
-  }
-  return void 0;
-};
 
 // src/embedJson.ts
 var embedJson = (path, options2) => {
@@ -2280,40 +2357,82 @@ var embedSql = (path, options2) => {
   const parent = path.getParentNode(0);
   const grandParent = path.getParentNode(1);
   const pluginOptions = options2;
-  if (isStringLiteral(node) && isAsClause(parent) && (isCreateFunctionStmt(grandParent) || isCreateProcedureStmt(grandParent))) {
+  if (!isStringLiteral(node)) {
+    return null;
+  }
+  if (isAsClause(parent) && isRoutine(grandParent)) {
     if (grandParent.clauses.some(isSqlLanguageClause)) {
-      return async (textToDoc) => {
-        const quote = detectQuote(node);
-        if (!quote) {
-          return void 0;
-        }
-        const sql = await textToDoc(node.value, pluginOptions);
-        return [
-          quote,
-          indent([hardline, stripTrailingHardline(sql)]),
-          hardline,
-          quote
-        ];
-      };
+      return sqlFormatter(node, pluginOptions);
     }
     if (grandParent.clauses.some(isPlpgsqlLanguageClause) && pluginOptions.sqlExperimentalPlpgsql) {
-      return async (textToDoc) => {
-        const quote = detectQuote(node);
-        if (!quote) {
-          return void 0;
-        }
-        const sql = await textToDoc(node.value, {
-          ...pluginOptions,
-          parser: "plpgsql"
-        });
-        return [quote, [hardline, stripTrailingHardline(sql)], hardline, quote];
-      };
+      return plpgsqlFormatter(node, pluginOptions);
     }
   }
+  if (isDoStmt(parent)) {
+    if (!parent.language || isPlpgsqlLanguageClause(parent.language)) {
+      return plpgsqlFormatter(node, pluginOptions);
+    }
+    if (isSqlLanguageClause(parent.language)) {
+      return sqlFormatter(node, pluginOptions);
+    }
+  }
+  if (options2.parser === "plpgsql" && (isExecuteImmediateStmt(parent) || isExecuteExpr(parent)) && parent.expr === node && node.text.startsWith("$")) {
+    return sqlFormatter(node, {
+      ...pluginOptions,
+      parser: "postgresql",
+      // Enable $1-style parameters supplied by EXECUTE ... USING.
+      sqlParamTypes: [
+        .../* @__PURE__ */ new Set([...pluginOptions.sqlParamTypes ?? [], "$nr"])
+      ],
+      // Nested embedding can introduce dollar delimiters that close an outer string.
+      embeddedLanguageFormatting: "off"
+    });
+  }
+  if (options2.parser === "bigquery" && isExecuteImmediateStmt(parent) && parent.expr === node) {
+    return formatBigqueryString(node, {
+      ...pluginOptions,
+      // EXECUTE IMMEDIATE ... USING binds positional or named parameters.
+      sqlParamTypes: [
+        .../* @__PURE__ */ new Set([
+          ...pluginOptions.sqlParamTypes ?? [],
+          "?",
+          "@name"
+        ])
+      ],
+      embeddedLanguageFormatting: "off"
+    });
+  }
   return null;
 };
-var isSqlLanguageClause = (clause) => isLanguageClause(clause) && clause.name.name.toLowerCase() === "sql";
-var isPlpgsqlLanguageClause = (clause) => isLanguageClause(clause) && clause.name.name.toLowerCase() === "plpgsql";
+var sqlFormatter = (node, pluginOptions) => {
+  return async (textToDoc) => {
+    const quote = detectQuote(node);
+    if (!quote) {
+      return void 0;
+    }
+    const sql = await textToDoc(node.value, pluginOptions);
+    return [
+      quote,
+      indent([hardline, stripTrailingHardline(sql)]),
+      hardline,
+      quote
+    ];
+  };
+};
+var plpgsqlFormatter = (node, pluginOptions) => {
+  return async (textToDoc) => {
+    const quote = detectQuote(node);
+    if (!quote) {
+      return void 0;
+    }
+    const sql = await textToDoc(node.value, {
+      ...pluginOptions,
+      parser: "plpgsql"
+    });
+    return [quote, [hardline, stripTrailingHardline(sql)], hardline, quote];
+  };
+};
+var isRoutine = (node) => isCreateFunctionStmt(node) || isCreateProcedureStmt(node);
 var detectQuote = (node) => {
   const match = node.text.match(/^('|\$[^$]*\$)/);
   const quote = match?.[1];

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "Prettier plugin for SQL",
   "contributors": [
+    "Abraham Guo <abrahamjguo@gmail.com>",
     "Barna Magyarkuti <bmagyarkuti@gmail.com>",
     "Bowen Parnell <bparnell@4tel.com.au>",
     "Joel Mukuthu <joelmukuthu@gmail.com>",
@@ -30,7 +31,8 @@
     "test": "yarn node --experimental-vm-modules $(yarn bin jest)",
     "pretty": "prettier -w src/ test/",
     "ts:check": "tsc --noEmit",
-    "analyze-field-access": "tsx scripts/analyze-field-access.ts src/index.ts"
+    "analyze-field-access": "tsx scripts/analyze-field-access.ts src/index.ts",
+    "upgrade-parser": "sh scripts/upgrade-parser.sh"
   },
   "keywords": [
     "prettier",
@@ -39,7 +41,7 @@
   ],
   "dependencies": {
     "prettier": "^3.0.3",
-    "sql-parser-cst": "^0.42.0"
+    "sql-parser-cst": "^0.42.2"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",