Merge branch 'master' into remove-checkout-commit-from-staged

extension/package.json

@@ -255,6 +255,11 @@
         "command": "dvc.showExperiments",
         "category": "DVC"
       },
+      {
+        "title": "%command.showOutput%",
+        "command": "dvc.showOutput",
+        "category": "DVC"
+      },
       {
         "title": "%command.stopRunningExperiment%",
         "command": "dvc.stopRunningExperiment",
@@ -456,8 +461,13 @@
         },
         {
           "command": "dvc.checkout",
-          "group": "DVC",
+          "group": "1_DVC",
           "when": "scmProvider == dvc && dvc.commands.available == true"
+        },
+        {
+          "command": "dvc.showOutput",
+          "group": "3_footer",
+          "when": "scmProvider == dvc"
         }
       ],
       "scm/resourceState/context": [
@@ -759,6 +769,18 @@
             ],
             "when": "dvc.commands.available == true && dvc.project.available == true"
           },
+          {
+            "id": "dvc.showOutput",
+            "title": "Output channel",
+            "description": "View the DVC output channel.\n[View output](command:dvc.showOutput)",
+            "media": {
+              "markdown": "resources/walkthrough/output-channel.md"
+            },
+            "completionEvents": [
+              "onCommand:dvc.showOutput"
+            ],
+            "when": "dvc.commands.available == true && dvc.project.available == true"
+          },
           {
             "id": "dvc.scm",
             "title": "Source control management",

extension/package.nls.json

@@ -39,6 +39,7 @@
   "command.setupWorkspace": "Setup The Workspace",
   "command.showCommands": "Show Commands",
   "command.showExperiments": "Show Experiments",
+  "command.showOutput": "Show DVC Output",
   "command.stopRunningExperiment": "Stop Running Experiment",
   "command.views.experimentsFilterByTree.removeAllFilters": "Remove All Filters From Experiments Table",
   "command.views.experimentsFilterByTree.removeFilter": "Remove Filter From Experiments Table",

extension/resources/walkthrough/output-channel.md

@@ -0,0 +1,16 @@
+# Output channel
+
+All commands which are run against the DVC CLI are logged into this extension's
+dedicated output channel.
+
+The channel will have two entries for each command that runs.
+
+The first shows the command has started and the second is to signify that it has
+completed.
+
+The completion entry will show:
+
+- The outcome of the command (COMPLETED / FAILED).
+- Any non-zero exit codes.
+- The length of time that each command took to run (ms).
+- Any error message provided by the CLI.

extension/src/commands/external.ts

@@ -38,6 +38,7 @@ export enum RegisteredCommands {
   EXTENSION_GET_STARTED = 'dvc.getStarted',
   EXTENSION_SETUP_WORKSPACE = 'dvc.setupWorkspace',
   EXTENSION_SHOW_COMMANDS = 'dvc.showCommands',
+  EXTENSION_SHOW_OUTPUT = 'dvc.showOutput',
 
   DELETE_TARGET = 'dvc.deleteTarget',
   MOVE_TARGETS = 'dvc.moveTargets',

extension/src/commands/internal.ts

@@ -10,6 +10,7 @@ import { Config } from '../config'
 import { sendTelemetryEvent, sendTelemetryEventAndThrow } from '../telemetry'
 import { StopWatch } from '../util/time'
 import { OutputChannel } from '../vscode/outputChannel'
+import { reportErrorWithOptions } from '../vscode/reporting'
 
 type Command = (...args: Args) => unknown | Promise<unknown>
 
@@ -69,7 +70,7 @@ export class InternalCommands {
         try {
           return await this.runAndSendTelemetry<T>(name, func, arg)
         } catch (e: unknown) {
-          this.outputChannel.offerToShowError()
+          this.offerToShowError()
         }
       })
     )
@@ -126,4 +127,16 @@ export class InternalCommands {
   private confirmedId(commandId: string): commandId is CommandId {
     return Object.values(AvailableCommands).includes(commandId as CommandId)
   }
+
+  private async offerToShowError() {
+    const show = 'Show'
+    const response = await reportErrorWithOptions(
+      'Something went wrong, please see the DVC output channel for more details.',
+      show,
+      'Close'
+    )
+    if (response === show) {
+      return this.outputChannel.show()
+    }
+  }
 }

extension/src/extension.ts

@@ -223,6 +223,11 @@ export class Extension implements IExtension {
       })
     )
 
+    this.internalCommands.registerExternalCommand(
+      RegisteredCommands.EXTENSION_SHOW_OUTPUT,
+      () => outputChannel.show()
+    )
+
     registerRepositoryCommands(this.repositories, this.internalCommands)
 
     reRegisterVsCodeCommands(this.internalCommands)

extension/src/telemetry/constants.ts

@@ -106,6 +106,7 @@ export interface IEventNamePropertyMapping {
   [EventName.EXTENSION_GET_STARTED]: undefined
   [EventName.EXTENSION_SETUP_WORKSPACE]: { completed: boolean }
   [EventName.EXTENSION_SHOW_COMMANDS]: undefined
+  [EventName.EXTENSION_SHOW_OUTPUT]: undefined
 
   [EventName.VIEWS_EXPERIMENTS_TREE_OPENED]: DvcRootCount
   [EventName.VIEWS_EXPERIMENTS_FILTER_BY_TREE_OPENED]: DvcRootCount

extension/src/test/suite/extension.test.ts

@@ -17,6 +17,7 @@ import { RegisteredCommands } from '../../commands/external'
 import * as Setup from '../../setup'
 import * as Telemetry from '../../telemetry'
 import { EventName } from '../../telemetry/constants'
+import { OutputChannel } from '../../vscode/outputChannel'
 
 suite('Extension Test Suite', () => {
   const dvcPathOption = 'dvc.dvcPath'
@@ -371,11 +372,19 @@ suite('Extension Test Suite', () => {
   describe('dvc.showCommands', () => {
     it('should show all of the dvc commands without error', async () => {
       await expect(
-        commands.executeCommand('dvc.showCommands')
+        commands.executeCommand(RegisteredCommands.EXTENSION_SHOW_COMMANDS)
       ).to.be.eventually.equal(undefined)
     })
   })
 
+  describe('dvc.showOutput', () => {
+    it('should be able to show the output channel', async () => {
+      const showOutputSpy = spy(OutputChannel.prototype, 'show')
+      await commands.executeCommand(RegisteredCommands.EXTENSION_SHOW_OUTPUT)
+      expect(showOutputSpy).to.have.been.calledOnce
+    })
+  })
+
   describe('view container', () => {
     it('should be able to focus the experiments view container', async () => {
       await expect(

extension/src/vscode/outputChannel.ts

@@ -1,6 +1,5 @@
 import { Disposable } from '@hediet/std/disposable'
 import { OutputChannel as VSOutputChannel, window } from 'vscode'
-import { reportErrorWithOptions } from './reporting'
 import { ICli } from '../cli'
 
 enum ProcessStatus {
@@ -24,16 +23,8 @@ export class OutputChannel {
     })
   }
 
-  public async offerToShowError() {
-    const show = 'Show'
-    const response = await reportErrorWithOptions(
-      'Something went wrong, please see the DVC output channel for more details.',
-      show,
-      'Close'
-    )
-    if (response === show) {
-      return this.outputChannel.show()
-    }
+  public show() {
+    return this.outputChannel.show()
   }
 
   private onDidStartProcess(cli: ICli) {