Format SQL output to a Slack message

Author: raszi

package.json

@@ -5,7 +5,9 @@
   "description": "Format code on the clipboard",
   "icon": "icon.png",
   "author": "ikaraszi",
-  "categories": ["Developer Tools"],
+  "categories": [
+    "Developer Tools"
+  ],
   "license": "MIT",
   "commands": [
     {
@@ -109,6 +111,12 @@
       "title": "Format SQL",
       "description": "Formats SQL on the clipboard",
       "mode": "view"
+    },
+    {
+      "name": "format-sql-output",
+      "title": "Format SQL With Output",
+      "description": "Formats SQL with its result on the clipboard",
+      "mode": "view"
     }
   ],
   "preferences": [
@@ -126,25 +134,82 @@
       "type": "dropdown",
       "description": "Set the SQL dialect",
       "data": [
-        { "value": "sql", "title": "Standard SQL" },
-        { "value": "bigquery", "title": "GCP BigQuery" },
-        { "value": "db2", "title": "IBM DB2" },
-        { "value": "db2i", "title": "IBM DB2i (experimental)" },
-        { "value": "duckdb", "title": "DuckDB" },
-        { "value": "hive", "title": "Apache Hive" },
-        { "value": "mariadb", "title": "MariaDB" },
-        { "value": "mysql", "title": "MySQL" },
-        { "value": "tidb", "title": "TiDB" },
-        { "value": "n1ql", "title": "Couchbase N1QL" },
-        { "value": "plsql", "title": "Oracle PL/SQL" },
-        { "value": "postgresql", "title": "PostgreSQL" },
-        { "value": "redshift", "title": "Amazon Redshift" },
-        { "value": "singlestoredb", "title": "SingleStoreDB" },
-        { "value": "snowflake", "title": "Snowflake" },
-        { "value": "spark", "title": "Spark" },
-        { "value": "sqlite", "title": "SQLite" },
-        { "value": "transactsql", "title": "SQL Server Transact-SQL" },
-        { "value": "trino", "title": "Trino / Presto" }
+        {
+          "value": "sql",
+          "title": "Standard SQL"
+        },
+        {
+          "value": "bigquery",
+          "title": "GCP BigQuery"
+        },
+        {
+          "value": "db2",
+          "title": "IBM DB2"
+        },
+        {
+          "value": "db2i",
+          "title": "IBM DB2i (experimental)"
+        },
+        {
+          "value": "duckdb",
+          "title": "DuckDB"
+        },
+        {
+          "value": "hive",
+          "title": "Apache Hive"
+        },
+        {
+          "value": "mariadb",
+          "title": "MariaDB"
+        },
+        {
+          "value": "mysql",
+          "title": "MySQL"
+        },
+        {
+          "value": "tidb",
+          "title": "TiDB"
+        },
+        {
+          "value": "n1ql",
+          "title": "Couchbase N1QL"
+        },
+        {
+          "value": "plsql",
+          "title": "Oracle PL/SQL"
+        },
+        {
+          "value": "postgresql",
+          "title": "PostgreSQL"
+        },
+        {
+          "value": "redshift",
+          "title": "Amazon Redshift"
+        },
+        {
+          "value": "singlestoredb",
+          "title": "SingleStoreDB"
+        },
+        {
+          "value": "snowflake",
+          "title": "Snowflake"
+        },
+        {
+          "value": "spark",
+          "title": "Spark"
+        },
+        {
+          "value": "sqlite",
+          "title": "SQLite"
+        },
+        {
+          "value": "transactsql",
+          "title": "SQL Server Transact-SQL"
+        },
+        {
+          "value": "trino",
+          "title": "Trino / Presto"
+        }
       ],
       "required": false
     }

src/format-sql-output.tsx

@@ -0,0 +1,62 @@
+import { Detail } from "@raycast/api";
+import { usePromise } from "@raycast/utils";
+import { useRef } from "react";
+import { formatSQL } from "./format-sql";
+
+import { copyToClipboard, readFromClipboard, wrapWithCodeblock } from "./utils";
+
+const wrapAsSQL = wrapWithCodeblock("sql");
+
+const wrapAsPlain = wrapWithCodeblock();
+
+const hasContent = (input?: string) => {
+  return input && 0 < input.trim().length;
+};
+
+const dividers = [/\n(?=[┌╔])/, /(?<=;)\n/];
+
+type Parts = readonly [string, string];
+
+const splitInput = (input: string): Parts | undefined => {
+  for (const divider of dividers) {
+    const [sql, output] = input.split(divider, 2);
+    if (hasContent(sql) && hasContent(output)) {
+      return [sql, output] as const;
+    }
+  }
+};
+
+const safeFormatSQL = async (input: string): Promise<string> => {
+  try {
+    return await formatSQL(input);
+  } catch {
+    return input;
+  }
+};
+
+const pipeline = async (): Promise<string> => {
+  const input = await readFromClipboard();
+
+  const result = splitInput(input);
+  if (!result) throw new Error("Invalid input");
+  const [sql, output] = result;
+
+  const outputPlain = wrapAsPlain(output.trim());
+
+  const formattedSQL = await safeFormatSQL(sql.trim());
+
+  const clipboard = [wrapAsPlain(formattedSQL), outputPlain].join("\n");
+  await copyToClipboard(clipboard);
+
+  return [wrapAsSQL(formattedSQL), outputPlain].join("\n");
+};
+
+function SQLOutputFormat() {
+  const abortable = useRef<AbortController>();
+
+  const { isLoading, data: markdown } = usePromise(pipeline, [], { abortable });
+
+  return <Detail isLoading={isLoading} markdown={markdown} />;
+}
+
+export default () => <SQLOutputFormat />;

src/format-sql.tsx

@@ -4,9 +4,9 @@ import { Format } from "./format";
 import { getPreferences } from "./preferences";
 import { Formatter } from "./types";
 
-const { sqlDialect } = getPreferences();
+export const formatSQL: Formatter = async (input) => {
+  const { sqlDialect } = getPreferences();
 
-const formatter: Formatter = async (input) => {
   return format(input, {
     language: sqlDialect,
     functionCase: "upper",
@@ -15,4 +15,4 @@ const formatter: Formatter = async (input) => {
   });
 };
 
-export default () => <Format language="sql" formatter={formatter} />;
+export default () => <Format language="sql" formatter={formatSQL} />;

src/format.tsx

@@ -2,18 +2,26 @@ import { Detail } from "@raycast/api";
 import { usePromise } from "@raycast/utils";
 import { useRef } from "react";
 
-import { pipeline } from "./pipeline";
 import { Formatter, Language } from "./types";
+import { copyToClipboard, readFromClipboard, wrapWithCodeblock } from "./utils";
 
-type FormatProps = {
+type PipelineArgs = {
   language: Language;
   formatter: Formatter;
 };
 
-export function Format({ language, formatter }: FormatProps) {
+const pipeline = async (args: PipelineArgs): Promise<string> => {
+  const { language, formatter } = args;
+
+  return readFromClipboard().then(formatter).then(copyToClipboard).then(wrapWithCodeblock(language));
+};
+
+type FormatProps = PipelineArgs;
+
+export function Format(props: FormatProps) {
   const abortable = useRef<AbortController>();
 
-  const { isLoading, data: markdown } = usePromise(pipeline, [language, formatter], { abortable });
+  const { isLoading, data: markdown } = usePromise(pipeline, [props], { abortable });
 
   return <Detail isLoading={isLoading} markdown={markdown} />;
 }

src/pipeline.ts

@@ -1,4 +1,4 @@
-import { format, BuiltInParserName } from "prettier";
+import { BuiltInParserName, format } from "prettier";
 
 import { Format } from "./format";
 import { getPreferences } from "./preferences";

src/prettier.tsx

@@ -0,0 +1,14 @@
+import { Clipboard } from "@raycast/api";
+
+import { Language } from "./types";
+
+export const readFromClipboard = async (): Promise<string> => (await Clipboard.readText()) || "";
+
+export const copyToClipboard = async (code: string): Promise<string> => {
+  await Clipboard.copy(code);
+  return code;
+};
+
+export const wrapWithCodeblock = (language?: Language) => {
+  return (code: string) => ["```", language ? ` ${language}` : "", "\n", code, "\n", "```"].join("");
+};