Add support for comment overrides

Signed-off-by: Sanjula Ganepola <[email protected]>

Author: SanjulaGanepola

package.json

@@ -265,7 +265,7 @@
               "type": "string",
               "description": "The directory containing SQL example files."
             },
-            "markdownDescription": "Set of custom directories containing SQL example files to be shown in the `Examples` view. All SQL files in the specified directories and at most one subdirectory level deeper will be picked up.\n\nBy default, the folder name will be the category and the file name will be the name of the example. This can be customized by optionally including a comment at the top of the file with the tags `category` and `description`.",
+            "markdownDescription": "Set of custom directories containing SQL example files to be shown in the `Examples` view. All SQL files in the specified directories and at most one subdirectory level deeper will be picked up.\n\nBy default, the folder name will be the category and the file name will be the name of the example. This can be customized by optionally including a comment in the file with the tags `category` and `description`.",
             "default": []
           }
         }

src/views/examples/contributes.json

@@ -60,7 +60,7 @@
               "type": "string",
               "description": "The directory containing SQL example files."
             },
-            "markdownDescription": "Set of custom directories containing SQL example files to be shown in the `Examples` view. All SQL files in the specified directories and at most one subdirectory level deeper will be picked up.\n\nBy default, the folder name will be the category and the file name will be the name of the example. This can be customized by optionally including a comment at the top of the file with the tags `category` and `description`.",
+            "markdownDescription": "Set of custom directories containing SQL example files to be shown in the `Examples` view. All SQL files in the specified directories and at most one subdirectory level deeper will be picked up.\n\nBy default, the folder name will be the category and the file name will be the name of the example. This can be customized by optionally including a comment in the file with the tags `category` and `description`.",
             "default": []
           }
         }

src/views/examples/index.ts

@@ -2,6 +2,7 @@ import { EndOfLine, FileType, TextDocument, Uri, workspace } from "vscode";
 import Configuration from "../../configuration";
 import * as path from "path";
 import { getServiceInfo } from "../../database/serviceInfo";
+import { getStatementDetail } from "../../notebooks/logic/statement";
 
 export interface SQLExamplesList {
   [group: string]: SQLExample[]
@@ -6032,17 +6033,31 @@ export async function getCustomExamples(): Promise<SQLExamplesList> {
   // Organize the SQL files into groups based on their parent directory names
   const examplesList: SQLExamplesList = {};
   for (const textDocument of sqlTextDocuments) {
+    // Set group and name based on file path by default
     const parsedPath = path.parse(textDocument.uri.path);
-    const group = path.basename(parsedPath.dir);
-    const name = parsedPath.name;
+    let group = path.basename(parsedPath.dir);
+    let name = parsedPath.name;
+
+    // Override group and name if category and description is specified in the SQL file as comments
+    const content = textDocument.getText();
+    const eol = textDocument.eol === EndOfLine.LF ? '\n' : '\r\n';
+    const detail = getStatementDetail(content, eol);
+    const category = detail?.settings.category;
+    if (category) {
+      group = category;
+    }
+    const description = detail?.settings.description;
+    if (description) {
+      name = description;
+    }
 
     if (!examplesList[group]) {
       examplesList[group] = [];
     }
 
     examplesList[group].push({
       name: name,
-      content: textDocument.getText().split(textDocument.eol === EndOfLine.LF ? '\n' : '\r\n')
+      content: textDocument.getText().split(eol)
     });
   }