services-extension-consumption

Consume salesforcedx-vscode-services API to build VS Code extension service layers.

1.0k|453|Updated Jun 21, 2017
One-click install
npx skills add https://github.com/forcedotcom/salesforcedx-vscode --skill services-extension-consumption
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: services-extension-consumption
Source: https://github.com/forcedotcom/salesforcedx-vscode/tree/main/.claude/skills/services-extension-consumption
Command: npx skills add https://github.com/forcedotcom/salesforcedx-vscode --skill services-extension-consumption

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Provides guidelines for consuming the salesforcedx-vscode-services API to enable extension dependencies, command registration, and service integration across VS Code extensions.

Core Features & Use Cases

  • Structured approach to using ExtensionProviderService and building a services layer for VS Code extensions.
  • Documentation of how to register commands with a pre-loaded services layer and how to access basic services (ChannelService, MediaService, WorkspaceService, ConnectionService, ProjectService, SettingsService, FsService, EditorService).
  • Use Case: Build a new Salesforce DX extension that depends on salesforcedx-vscode-services to manage org connections, project resolution, and file watchers for dev workflows.

Quick Start

Install and reference salesforcedx-vscode-services in your extension, load the ExtensionProviderService, and begin building a services layer to register commands and interact with Channel, Media, Workspace, Connection, Project, Settings, Fs, and Editor services.

Frequently Asked Questions about services-extension-consumption

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I consume the salesforcedx-vscode-services API to build a VS Code extension?

To consume the salesforcedx-vscode-services API, install and reference the package in your VS Code extension, load the ExtensionProviderService, and build a services layer to register commands and access core services like Channel, Workspace, and Connection.

What services are available when building a Salesforce DX extension with salesforcedx-vscode-services?

When building a Salesforce DX extension with salesforcedx-vscode-services, you can access ChannelService, MediaService, WorkspaceService, ConnectionService, ProjectService, SettingsService, FsService, and EditorService to manage org connections, project resolution, and file watchers.

How do I register commands in a VS Code extension using the salesforcedx-vscode-services layer?

You register commands in a VS Code extension by loading the ExtensionProviderService, building a pre-loaded services layer, and then using that layer for command activation and observability within your Salesforce DX development workflow.

Does salesforcedx-vscode-services support file and configuration watchers for Salesforce DX workflows?

Yes, salesforcedx-vscode-services supports file and configuration watchers. You can leverage the services layer to monitor changes and manage dev workflows, project resolution, and org connections within your VS Code extension.

When do I need to load the ExtensionProviderService for my Salesforce DX extension?

You need to load the ExtensionProviderService when building a new VS Code extension that depends on salesforcedx-vscode-services to manage org connections, project resolution, and file watchers for development workflows.

What is the best way to manage org connections and project resolution in a Salesforce DX VS Code extension?

The best way to manage org connections and project resolution is by consuming the salesforcedx-vscode-services API, loading the ExtensionProviderService, and utilizing the ConnectionService and ProjectService within your extension's services layer.