@wix/wix-code-diagnostics-plugin
v1.1.5
Published
Wix CLI plugin that forwards CLI build/preview/dev diagnostics to the code-project-orchestrator over HTTP
Maintainers
Keywords
Readme
@wix/wix-code-diagnostics-plugin
Wix CLI plugin that forwards CLI build / preview / dev diagnostics to the
code-project-orchestrator directly over HTTP, bypassing the remote-machine →
Greyhound pipeline.
Usage
Register it in wix.config.mjs:
import { defineWixConfig } from '@wix/cli/config';
import { wixCodeDiagnosticsPlugin } from '@wix/wix-code-diagnostics-plugin';
export default defineWixConfig({
config: {
/* ... */
},
plugins: [wixCodeDiagnosticsPlugin()],
});Activation
The plugin is inert unless both environment variables are present, so the committed config is identical on every machine and activation is controlled by the task command that runs the CLI:
| Env var | Purpose |
|---|---|
| WIX_CODE_DIAGNOSTICS_ENDPOINT | Full URL of the orchestrator's ReportCodeDiagnostic endpoint |
| WIX_CODE_DIAGNOSTICS_TOKEN | Authorized access token, sent as the Authorization header |
When active, on each diagnostic it reads siteId (metaSiteId) and devArmTag
(overrideId) from .wix/app.config.json and POSTs
{ overrideId, metaSiteId, phase, status } to the endpoint. Reporting is
best-effort and never fails the CLI run.
Interim: until the CLI exposes
build/previewerror + success events, the plugin subscribes to the dev process'sdc-updatedevent to exercise the transport end to end.
