prettier-plugin-sql-cst 0.11.7 → 0.11.8

package/README.md

@@ -60,6 +60,10 @@ Install it as any other Prettier plugin:
 
 ```
 npm install --save-dev prettier prettier-plugin-sql-cst
+# or
+pnpm add --save-dev prettier prettier-plugin-sql-cst
+# or
+yarn add --dev prettier prettier-plugin-sql-cst
 ```
 
 Then use it on SQL files through Prettier command line tool or Prettier extension
@@ -72,10 +76,11 @@ 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:
+You can override this behavior with a prettier configuration in `.prettierrc.json` file:
 
 ```json
 {
+  "plugins": ["prettier-plugin-sql-cst"],
   "overrides": [
     {
       "files": ["*.sql"],
@@ -85,6 +90,22 @@ You can override this behavior with a prettier configuration:
 }
 ```
 
+Or you could also store it inside your `package.json`:
+
+```json
+{
+  "prettier": {
+    "plugins": ["prettier-plugin-sql-cst"],
+    "overrides": [
+      {
+        "files": ["*.sql"],
+        "options": { "parser": "bigquery" }
+      }
+    ]
+  }
+}
+```
+
 The plugin provides the following parsers:
 
 - `sqlite`
@@ -104,6 +125,23 @@ There are also some SQL-specific options:
 | `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)         |
 
+## Usage inside VSCode
+
+To use this plugin inside VSCode,
+install the [Prettier VSCode](https://github.com/prettier/prettier-vscode?tab=readme-ov-file#installation) extension.
+
+Follow [Prettier VSCode docs](https://github.com/prettier/prettier-vscode?tab=readme-ov-file#default-formatter)
+to configure it as the default formatter.
+
+You might also need to configure
+[prettier.documentSelectors](https://github.com/prettier/prettier-vscode?tab=readme-ov-file#prettierdocumentselectors)
+to enable Prettier for `*.sql` files.
+
+To see what Prettier is, or is not doing - open the VSCode Output window and select the Prettier dropdown.
+On format, the window should show your `inferredParser`. It should reconfirm that by showing `"parser": "sqlite"`
+(or whichever perser you have configured inside your prettier config `overrides` section)
+and `plugins` with the path to this package. If you don't see that part, Prettier not using this package.
+
 ## FAQ
 
 ### The SQL dialect I'm using is not supported. Can you add support for it?

package/dist/syntax/alter_action.js

@@ -91,6 +91,46 @@ exports.alterActionMap = {
     alter_action_attach_partition: function (print) {
         return print.spaced(["attachPartitionKw", "index"]);
     },
+    alter_action_add_enum_value: function (print) {
+        return print.spaced(["addValueKw", "ifNotExistsKw", "value", "position"]);
+    },
+    alter_action_add_enum_value_position: function (print) {
+        return print.spaced(["positionKw", "value"]);
+    },
+    alter_action_rename_enum_value: function (print) {
+        return print.spaced(["renameValueKw", "oldValue", "toKw", "newValue"]);
+    },
+    alter_action_add_attribute: function (print) {
+        return print.spaced([
+            "addAttributeKw",
+            "name",
+            "dataType",
+            "constraint",
+            "behaviorKw",
+        ]);
+    },
+    alter_action_drop_attribute: function (print) {
+        return print.spaced(["dropAttributeKw", "ifExistsKw", "name", "behaviorKw"]);
+    },
+    alter_action_alter_attribute: function (print) {
+        return print.spaced([
+            "alterAttributeKw",
+            "name",
+            "setDataTypeKw",
+            "dataType",
+            "constraint",
+            "behaviorKw",
+        ]);
+    },
+    alter_action_rename_attribute: function (print) {
+        return print.spaced([
+            "renameAttributeKw",
+            "oldName",
+            "toKw",
+            "newName",
+            "behaviorKw",
+        ]);
+    },
     // ALTER COLUMN
     alter_action_alter_column: function (print) {
         return (0, print_utils_1.group)([

package/dist/syntax/data_type.js

@@ -6,7 +6,7 @@ var print_utils_1 = require("../print_utils");
 exports.dataTypeMap = {
     // print single-word types as `TYPE(10)` and multi-word types as `MY TYPE (10)`
     named_data_type: function (print, node) {
-        return ((0, utils_1.isArray)(node.nameKw) ? print.spaced : print)(["nameKw", "params"]);
+        return ((0, utils_1.isArray)(node.name) ? print.spaced : print)(["name", "params"]);
     },
     array_data_type: function (print) { return print(["dataType", "bounds"]); },
     array_bounds: function (print) { return ["[", print("bounds"), "]"]; },

package/dist/syntax/domain.d.ts

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

package/dist/syntax/domain.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.domainMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.domainMap = {
+    create_domain_stmt: function (print, node) {
+        return (0, print_utils_1.group)([
+            print.spaced(["createDomainKw", "name", "asKw", "dataType"]),
+            node.constraints.length > 0
+                ? (0, print_utils_1.indent)([print.dynamicLine(), (0, print_utils_1.join)(print_utils_1.line, print("constraints"))])
+                : [],
+        ]);
+    },
+    alter_domain_stmt: function (print, node) {
+        return (0, print_utils_1.group)(print.spaced(["alterDomainKw", "name", "action"]));
+    },
+    drop_domain_stmt: function (print) {
+        return (0, print_utils_1.group)(print.spaced(["dropDomainKw", "ifExistsKw", "domains", "behaviorKw"]));
+    },
+};

package/dist/syntax/expr.js

@@ -128,7 +128,11 @@ exports.exprMap = {
     cast_arg: function (print) { return print.spaced(["expr", "asKw", "dataType", "format"]); },
     cast_format: function (print) { return print.spaced(["formatKw", "string", "timezone"]); },
     cast_format_timezone: function (print) { return print.spaced(["atTimeZoneKw", "timezone"]); },
-    cast_operator_expr: function (print) { return [print("expr"), "::", print("dataType")]; },
+    cast_operator_expr: function (print) { return [
+        print("left"),
+        print("operator"),
+        print("right"),
+    ]; },
     string_with_charset: function (print) { return ["_", print(["charset", "string"])]; },
     raise_expr: function (print) { return print(["raiseKw", "args"]); },
     raise_expr_type: function (print) { return print("typeKw"); },

package/dist/syntax/function.js

@@ -4,7 +4,6 @@ exports.functionMap = void 0;
 var print_utils_1 = require("../print_utils");
 var node_utils_1 = require("../node_utils");
 exports.functionMap = {
-    /** cst-ignore: behaviorKw */
     create_function_stmt: function (print, node) { return [
         print.spaced([
             "createKw",
@@ -65,7 +64,6 @@ exports.functionMap = {
         ]);
     },
     reset_parameter_clause: function (print) { return print.spaced(["resetKw", "name"]); },
-    /** cst-ignore: name */
     reset_all_parameters_clause: function (print) { return print.spaced("resetAllKw"); },
 };
 var hasOnlyAsClause = function (node) {

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 domain_1 = require("./domain");
 var drop_table_1 = require("./drop_table");
 var explain_1 = require("./explain");
 var expr_1 = require("./expr");
@@ -43,10 +44,11 @@ var sequence_1 = require("./sequence");
 var transaction_1 = require("./transaction");
 var trigger_1 = require("./trigger");
 var truncate_1 = require("./truncate");
+var type_1 = require("./type");
 var update_1 = require("./update");
 var view_1 = require("./view");
 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({}, 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), 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), prepared_statements_1.preparedStatementsMap), proc_clause_1.procClauseMap), procedural_language_1.proceduralLanguageMap), procedure_1.procedureMap), program_1.programMap), rename_table_1.renameTableMap), schema_1.schemaMap), select_1.selectMap), sequence_1.sequenceMap), transaction_1.transactionMap), trigger_1.triggerMap), truncate_1.truncateMap), 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({}, 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), prepared_statements_1.preparedStatementsMap), proc_clause_1.procClauseMap), procedural_language_1.proceduralLanguageMap), procedure_1.procedureMap), program_1.programMap), rename_table_1.renameTableMap), schema_1.schemaMap), select_1.selectMap), sequence_1.sequenceMap), transaction_1.transactionMap), trigger_1.triggerMap), truncate_1.truncateMap), type_1.typeMap), update_1.updateMap), view_1.viewMap), bigquery_1.bigqueryMap), mysql_1.mysqlMap), postgresql_1.postgresqlMap), sqlite_1.sqliteMap);

package/dist/syntax/type.d.ts

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

package/dist/syntax/type.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.typeMap = void 0;
+var print_utils_1 = require("../print_utils");
+exports.typeMap = {
+    create_type_stmt: function (print) {
+        return (0, print_utils_1.group)([print.spaced(["createTypeKw", "name", "definition"])]);
+    },
+    composite_type_definition: function (print) {
+        return (0, print_utils_1.group)(print.spaced(["asKw", "columns"]));
+    },
+    enum_type_definition: function (print) { return (0, print_utils_1.group)(print.spaced(["asEnumKw", "values"])); },
+    alter_type_stmt: function (print, node) {
+        return (0, print_utils_1.group)([
+            print.spaced(["alterTypeKw", "name"]),
+            print.dynamicLine(),
+            print("actions"),
+        ]);
+    },
+    drop_type_stmt: function (print) {
+        return (0, print_utils_1.group)(print.spaced(["dropTypeKw", "ifExistsKw", "types", "behaviorKw"]));
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.11.7",
+  "version": "0.11.8",
   "description": "Prettier plugin for SQL",
   "contributors": [
     "Bowen Parnell <bparnell@4tel.com.au>",
@@ -36,7 +36,7 @@
   ],
   "dependencies": {
     "prettier": "^3.0.3",
-    "sql-parser-cst": "^0.28.1"
+    "sql-parser-cst": "^0.29.1"
   },
   "devDependencies": {
     "@types/jest": "^29.2.5",