feat: configuration option for max rows before truncation

Author: cmoog

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## Unreleased
+
+- New configuration option for maximum number of result rows before truncating the result table.
+  Defaults to `25`.
+
+```json
+{
+  "SQLNotebook.maxResultRows": 25
+}
+```
+
 ## v0.5.0
 
 - Bundle `sqls` language server into `vscode-sql-notebook`.

package.json

@@ -102,6 +102,11 @@
           "type": "number",
           "default": 30000,
           "description": "Query timeout in milliseconds for cell query execution."
+        },
+        "SQLNotebook.maxResultRows": {
+          "type": "number",
+          "default": 25,
+          "description": "Maximum number of result rows to display before truncating result table."
         }
       }
     },

src/extension.ts

@@ -189,15 +189,24 @@ function resultToMarkdownTable(result: TabularResult): string {
     return '*Empty Results Table*';
   }
 
-  if (result.length > 20) {
-    result = result.slice(0, 20);
+  const maxRows = getMaxRows();
+  if (result.length > maxRows) {
+    result = result.slice(0, maxRows);
     result.push(
       Object.fromEntries(Object.entries(result).map((pair) => [pair[0], '...']))
     );
   }
   return `${markdownHeader(result[0])}\n${result.map(markdownRow).join('\n')}`;
 }
 
+function getMaxRows(): number {
+  const fallbackMaxRows = 25;
+  const maxRows: number | undefined = vscode.workspace
+    .getConfiguration('SQLNotebook')
+    .get('maxResultRows');
+  return maxRows ?? fallbackMaxRows;
+}
+
 function escapeNewline(a: string | number | null): string | number | null {
   if (typeof a === 'string') {
     return a.replace(/\n/g, '\\n').replace(/\r/g, '\\r');