prettier-plugin-sql-cst 0.12.4 → 0.14.0

package/README.md

@@ -121,9 +121,11 @@ There are also some SQL-specific options:
 
 | API Option                    | Default | Description                                                                                                                                                                                                                     |
 | ----------------------------- | :-----: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `sqlKeywordCase`              | `upper` | Converts SQL keywords to `upper` or `lower` case, or `preserve` existing. Note that for now `preserve` is somewhat incompatible with `sqlCanonicalSyntax: true` (e.g. the added `AS` keywords will always be in uppercase).     |
+| `sqlKeywordCase`              | `upper` | Convert SQL keywords to `upper` or `lower` case, or `preserve` existing. Note that for now `preserve` is somewhat incompatible with `sqlCanonicalSyntax: true` (e.g. the added `AS` keywords will always be in uppercase).      |
+| `sqlLiteralCase`              | `upper` | Convert SQL literals TRUE, FALSE and NULL to `upper` or `lower` case, or `preserve` existing.                                                                                                                                   |
 | `sqlParamTypes`               |  `[]`   | Array of bound parameter types: `?`, `?nr`, `$nr`, `:name`, `@name`, `$name`.                                                                                                                                                   |
 | `sqlCanonicalSyntax`          | `true`  | When enabled, performs some opinionated changes of keywords and operators, like enforcing the use of `AS` in aliases and replacing `<>` comparisons with `!=`. See [STYLE_GUIDE][] for more details. (Since 0.11.0)             |
+| `sqlFinalSemicolon`           | `true`  | When enabled, enforces a semicolon at the end of last statement. When disabled leaves it up to the author whether to add a final semicolon or not. (Since 0.13.0)                                                               |
 | `sqlAcceptUnsupportedGrammar` | `false` | Normally when the plugin encounters SQL syntax it doesn't support it will throw an error and won't format anything at all. With this option enabled, it will skip over SQL statements it doesn't recognize, leaving them as-is. |
 
 ## Usage inside VSCode

package/dist/options.d.ts

@@ -2,8 +2,10 @@ import { ParserOptions, SupportOptions } from "prettier";
 import { Node, ParserOptions as CstParserOptions } from "sql-parser-cst";
 export interface SqlPluginOptions {
     sqlKeywordCase: "preserve" | "upper" | "lower";
+    sqlLiteralCase: "preserve" | "upper" | "lower";
     sqlParamTypes: NonNullable<CstParserOptions["paramTypes"]>;
     sqlCanonicalSyntax: boolean;
+    sqlFinalSemicolon: boolean;
     sqlAcceptUnsupportedGrammar: boolean;
 }
 export type AllPrettierOptions<T = Node> = ParserOptions<T> & SqlPluginOptions;

package/dist/options.js

@@ -25,6 +25,29 @@ exports.options = {
             },
         ],
     },
+    sqlLiteralCase: {
+        type: "choice",
+        category: "SQL",
+        default: "upper",
+        description: "Enforces upper/lower case for SQL literals (TRUE, FALSE, NULL)",
+        choices: [
+            {
+                value: "preserve",
+                description: "preserves the existing case",
+                since: "0.14.0",
+            },
+            {
+                value: "upper",
+                description: "forces all keywords to uppercase",
+                since: "0.14.0",
+            },
+            {
+                value: "lower",
+                description: "forces all keywords to lowercase",
+                since: "0.14.0",
+            },
+        ],
+    },
     sqlParamTypes: {
         type: "string",
         array: true,
@@ -41,6 +64,13 @@ exports.options = {
         description: "Enforces one true style of SQL syntax (adds and removes keywords)",
         // Since 0.11.0
     },
+    sqlFinalSemicolon: {
+        type: "boolean",
+        category: "SQL",
+        default: true,
+        description: "Enforces a semicolon at the end of last SQL statement",
+        // Since 0.13.0
+    },
     sqlAcceptUnsupportedGrammar: {
         type: "boolean",
         category: "SQL",

package/dist/syntax/do.d.ts

@@ -0,0 +1,3 @@
+import { DoStmt } from "sql-parser-cst";
+import { CstToDocMap } from "../CstToDocMap";
+export declare const doMap: CstToDocMap<DoStmt>;

package/dist/syntax/do.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.doMap = void 0;
+exports.doMap = {
+    do_stmt: function (print) { return print.spaced(["doKw", "language", "body"]); },
+};

package/dist/syntax/expr.js

@@ -45,7 +45,9 @@ exports.exprMap = {
             return print("expr");
         }
         var parent = path.getParentNode();
-        var lineStyle = (0, node_utils_1.isCreateTableStmt)(parent) ? print_utils_1.hardline : print_utils_1.softline;
+        var lineStyle = (0, node_utils_1.isCreateTableStmt)(parent) && print.dynamicLine() === print_utils_1.hardline
+            ? print_utils_1.hardline
+            : print_utils_1.softline;
         return (0, print_utils_1.group)(["(", (0, print_utils_1.indent)([lineStyle, print("expr")]), lineStyle, ")"]);
     },
     binary_expr: function (print, node) {
@@ -160,13 +162,17 @@ exports.exprMap = {
     /** cst-ignore: value */
     number_literal: function (print) { return print("text"); },
     /** cst-ignore: value */
-    boolean_literal: function (print) { return print("valueKw"); },
+    boolean_literal: function (print, node, path, options) {
+        return printLiteral(node.valueKw, options);
+    },
     /** cst-ignore: value */
     string_literal: function (print) { return print("text"); },
     /** cst-ignore: value */
     blob_literal: function (print) { return print("text"); },
     /** cst-ignore: value */
-    null_literal: function (print) { return print("nullKw"); },
+    null_literal: function (print, node, path, options) {
+        return printLiteral(node.nullKw, options);
+    },
     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"]); },
@@ -181,6 +187,16 @@ exports.exprMap = {
     variable: function (print) { return print("text"); },
     parameter: function (print) { return print("text"); },
 };
+var printLiteral = function (node, options) {
+    switch (options.sqlLiteralCase) {
+        case "preserve":
+            return node.text;
+        case "upper":
+            return node.text.toUpperCase();
+        case "lower":
+            return node.text.toLowerCase();
+    }
+};
 var isBooleanOp = function (_a) {
     var name = _a.name;
     return name === "AND" || name === "OR";

package/dist/syntax/function.js

@@ -38,12 +38,6 @@ exports.functionMap = {
     function_window_clause: function (print) { return print.spaced("windowKw"); },
     function_transform_clause: function (print) { return print.spaced(["transformKw", "types"]); },
     transform_type: function (print) { return print.spaced(["forTypeKw", "dataType"]); },
-    set_parameter_clause: function (print) {
-        return print.spaced(["setKw", "name", "operator", "value"]);
-    },
-    set_parameter_from_current_clause: function (print) {
-        return print.spaced(["setKw", "name", "fromCurrentKw"]);
-    },
     dynamically_loaded_function: function (print) {
         return (0, print_utils_1.join)(", ", print(["objectFile", "symbol"]));
     },
@@ -64,8 +58,6 @@ exports.functionMap = {
             node.behaviorKw ? [print.dynamicLine(), print("behaviorKw")] : [],
         ]);
     },
-    reset_parameter_clause: function (print) { return print.spaced(["resetKw", "name"]); },
-    reset_all_parameters_clause: function (print) { return print.spaced("resetAllKw"); },
 };
 var hasOnlyAsClause = function (node) {
     return node.clauses.length === 1 && (0, node_utils_1.isAsClause)(node.clauses[0]);

package/dist/syntax/parameter.d.ts

@@ -0,0 +1,3 @@
+import { AllParameterNodes } from "sql-parser-cst";
+import { CstToDocMap } from "../CstToDocMap";
+export declare const parameterMap: CstToDocMap<AllParameterNodes>;

package/dist/syntax/parameter.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parameterMap = void 0;
+exports.parameterMap = {
+    // SET
+    set_parameter_stmt: function (print) {
+        return print.spaced(["setKw", "modifierKw", "name", "operator", "value"]);
+    },
+    set_time_zone_parameter_stmt: function (print) {
+        return print.spaced(["setKw", "modifierKw", "timeZoneKw", "value"]);
+    },
+    set_parameter_clause: function (print) {
+        return print.spaced(["setKw", "name", "operator", "value"]);
+    },
+    local_parameter_value: function (print) { return print("localKw"); },
+    set_parameter_from_current_clause: function (print) {
+        return print.spaced(["setKw", "name", "fromCurrentKw"]);
+    },
+    // RESET
+    reset_parameter_stmt: function (print) { return print.spaced(["resetKw", "name"]); },
+    reset_parameter_clause: function (print) { return print.spaced(["resetKw", "name"]); },
+    all_parameters: function (print) { return print("allKw"); },
+    // SHOW
+    show_parameter_stmt: function (print) { return print.spaced(["showKw", "name"]); },
+};

package/dist/syntax/prepared_statements.js

@@ -12,7 +12,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.preparedStatementsMap = void 0;
 var print_utils_1 = require("../print_utils");
 exports.preparedStatementsMap = {
-    execute_stmt: function (print) {
+    // EXECUTE
+    execute_stmt: function (print, node) {
+        var _a;
+        if (((_a = node.args) === null || _a === void 0 ? void 0 : _a.type) === "execute_using_clause") {
+            return (0, print_utils_1.group)(print.spaced(["executeKw", "name", "args"]));
+        }
+        else {
+            return (0, print_utils_1.group)([print.spaced(["executeKw", "name"]), print("args")]);
+        }
+    },
+    execute_immediate_stmt: function (print) {
         return (0, print_utils_1.join)(print_utils_1.hardline, __spreadArray([
             (0, print_utils_1.group)([
                 print.spaced(["executeKw", "immediateKw"]),
@@ -21,5 +31,21 @@ exports.preparedStatementsMap = {
         ], print(["into", "using"]).map(function (clause) { return (0, print_utils_1.group)(clause); }), true));
     },
     execute_into_clause: function (print) { return print.spaced(["intoKw", "variables"]); },
-    execute_using_clause: function (print) { return print.spaced(["usingKw", "values"]); },
+    execute_using_clause: function (print) {
+        return (0, print_utils_1.group)([print("usingKw"), (0, print_utils_1.indent)([print_utils_1.line, print("values")])]);
+    },
+    // PREPARE
+    prepare_stmt: function (print) {
+        return (0, print_utils_1.group)((0, print_utils_1.join)(" ", [
+            print("prepareKw"),
+            print(["name", "params"]),
+            print("source"),
+        ]));
+    },
+    prepare_from_clause: function (print) {
+        return (0, print_utils_1.group)([print("fromKw"), (0, print_utils_1.indent)([print_utils_1.line, print("expr")])]);
+    },
+    // DEALLOCATE
+    deallocate_stmt: function (print) { return print.spaced(["deallocateKw", "name"]); },
+    deallocate_all: function (print) { return print("allKw"); },
 };

package/dist/syntax/program.js

@@ -5,7 +5,9 @@ var print_utils_1 = require("../print_utils");
 exports.programMap = {
     program: function (print, node, path, options) {
         return print("statements").map(function (doc, i) {
-            return printStatement(doc, i, node.statements, options);
+            return i === node.statements.length - 1
+                ? printFinalStatement(doc, i, node.statements, options)
+                : printStatement(doc, i, node.statements, options);
         });
     },
 };
@@ -27,3 +29,18 @@ var printStatement = function (doc, i, statements, options) {
         return [";", print_utils_1.hardline, doc];
     }
 };
+var printFinalStatement = function (doc, i, statements, options) {
+    var stmtDoc = printStatement(doc, i, statements, options);
+    if (statements[i].type === "empty") {
+        // When the final statement is an empty statement,
+        // this means we have inserted a semicolon and newline before it.
+        // So nothing else is needed.
+        return stmtDoc;
+    }
+    else {
+        // If the last statement is not empty,
+        // this means sqlFinalSemicolon option is false,
+        // so we need to add an empty line after it.
+        return [stmtDoc, print_utils_1.hardline];
+    }
+};

package/dist/syntax/sequence.js

@@ -3,10 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.sequenceMap = void 0;
 var print_utils_1 = require("../print_utils");
 exports.sequenceMap = {
-    create_sequence_stmt: function (print) {
+    create_sequence_stmt: function (print, node) {
         return (0, print_utils_1.group)([
             print.spaced(["createKw", "kind", "sequenceKw", "ifNotExistsKw", "name"]),
-            (0, print_utils_1.indent)([print.dynamicLine(), (0, print_utils_1.join)(print_utils_1.line, print("options"))]),
+            node.options.length > 0
+                ? (0, print_utils_1.indent)([print.dynamicLine(), (0, print_utils_1.join)(print_utils_1.line, print("options"))])
+                : [],
         ]);
     },
     alter_sequence_stmt: function (print) {
@@ -24,6 +26,11 @@ exports.sequenceMap = {
             "behaviorKw",
         ]));
     },
+    sequence_option_sequence_name: function (print) {
+        return print.spaced(["sequenceNameKw", "name"]);
+    },
+    sequence_option_logged: function (print) { return print.spaced("loggedKw"); },
+    sequence_option_unlogged: function (print) { return print.spaced("unloggedKw"); },
     sequence_option_as_type: function (print) { return print.spaced(["asKw", "dataType"]); },
     sequence_option_increment: function (print) {
         return print.spaced(["incrementKw", "byKw", "value"]);

package/dist/syntax/transformMap.js

@@ -22,6 +22,7 @@ var create_table_1 = require("./create_table");
 var data_type_1 = require("./data_type");
 var dcl_1 = require("./dcl");
 var delete_1 = require("./delete");
+var do_1 = require("./do");
 var domain_1 = require("./domain");
 var drop_table_1 = require("./drop_table");
 var explain_1 = require("./explain");
@@ -34,6 +35,7 @@ var merge_1 = require("./merge");
 var other_clauses_1 = require("./other_clauses");
 var rename_table_1 = require("./rename_table");
 var role_1 = require("./role");
+var parameter_1 = require("./parameter");
 var policy_1 = require("./policy");
 var prepared_statements_1 = require("./prepared_statements");
 var procedural_language_1 = require("./procedural_language");
@@ -54,4 +56,4 @@ var bigquery_1 = require("./dialects/bigquery");
 var mysql_1 = require("./dialects/mysql");
 var sqlite_1 = require("./dialects/sqlite");
 var postgresql_1 = require("./dialects/postgresql");
-exports.transformMap = __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, alias_1.aliasMap), alter_action_1.alterActionMap), alter_table_1.alterTableMap), analyze_1.analyzeMap), base_1.baseMap), constraint_1.constraintMap), create_table_1.createTableMap), data_type_1.dataTypeMap), dcl_1.dclMap), delete_1.deleteMap), domain_1.domainMap), drop_table_1.dropTableMap), explain_1.explainMap), expr_1.exprMap), frame_1.frameMap), function_1.functionMap), index_1.indexMap), insert_1.insertMap), merge_1.mergeMap), other_clauses_1.otherClausesMap), policy_1.policyMap), prepared_statements_1.preparedStatementsMap), proc_clause_1.procClauseMap), procedural_language_1.proceduralLanguageMap), procedure_1.procedureMap), program_1.programMap), rename_table_1.renameTableMap), role_1.roleMap), schema_1.schemaMap), select_1.selectMap), sequence_1.sequenceMap), transaction_1.transactionMap), trigger_1.triggerMap), truncate_1.truncateMap), type_1.typeMap), unsupported_grammar_1.unsupportedGrammarMap), update_1.updateMap), view_1.viewMap), bigquery_1.bigqueryMap), mysql_1.mysqlMap), postgresql_1.postgresqlMap), sqlite_1.sqliteMap);
+exports.transformMap = __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, alias_1.aliasMap), alter_action_1.alterActionMap), alter_table_1.alterTableMap), analyze_1.analyzeMap), base_1.baseMap), constraint_1.constraintMap), create_table_1.createTableMap), data_type_1.dataTypeMap), dcl_1.dclMap), delete_1.deleteMap), do_1.doMap), domain_1.domainMap), drop_table_1.dropTableMap), explain_1.explainMap), expr_1.exprMap), frame_1.frameMap), function_1.functionMap), index_1.indexMap), insert_1.insertMap), merge_1.mergeMap), other_clauses_1.otherClausesMap), parameter_1.parameterMap), policy_1.policyMap), prepared_statements_1.preparedStatementsMap), proc_clause_1.procClauseMap), procedural_language_1.proceduralLanguageMap), procedure_1.procedureMap), program_1.programMap), rename_table_1.renameTableMap), role_1.roleMap), schema_1.schemaMap), select_1.selectMap), sequence_1.sequenceMap), transaction_1.transactionMap), trigger_1.triggerMap), truncate_1.truncateMap), type_1.typeMap), unsupported_grammar_1.unsupportedGrammarMap), update_1.updateMap), view_1.viewMap), bigquery_1.bigqueryMap), mysql_1.mysqlMap), postgresql_1.postgresqlMap), sqlite_1.sqliteMap);

package/dist/transform/transformCst.js

@@ -13,8 +13,10 @@ var transformCst = function (cst, originalText, options) {
         // so we don't need to worry about comments interfering with other transforms
         comments_1.moveCommentsToRoot,
         stripTrailingCommas_1.stripTrailingCommas,
-        addFinalSemicolon_1.addFinalSemicolon,
     ];
+    if (options.sqlFinalSemicolon) {
+        transforms.push(addFinalSemicolon_1.addFinalSemicolon);
+    }
     if (options.sqlCanonicalSyntax) {
         transforms.push(aliasAs_1.processAliasAs, canonicOperators_1.canonicOperators, canonicKeywords_1.canonicKeywords);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.12.4",
+  "version": "0.14.0",
   "description": "Prettier plugin for SQL",
   "contributors": [
     "Barna Magyarkuti <bmagyarkuti@gmail.com>",
@@ -37,7 +37,7 @@
   ],
   "dependencies": {
     "prettier": "^3.0.3",
-    "sql-parser-cst": "^0.33.1"
+    "sql-parser-cst": "^0.34.1"
   },
   "devDependencies": {
     "@types/jest": "^29.2.5",