New actions to add, remove, edit

SanjulaGanepola · SanjulaGanepola · commit 09dba7905c51 · 2025-08-27T00:35:07.000-04:00
Signed-off-by: Sanjula Ganepola &lt;Sanjula.Ganepola@ibm.com&gt;
diff --git a/package.json b/package.json
@@ -793,6 +793,21 @@
         "category": "Db2 for i (Examples)",
         "icon": "$(refresh)"
       },
+      {
+        "command": "vscode-db2i.examples.add",
+        "title": "Add...",
+        "category": "Db2 for i (Examples)"
+      },
+      {
+        "command": "vscode-db2i.examples.remove",
+        "title": "Remove...",
+        "category": "Db2 for i (Examples)"
+      },
+      {
+        "command": "vscode-db2i.examples.edit",
+        "title": "Edit Example",
+        "category": "Db2 for i (Examples)"
+      },
       {
         "command": "vscode-db2i.notebook.fromSqlUri",
         "title": "Open as Notebook",
@@ -1100,9 +1115,14 @@
           "when": "view == exampleBrowser"
         },
         {
-          "command": "vscode-db2i.examples.reload",
+          "submenu": "vscode-db2i.customExampleDirectories",
           "group": "navigation@2",
           "when": "view == exampleBrowser"
+        },
+        {
+          "command": "vscode-db2i.examples.reload",
+          "group": "navigation@3",
+          "when": "view == exampleBrowser"
         }
       ],
       "view/item/context": [
@@ -1274,6 +1294,11 @@
           "command": "vscode-db2i.self.explainSelf",
           "when": "view == vscode-db2i.self.nodes && viewItem == selfCodeNode && vscode-db2i:continueExtensionActive",
           "group": "navigation"
+        },
+        {
+          "command": "vscode-db2i.examples.edit",
+          "when": "view == exampleBrowser && viewItem == example.custom",
+          "group": "0_open"
         }
       ],
       "editor/title": [
@@ -1348,6 +1373,11 @@
         "icon": "$(notebook-execute)",
         "id": "sql/editor/context",
         "label": "Run SQL statement"
+      },
+      {
+        "id": "vscode-db2i.customExampleDirectories",
+        "label": "Custom Example Directories",
+        "icon": "$(sparkle)"
       }
     ],
     "keybindings": [
@@ -1470,6 +1500,18 @@
         "contents": "🛠️ SELF Codes will appear here. You can set the SELF log level on specific jobs, or you can set the default for new jobs in the User Settings.\n\n[Set Default for New Jobs](command:vscode-db2i.jobManager.defaultSettings)\n\n[Learn about SELF](command:vscode-db2i.self.help)"
       }
     ],
+    "vscode-db2i.customExampleDirectories": [
+      {
+        "command": "vscode-db2i.examples.add",
+        "group": "navigation@0",
+        "when": "view == exampleBrowser"
+      },
+      {
+        "command": "vscode-db2i.examples.remove",
+        "group": "navigation@1",
+        "when": "view == exampleBrowser"
+      }
+    ],
     "notebooks": [
       {
         "id": "db2i-notebook",
diff --git a/src/views/examples/contributes.json b/src/views/examples/contributes.json
@@ -28,6 +28,40 @@
         "title": "Refresh Examples",
         "category": "Db2 for i (Examples)",
         "icon": "$(refresh)"
+      },
+      {
+        "command": "vscode-db2i.examples.add",
+        "title": "Add...",
+        "category": "Db2 for i (Examples)"
+      },
+      {
+        "command": "vscode-db2i.examples.remove",
+        "title": "Remove...",
+        "category": "Db2 for i (Examples)"
+      },
+      {
+        "command": "vscode-db2i.examples.edit",
+        "title": "Edit Example",
+        "category": "Db2 for i (Examples)"
+      }
+    ],
+    "submenus": [
+      {
+        "id": "vscode-db2i.customExampleDirectories",
+        "label": "Custom Example Directories",
+        "icon": "$(sparkle)"
+      }
+    ],
+    "vscode-db2i.customExampleDirectories": [
+      {
+        "command": "vscode-db2i.examples.add",
+        "group": "navigation@0",
+        "when": "view == exampleBrowser"
+      },
+      {
+        "command": "vscode-db2i.examples.remove",
+        "group": "navigation@1",
+        "when": "view == exampleBrowser"
       }
     ],
     "menus": {
@@ -43,9 +77,21 @@
           "when": "view == exampleBrowser"
         },
         {
-          "command": "vscode-db2i.examples.reload",
+          "submenu": "vscode-db2i.customExampleDirectories",
           "group": "navigation@2",
           "when": "view == exampleBrowser"
+        },
+        {
+          "command": "vscode-db2i.examples.reload",
+          "group": "navigation@3",
+          "when": "view == exampleBrowser"
+        }
+      ],
+      "view/item/context": [
+        {
+        "command": "vscode-db2i.examples.edit",
+          "when": "view == exampleBrowser && viewItem == example.custom",
+          "group": "0_open"
         }
       ]
     },
diff --git a/src/views/examples/exampleBrowser.ts b/src/views/examples/exampleBrowser.ts
@@ -2,6 +2,7 @@ import { Event, EventEmitter, ExtensionContext, MarkdownString, ThemeIcon, TreeD
 import { Examples, SQLExample, ServiceInfoLabel, getMergedExamples } from ".";
 import { notebookFromStatements } from "../../notebooks/logic/openAsNotebook";
 import { osDetail } from "../../config";
+import Configuration from "../../configuration";
 
 export const openExampleCommand = `vscode-db2i.examples.open`;
 
@@ -48,6 +49,49 @@ export class ExampleBrowser implements TreeDataProvider<any> {
         this.refresh();
       }),
 
+      commands.registerCommand("vscode-db2i.examples.add", async () => {
+        const dirsToAdd = await window.showOpenDialog({
+          title: "Add Custom Example Directory",
+          canSelectFolders: true,
+          canSelectFiles: false,
+          canSelectMany: true
+        });
+
+        if (dirsToAdd && dirsToAdd.length > 0) {
+          const existingDirectories = Configuration.get<string[]>(`examples.customExampleDirectories`) || [];
+          const newDirectoryPaths = dirsToAdd.map(dir => dir.fsPath);
+          const updatedDirectories = Array.from(new Set([...existingDirectories, ...newDirectoryPaths]));
+          await Configuration.set(`examples.customExampleDirectories`, updatedDirectories);
+        }
+      }),
+
+      commands.registerCommand("vscode-db2i.examples.remove", async () => {
+        const existingDirectories = Configuration.get<string[]>(`examples.customExampleDirectories`) || [];
+        if (existingDirectories.length === 0) {
+          window.showErrorMessage(`No custom example directories to remove.`);
+          return;
+        }
+
+        const quickPickItems = existingDirectories.map(dir => ({ label: dir }));
+        const selectedDirectories = await window.showQuickPick(quickPickItems, {
+          title: `Select custom example directories to remove`,
+          canPickMany: true
+        });
+
+        if (selectedDirectories && selectedDirectories.length > 0) {
+          const dirsToRemove = selectedDirectories.map(item => item.label);
+          const updatedDirectories = existingDirectories.filter(dir => !dirsToRemove.includes(dir));
+          await Configuration.set(`examples.customExampleDirectories`, updatedDirectories);
+        }
+      }),
+
+      commands.registerCommand("vscode-db2i.examples.edit", async (item: SQLExampleItem) => {
+        if (item.example.customFileUri) {
+          const document = await workspace.openTextDocument(item.example.customFileUri);
+          await window.showTextDocument(document);
+        }
+      }),
+
       workspace.onDidChangeConfiguration(e => {
         if (e.affectsConfiguration('vscode-db2i.examples.customExampleDirectories')) {
           this.refresh();
@@ -64,7 +108,7 @@ export class ExampleBrowser implements TreeDataProvider<any> {
     return element;
   }
 
-  async getChildren(element?: ExampleGroupItem): Promise<SQLExampleItem[]> {
+  async getChildren(element?: ExampleGroupItem): Promise<TreeItem[]> {
     if (element) {
       return element.getChildren();
     }
@@ -104,11 +148,12 @@ class ExampleGroupItem extends TreeItem {
 }
 
 class SQLExampleItem extends TreeItem {
-  constructor(example: SQLExample) {
+  constructor(public example: SQLExample) {
     super(example.name, TreeItemCollapsibleState.None);
     this.iconPath = ThemeIcon.File;
     this.resourceUri = Uri.parse('_.sql');
     this.tooltip = new MarkdownString(['```sql', example.content.join(`\n`), '```'].join(`\n`));
+    this.contextValue = example.customFileUri ? `example.custom` : `example`;
 
     this.command = {
       command: openExampleCommand,
diff --git a/src/views/examples/index.ts b/src/views/examples/index.ts
@@ -18,6 +18,7 @@ export interface SQLExample {
   content: string[];
   requirements?: ExampleSystemRequirements;
   isNotebook?: boolean;
+  customFileUri?: Uri;
 };
 
 // Unlike the bulk of the examples defined below, the services examples are retrieved dynamically
@@ -6057,7 +6058,8 @@ export async function getCustomExamples(): Promise<SQLExamplesList> {
 
     examplesList[group].push({
       name: name,
-      content: textDocument.getText().split(eol)
+      content: textDocument.getText().split(eol),
+      customFileUri: textDocument.uri
     });
   }
 
