// Public API exported by salesforcedx-vscode-core activate(). Use when modifying SalesforceVSCodeCoreApi, the api object in activate(), exports from core index.ts, services sub-object, or evaluating whether a change to core is breaking. Also use when someone asks "does anything use X" for a core export.
Polish the automated CHANGELOG for a release branch. Removes GUS refs, categorizes under-the-cover changes, improves customer-facing descriptions. Use when preparing/reviewing the changelog on a release branch, or when user mentions changelog quality.
Run the VS Code extension release workflow end-to-end. Use when publishing a release, running prerelease, verifying the release branch, polishing changelog for release, or installing release vsixes for verification.
Find open GitHub issues whose linked GUS work item is closed AND whose issue number appears in CHANGELOG.md, then close them. Use when user invokes /shipped-issues or asks to clean up shipped issues.
Use file-based span/log export for AI consumption. Where it lives, how to enable/clear, record format for Node and Web. Use when enabling span file dump, debugging traces for AI, or configuring local observability.
writing, running, and debugging Playwright tests; creating and recreating scratch orgs (Dreamhouse, minimal, non-tracking); working with their output from github actions
Author and use Wireit scripts for npm. Use when working with Wireit configuration, npm scripts, build pipelines, or when the user mentions Wireit.
| name | core-extension-api |
| description | Public API exported by salesforcedx-vscode-core activate(). Use when modifying SalesforceVSCodeCoreApi, the api object in activate(), exports from core index.ts, services sub-object, or evaluating whether a change to core is breaking. Also use when someone asks "does anything use X" for a core export. |
packages/salesforcedx-vscode-core/src/index.ts — activate() returns SalesforceVSCodeCoreApi.
Consumers access via:
const ext = vscode.extensions.getExtension<SalesforceVSCodeCoreApi>(
'salesforce.salesforcedx-vscode-core'
);
const api = ext.exports;
Also consumed indirectly via @salesforce/vscode-service-provider.
See external-consumers for full list and search commands.
Breaking (check consumers first):
SalesforceVSCodeCoreApiservices.* classes (.getInstance())services sub-objectNon-breaking: add new fields.
channelService, getUserId, getAuthFields, isCLIInstalled,
SfCommandlet, SfCommandletExecutor, WorkspaceContext,
telemetryService, workspaceContextUtils, sharedAuthState
services (class constructors with static methods)RegistryAccess, ChannelService (.getInstance(name)),
SalesforceProjectConfig, TelemetryService (.getInstance(name)),
WorkspaceContext (.getInstance()), CommandEventDispatcher (.getInstance())
External consumers predominantly use services.*. The .getInstance() signatures are public contract.
Some capabilities at both levels (e.g. telemetryService instance top-level, services.TelemetryService class). Consumers may use either/both — check both when evaluating usage.
\.exports\.MEMBER — catches direct access outside wrapper filesgh api -X GET "search/code?q=SYMBOL+org:forcedotcom&per_page=30" \
--jq '.items[] | "\(.repository.name): \(.path)"'
# also search salesforcecli org
gh api -X GET "search/code?q=SYMBOL+org:salesforcecli&per_page=30" \
--jq '.items[] | "\(.repository.name): \(.path)"'
# also search for exports.SYMBOL (direct access pattern)
gh api -X GET "search/code?q=exports.SYMBOL+org:forcedotcom&per_page=30" \
--jq '.items[] | "\(.repository.name): \(.path)"'
gh api repos/forcedotcom/REPO/contents/PATH --jq '.content' | base64 -dextensionDependencies: ["salesforce.salesforcedx-vscode-core"]semver.satisfies(version, '>=X.Y.Z'))SalesforceVSCodeCoreApi directly).getInstance(extensionName) on services classes