prettier-plugin-sql-cst 0.8.0 → 0.8.2

package/README.md

@@ -3,6 +3,8 @@
 A [Prettier][] plugin for SQL that uses [sql-parser-cst][] and the
 actual [Prettier formatting algorithm][wadler-prettier].
 
+**[Try it live!][live]**
+
 Like Prettier for JavaScript,
 this plugin formats SQL expressions differently depending on their length.
 A short SQL query will be formatted on a single line:
@@ -26,15 +28,15 @@ SELECT
   client.id,
   client.name AS client_name,
   organization.name AS org_name,
-  count(order.id) AS nr_of_orders
+  count(orders.id) AS nr_of_orders
 FROM
   client
   LEFT JOIN organization ON client.organization_id = organization.id
-  LEFT JOIN order ON order.client_id = client.id
+  LEFT JOIN orders ON orders.client_id = client.id
 WHERE
   client.status = 'active'
   AND client.id IN (28, 214, 457)
-  AND order.status IN ('active', 'pending', 'processing')
+  AND orders.status IN ('active', 'pending', 'processing')
 GROUP BY client.id
 ORDER BY client.name
 LIMIT 100;
@@ -109,10 +111,10 @@ The specifics of the [SQL formatting style][STYLE_GUIDE] are still very much sub
 Though the general principles should be mostly in place by now.
 
 [prettier]: https://prettier.io/
+[live]: https://nene.github.io/prettier-sql-playground/
 [printWidth]: https://prettier.io/docs/en/options.html#print-width
 [tabWidth]: https://prettier.io/docs/en/options.html#tab-width
 [useTabs]: https://prettier.io/docs/en/options.html#tabs
 [sql-parser-cst]: https://github.com/nene/sql-parser-cst
 [wadler-prettier]: http://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf
 [STYLE_GUIDE]: ./STYLE_GUIDE.md
-[#2]: https://github.com/nene/prettier-plugin-sql-cst/issues/2

package/dist/CstToDocMap.d.ts

@@ -0,0 +1,11 @@
+import { Node } from "sql-parser-cst";
+import { AstPath, Doc } from "prettier";
+import { PrintFn } from "./PrintFn";
+import { AllPrettierOptions } from "./options";
+export type NodeByType<TType, TNode> = Extract<TNode, {
+    type: TType;
+}>;
+export type ToDocFn<TNode> = (print: PrintFn<TNode>, node: TNode, path: AstPath<TNode>, options: AllPrettierOptions<TNode>) => Doc;
+export type CstToDocMap<TNode extends Node> = {
+    [TType in TNode["type"]]: ToDocFn<NodeByType<TType, TNode>>;
+};

package/dist/PrintFn.d.ts

@@ -0,0 +1,14 @@
+import { AstPath, Doc } from "prettier";
+import { Node } from "sql-parser-cst";
+export type OldPrintFn = (path: AstPath<Node> | string) => Doc;
+export type PrintFn<T, K = PrintableKey<T>> = {
+    (path: AstPath<Node>): Doc;
+    (path: K extends keyof T ? (T[K] extends any[] ? K : never) : never): Doc[];
+    (path: K): Doc;
+    (path: K[]): Doc[];
+    spaced(path: K): Doc[];
+    spaced(path: K[]): Doc[];
+};
+export type PrintableKey<T> = Exclude<keyof T, ReservedKey>;
+type ReservedKey = "type" | "range" | "leading" | "trailing";
+export {};

package/dist/embed.d.ts

@@ -0,0 +1,3 @@
+import { Printer } from "prettier";
+import { Node } from "sql-parser-cst";
+export declare const embed: NonNullable<Printer<Node>["embed"]>;

package/dist/embedJs.d.ts

@@ -0,0 +1,3 @@
+import { Printer } from "prettier";
+import { Node } from "sql-parser-cst";
+export declare const embedJs: NonNullable<Printer<Node>["embed"]>;

package/dist/embedJson.d.ts

@@ -0,0 +1,3 @@
+import { Printer } from "prettier";
+import { Node } from "sql-parser-cst";
+export declare const embedJson: NonNullable<Printer<Node>["embed"]>;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { Node } from "sql-parser-cst";
+import { Parser, Printer, SupportLanguage } from "prettier";
+export { options } from "./options";
+export declare const languages: SupportLanguage[];
+export declare const parsers: Record<string, Parser<Node>>;
+export declare const printers: Record<string, Printer>;

package/dist/node_utils.d.ts

@@ -0,0 +1,16 @@
+import { Node } from "sql-parser-cst";
+export declare const isProgram: (node: any) => node is import("sql-parser-cst").Program;
+export declare const isValuesClause: (node: any) => node is import("sql-parser-cst").ValuesClause;
+export declare const isFuncCall: (node: any) => node is import("sql-parser-cst").FuncCall;
+export declare const isFuncArgs: (node: any) => node is import("sql-parser-cst").FuncArgs;
+export declare const isCreateTableStmt: (node: any) => node is import("sql-parser-cst").CreateTableStmt;
+export declare const isKeyword: (node: any) => node is import("sql-parser-cst").Keyword<string>;
+export declare const isEmpty: (node: any) => node is import("sql-parser-cst").Empty;
+export declare const isJsonLiteral: (node: any) => node is import("sql-parser-cst").JsonLiteral;
+export declare const isStringLiteral: (node: any) => node is import("sql-parser-cst").StringLiteral;
+export declare const isArraySubscript: (node: any) => node is import("sql-parser-cst").ArraySubscript;
+export declare const isAsClause: (node: any) => node is import("sql-parser-cst").AsClause<Node>;
+export declare const isParenExpr: (node: any) => node is import("sql-parser-cst").ParenExpr<Node>;
+export declare const isListExpr: (node: any) => node is import("sql-parser-cst").ListExpr<Node>;
+export declare const isCreateFunctionStmt: (node: any) => node is import("sql-parser-cst").CreateFunctionStmt;
+export declare const isLanguageClause: (node: any) => node is import("sql-parser-cst").LanguageClause;

package/dist/options.d.ts

@@ -0,0 +1,8 @@
+import { ParserOptions, SupportOptions } from "prettier";
+import { Node, ParserOptions as CstParserOptions } from "sql-parser-cst";
+export interface SqlPluginOptions {
+    sqlKeywordCase: "preserve" | "upper" | "lower";
+    sqlParamTypes: NonNullable<CstParserOptions["paramTypes"]>;
+}
+export type AllPrettierOptions<T = Node> = ParserOptions<T> & SqlPluginOptions;
+export declare const options: SupportOptions;

package/dist/printComment.d.ts

@@ -0,0 +1,3 @@
+import { AstPath } from "prettier";
+import { Whitespace } from "sql-parser-cst";
+export declare const printComment: (path: AstPath<Whitespace>) => string;

package/dist/printSql.d.ts

@@ -0,0 +1,5 @@
+import { Node } from "sql-parser-cst";
+import { AstPath, Doc } from "prettier";
+import { OldPrintFn } from "./PrintFn";
+import { AllPrettierOptions } from "./options";
+export declare function printSql(path: AstPath<Node>, options: AllPrettierOptions, oldPrint: OldPrintFn): Doc;

package/dist/print_utils.d.ts

@@ -0,0 +1,13 @@
+import { Doc, doc } from "prettier";
+import { Node } from "sql-parser-cst";
+export declare const line: doc.builders.Line, hardline: doc.builders.Concat, softline: doc.builders.Softline, indent: typeof doc.builders.indent, group: typeof doc.builders.group, lineSuffix: typeof doc.builders.lineSuffix, ifBreak: typeof doc.builders.ifBreak, breakParent: doc.builders.BreakParent;
+export declare const stripTrailingHardline: typeof doc.utils.stripTrailingHardline;
+/** Improved join() that also accepts a non-array docs parameter */
+export declare const join: (sep: Doc, docs: Doc) => Doc;
+/** True when the Node contains a newline in original source code */
+export declare const containsNewline: (node: Node, opts: {
+    originalText: string;
+}) => boolean;
+export declare const hasEmptyLineBetweenNodes: (node1: Node, node2: Node, opts: {
+    originalText: string;
+}) => boolean;

package/dist/syntax/alias.d.ts

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

package/dist/syntax/alter_table.d.ts

@@ -0,0 +1,3 @@
+import { AlterTableStmt, AllAlterActionNodes } from "sql-parser-cst";
+import { CstToDocMap } from "../CstToDocMap";
+export declare const alterTableMap: Partial<CstToDocMap<AlterTableStmt | AllAlterActionNodes>>;

package/dist/syntax/analyze.d.ts

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

package/dist/syntax/base.d.ts

@@ -0,0 +1,3 @@
+import { AllColumns, Empty, Keyword } from "sql-parser-cst";
+import { CstToDocMap } from "../CstToDocMap";
+export declare const baseMap: Partial<CstToDocMap<Keyword | Empty | AllColumns>>;

package/dist/syntax/bigquery.d.ts

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

package/dist/syntax/constraint.d.ts

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

package/dist/syntax/create_table.d.ts

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

package/dist/syntax/data_type.d.ts

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

package/dist/syntax/dcl.d.ts

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

package/dist/syntax/delete.d.ts

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

package/dist/syntax/delete.js

@@ -4,5 +4,5 @@ exports.deleteMap = void 0;
 var print_utils_1 = require("../print_utils");
 exports.deleteMap = {
     delete_stmt: function (print) { return (0, print_utils_1.join)(print_utils_1.hardline, print("clauses")); },
-    delete_clause: function (print) { return print.spaced(["deleteKw", "fromKw", "table"]); },
+    delete_clause: function (print) { return print.spaced(["deleteKw", "fromKw", "tables"]); },
 };

package/dist/syntax/drop_table.d.ts

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

package/dist/syntax/explain.d.ts

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

package/dist/syntax/expr.d.ts

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

package/dist/syntax/expr.js

@@ -103,19 +103,22 @@ exports.exprMap = {
             return (0, print_utils_1.group)((0, print_utils_1.join)(" ", __spreadArray([fnCall], extras, true)));
         }
     },
-    func_args: function (print) { return print.spaced(["distinctKw", "args"]); },
+    func_args: function (print) { return print.spaced(["distinctKw", "args", "having"]); },
     filter_arg: function (print) { return print.spaced(["filterKw", "where"]); },
     over_arg: function (print) { return print.spaced(["overKw", "window"]); },
+    having_arg: function (print) { return print.spaced(["havingKw", "minMaxKw", "expr"]); },
     cast_expr: function (print) { return print(["castKw", "args"]); },
     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"]); },
     raise_expr: function (print) { return print(["raiseKw", "args"]); },
     raise_expr_type: function (print) { return print("typeKw"); },
+    extract_expr: function (print) { return print(["extractKw", "args"]); },
+    extract_from: function (print) { return print.spaced(["unit", "fromKw", "expr"]); },
+    week_expr: function (print) { return print(["weekKw", "args"]); },
     interval_expr: function (print) { return print.spaced(["intervalKw", "expr", "unit"]); },
-    interval_unit_range: function (print) {
-        return print.spaced(["fromUnitKw", "toKw", "toUnitKw"]);
-    },
+    interval_unit_range: function (print) { return print.spaced(["fromUnit", "toKw", "toUnit"]); },
+    interval_unit: function (print) { return print("unitKw"); },
     array_expr: function (print) {
         return (0, print_utils_1.group)(["[", (0, print_utils_1.indent)([print_utils_1.softline, print("expr")]), print_utils_1.softline, "]"]);
     },

package/dist/syntax/frame.d.ts

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

package/dist/syntax/function.d.ts

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

package/dist/syntax/index.d.ts

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

package/dist/syntax/insert.d.ts

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

package/dist/syntax/merge.d.ts

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

package/dist/syntax/prepared_statements.d.ts

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

package/dist/syntax/proc_clause.d.ts

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

package/dist/syntax/procedural_language.d.ts

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

package/dist/syntax/procedure.d.ts

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

package/dist/syntax/program.d.ts

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

package/dist/syntax/schema.d.ts

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

package/dist/syntax/select.d.ts

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

package/dist/syntax/select.js

@@ -17,7 +17,7 @@ exports.selectMap = {
             (0, print_utils_1.indent)([print_utils_1.line, print("tables")]),
         ]);
     },
-    common_table_expression: function (print) { return [
+    common_table_expr: function (print) { return [
         print(["table", "columns"]),
         " ",
         print.spaced(["asKw", "materializedKw", "expr"]),

package/dist/syntax/sqlite.d.ts

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

package/dist/syntax/transaction.d.ts

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

package/dist/syntax/transformMap.d.ts

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

package/dist/syntax/trigger.d.ts

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

package/dist/syntax/truncate.d.ts

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

package/dist/syntax/update.d.ts

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

package/dist/syntax/update.js

@@ -5,7 +5,7 @@ var print_utils_1 = require("../print_utils");
 exports.updateMap = {
     update_stmt: function (print) { return (0, print_utils_1.join)(print_utils_1.hardline, print("clauses")); },
     update_clause: function (print) {
-        return print.spaced(["updateKw", "options", "orAction", "tables"]);
+        return print.spaced(["updateKw", "hints", "orAction", "tables"]);
     },
     set_clause: function (print, node) {
         if (node.assignments.items.length > 1) {

package/dist/syntax/view.d.ts

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

package/dist/transform/addFinalSemicolon.d.ts

@@ -0,0 +1,2 @@
+import { Program } from "sql-parser-cst";
+export declare const addFinalSemicolon: (program: Program, originalText: string) => Program;

package/dist/transform/aliasAs.d.ts

@@ -0,0 +1,2 @@
+import { Program } from "sql-parser-cst";
+export declare const processAliasAs: (cst: Program) => Program;

package/dist/transform/comments.d.ts

@@ -0,0 +1,10 @@
+import { Program, Whitespace } from "sql-parser-cst";
+/**
+ * Gathers comments from .leading and .trailing fields of all nodes
+ * into a single .comments field in root Program node.
+ *
+ * Deletes the .leading and .trailing fields of all nodes.
+ */
+export declare const moveCommentsToRoot: (cst: Program) => Program & {
+    comments: Whitespace[];
+};

package/dist/transform/stripTrailingCommas.d.ts

@@ -0,0 +1,2 @@
+import { Program } from "sql-parser-cst";
+export declare const stripTrailingCommas: (cst: Program) => Program;

package/dist/transform/transformCst.d.ts

@@ -0,0 +1,2 @@
+import { Program } from "sql-parser-cst";
+export declare const transformCst: (cst: Program, originalText: string) => Program;

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+import { Node } from "sql-parser-cst";
+export declare const isDefined: <T>(value: T | undefined) => value is T;
+export declare const isString: (value: any) => value is string;
+export declare const isObject: (x: any) => x is Record<string, any>;
+export declare const isArray: (x: any) => x is any[];
+export declare const isEmptyArray: (x: any) => x is [];
+export declare const isNode: (value: any) => value is Node;
+export declare const arrayWrap: <T>(x: T | T[]) => T[];
+export declare const last: <T>(arr: T[]) => T;

package/dist/visitAllNodes.d.ts

@@ -0,0 +1,2 @@
+import { Node } from "sql-parser-cst";
+export declare const visitAllNodes: (node: Node, visit: (node: Node) => void) => void;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "prettier-plugin-sql-cst",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Prettier plugin for SQL",
   "author": "Rene Saarsoo <nene@triin.net>",
   "license": "GPL-3.0-or-later",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/nene/prettier-plugin-sql-cst"
@@ -29,7 +30,7 @@
   ],
   "dependencies": {
     "prettier": "^2.8.2",
-    "sql-parser-cst": "^0.14.1"
+    "sql-parser-cst": "^0.17.1"
   },
   "devDependencies": {
     "@types/jest": "^29.2.5",