Merge branch 'topic/#1167' into 'master'

Provide a template in 'Help/Report Issue'

See merge request eng/ide/ada_language_server!2043

Author: AnthonyLeonardoGracio

integration/vscode/ada/media/report_issue_template.md

@@ -0,0 +1,21 @@
+# Bug Summary and Reproducer
+
+Please describe the feature (for example, completion) that is not working as expected.
+Include information about the actual workspace project (for example, is the project an aggregate project, does it target native platforms or cross platforms etc.).
+
+## Bug Summary
+
+## Steps to reproduce
+
+1.
+
+## Expected Behavior
+
+## Configuration and Logs
+
+Please provide your VS Code workspace-specific configuration files and logs. Logs are in particular very useful to investigate bugs such as unexpected exceptions.
+
+- `tasks.json` file (for VS Code task-related issues) or `launch.json` (for VS Code debug-related issues)
+- Logs from running `Ada: Show extension output` from the VS Code command palette
+- Logs from the Ada Language Server in the  `$HOME/.als directory` (`%USERPROFILE%/.als` on Windows). More info about ALS logging can be found [here](https://github.com/AdaCore/ada_language_server/blob/master/doc/traces.md)
+

integration/vscode/ada/package.json

@@ -1140,6 +1140,10 @@
             {
                 "command": "ada.loadGnatCovXMLReport",
                 "title": "ada: GNATcoverage - Load an existing XML coverage report"
+            },
+            {
+                "command": "ada.issueReporter",
+                "title": "Ada: Report Issue"
             }
         ],
         "keybindings": [
@@ -1185,6 +1189,11 @@
                     "when": "editorLangId == ada"
                 }
             ],
+            "issue/reporter": [
+                {
+                    "command": "ada.issueReporter"
+                }
+            ],
             "editor/context": [
                 {
                     "command": "ada.otherFile",

integration/vscode/ada/src/commands.ts

@@ -1,6 +1,6 @@
 import assert from 'assert';
-import { existsSync } from 'fs';
-import { basename } from 'path';
+import { existsSync, readFileSync } from 'fs';
+import path, { basename } from 'path';
 import * as vscode from 'vscode';
 import { SymbolKind, commands } from 'vscode';
 import { Disposable } from 'vscode-jsonrpc';
@@ -228,6 +228,10 @@ export function registerCommands(context: vscode.ExtensionContext, clients: Exte
         commands.registerCommand('ada.loadGnatCovXMLReport', loadGnatCovXMLReport),
     );
 
+    context.subscriptions.push(
+        vscode.commands.registerCommand('ada.issueReporter', openReportIssue),
+    );
+
     registerTaskWrappers(context);
 }
 
@@ -361,6 +365,21 @@ interface TaskQuickPickItem extends vscode.QuickPickItem {
     task: vscode.Task;
 }
 
+/**
+ * Display the VS Code Issue Reporter, providing a default template
+ * for reporing issues on the Ada & SPARK VS Code extension.
+ */
+async function openReportIssue() {
+    const EXTENSION_ROOT_DIR = adaExtState.context.extensionPath;
+    const templatePath = path.join(EXTENSION_ROOT_DIR, 'media', 'report_issue_template.md');
+    const template = readFileSync(templatePath, 'utf8');
+
+    await vscode.commands.executeCommand('workbench.action.openIssueReporter', {
+        extensionId: 'adacore.ada',
+        issueBody: template,
+    });
+}
+
 /**
  * Propose to the User a list of build and run tasks, one for each main defined
  * in the project.