Global

Members

(constant) loadAssignedStories

Loads stories assigned to the current user for all workspaces and updates the tree view. Shows a progress notification while fetching stories and handles any errors.

For each workspace, it:

  1. Fetches assigned stories via the Shortcut API
  2. Updates the tree view to reflect the new stories
  3. Shows a notification if no workspaces are found
Source:

(constant) loadPendingTasks

Loads pending tasks for all workspaces and updates the story tree view. Shows a progress notification while fetching tasks and handles any errors.

For each workspace, it:

  1. Fetches pending stories via the Shortcut API
  2. Updates the tree view to reflect the new stories
  3. Shows a notification if no workspaces are found
Source:

(constant) markTaskAsComplete

Marks a task as complete in both the Shortcut API and local state. Shows a success or error message based on the API response.

Source:

(constant) quickPickInput

Provides a quick pick interface for selecting and completing a task. Shows a series of dropdown menus to:

  1. Select a workspace with pending stories
  2. Select a story from that workspace
  3. Automatically selects the first pending task from that story

Shows appropriate error messages if:

  • No workspace is found
  • No story is found
  • No incomplete task is found
Source:

Methods

activate(context) → {Promise.<void>}

Activates the extension and sets up all necessary components.

Sets up:

  • Tree views for pending tasks and assigned stories
  • Initializes workspaces with API tokens from configuration
  • Registers commands for:
    • Fetching pending tasks and assigned stories
    • Completing tasks
    • Copying branch names
    • Opening stories in browser
    • Refreshing workspaces
  • Listens for configuration changes to update workspaces and views
Parameters:
Name Type Description
context vscode.ExtensionContext

The VS Code extension context providing access to extension utilities and resources
Source:
Returns:

A promise that resolves when activation is complete

Type
Promise.<void>

deactivate()

Handles cleanup when the extension is deactivated. Currently no cleanup is needed, but this function is required by VS Code's extension API.

Source:

getConfiguration() → {vscode.WorkspaceConfiguration}

Retrieves the Shortcut extension configuration from VS Code settings.

Source:
Returns:

The extension's configuration settings

Type
vscode.WorkspaceConfiguration

updateConfig(vscodeConfig)

Updates the extension's configuration settings. Creates a new Config instance with the provided VS Code workspace configuration.

Parameters:
Name Type Description
vscodeConfig vscode.WorkspaceConfiguration

The VS Code workspace configuration for the extension
Source: