Merge pull request #1382 from scalameta/zip-reports

feature: zip reports command added
scalameta · Mar 31, 2023 · a41d39b · a41d39b
2 parents 9c60344 + 69693a3
commit a41d39b
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/packages/metals-languageclient/src/interfaces/ServerCommands.ts b/packages/metals-languageclient/src/interfaces/ServerCommands.ts
@@ -110,6 +110,11 @@ export const ServerCommands = {
    * only if more than one result is found.
    */
   SuperMethodHierarchy: "super-method-hierarchy",
+  /**
+   * Zip all the reports from the `.metals/.reports` into a `.metals/reports.zip`.
+   * This zipped file can be added to a GitHub issue to help with debugging.
+   */
+  ZipReports: "zip-reports",
 } as const;
 
 type ServerCommands = typeof ServerCommands;
diff --git a/packages/metals-vscode/package.json b/packages/metals-vscode/package.json
@@ -479,6 +479,11 @@
         "category": "Metals",
         "title": "Run doctor"
       },
+      {
+        "command": "metals.zip-reports",
+        "category": "Metals",
+        "title": "Zip reports"
+      },
       {
         "command": "metals.show-release-notes",
         "category": "Metals",
@@ -749,6 +754,10 @@
           "command": "metals.doctor-run",
           "when": "metals:enabled"
         },
+        {
+          "command": "metals.zip-reports",
+          "when": "metals:enabled"
+        },
         {
           "command": "metals.show-release-notes",
           "when": "metals:enabled"

diff --git a/packages/metals-vscode/src/extension.ts b/packages/metals-vscode/src/extension.ts
@@ -490,6 +490,7 @@ function launchMetals(
         ServerCommands.AmmoniteStop,
         ServerCommands.ScalaCliStart,
         ServerCommands.ScalaCliStop,
+        ServerCommands.ZipReports,
         "open-new-github-issue",
       ].forEach((command) => {
         registerCommand("metals." + command, async () =>