Commercebuild Apps
Opens a Commercebuild app from the store admin's online code editor in
VS Code. The editor's VS Code button opens
vscode://commercebuild.vscode-store-app/open?app=<app id>&store=<store url>
and this extension:
- asks for the folder in which app projects live (once; "Remember This
Folder" stores it in the
commercebuild.appsRoot setting),
- shows what will run and asks for confirmation,
- runs
npx commercebuild-cli@latest extension open <app id> --store <url>
in the background with a progress notification. Its output goes to the
"Commercebuild Apps" output channel; on failure an error notification
links there. An integrated terminal is used only when npx cannot be
started from VS Code (for example Node.js installed through a version
manager that only the shell knows about).
The CLI downloads a fresh copy of the app's saved draft into
<folder>/<app-name> (or <app-name>(1), (2), … when that name is
already taken — an earlier download is never touched). The extension then
opens the project in the current window when that window is empty (the
usual case when the link started VS Code), otherwise in a new window. Dependencies are not installed; run yarn install (or
npm install) yourself after reviewing the code. VS Code's Workspace Trust
prompt stays on. Inside the project, yarn save writes your changes back to
the online draft and yarn deploy / yarn release build and publish.
The Commercebuild: Open App... command does the same from the command
palette for an app id and store URL you type in.
Requirements
- Node.js 22+ on your PATH (
npx ships with it).
- A Commercebuild store admin account with access to the app editor.
Scope of this version
This version works against the current development backend of the app
platform. It adds no authentication of its own: the CLI it runs talks to the
same endpoints as the online editor. Production use waits for the
authenticated app backend.
Development
pnpm --filter vscode-store-app test # vitest (pure modules)
pnpm --filter vscode-store-app type-check
pnpm --filter vscode-store-app build # dist/extension.js (esbuild)
pnpm --filter vscode-store-app package # vscode-store-app-<version>.vsix
code --install-extension packages/vscode-store-app/vscode-store-app-<version>.vsix
Press F5 in VS Code with this folder open to run the extension host; test a
link with code --open-url "vscode://commercebuild.vscode-store-app/open?app=...&store=...".
Publishing: see the root README, "Releasing".