VS Code Ox Content

VS Code support for Ox Content authoring and i18n workflows.

Features:

Ox Content LSP client
frontmatter schema completion and diagnostics
i18n key completion, hover, definition, diagnostics, and inlay hints for JS/TS
command palette actions for table/code fence/callout insertion
Ox Content HTML preview with HMR: opening the preview subscribes the document with the LSP, and the panel reloads on every oxContent/previewDidChange notification (no client-side polling)
.mdc files associated with Markdown and component tag diagnostics
built-in meta frontmatter completion and diagnostics
i18n inlay previews plus document links to translation dictionaries
optional textlint diagnostics on save, including quick fixes when textlint reports a fix
half-width/full-width spacing diagnostics, quick fixes, and opt-in save-time fixes

Configuration

Setting	Type	Description
`oxContent.server.path`	string	Absolute or workspace-relative path to `ox-content-lsp`. Empty falls back to `target/debug` → `target/release` → `cargo run`.
`oxContent.frontmatter.schema`	string	Path to a frontmatter schema (Markdown + `.mdc`). Empty uses the built-in Ox Content schema for common fields and `meta`.
`oxContent.preview.autoRefresh`	boolean	Re-render the preview as you type (default `true`).
`oxContent.textlint.enabled`	boolean	Run textlint through the LSP on save (default `false`).
`oxContent.textlint.command`	string	Optional textlint command. Empty falls back to `npx textlint`; common value: `pnpm exec textlint`.
`oxContent.spacing.betweenHalfAndFullWidth`	string	`forbid` (default), `require`, or `off` for spaces between half-width ASCII and full-width CJK text.
`oxContent.spacing.autoFixOnSave`	boolean	Opt-in save-time spacing fixes via `willSaveWaitUntil`, including VS Code auto save (default `false`).

The environment variable OX_CONTENT_LSP_PATH is honored as an override between oxContent.server.path and the local-binary probe. CI and the integration test runner use it so they can point at a freshly built target/release/ox-content-lsp without writing per-workspace settings.

textlint

Set oxContent.textlint.enabled: true to have the LSP run textlint for Markdown and .mdc files on save. Findings are published as normal LSP diagnostics with source: "textlint".

The command override is passed to the server as-is before the standard --format json --stdin --stdin-filename <path> arguments are appended. When textlint returns a JSON fix, the extension exposes it as a normal quick fix.

Spacing

The built-in spacing rule defaults to forbid, so Rust と TypeScript is diagnosed and the quick fix removes the spaces. Set oxContent.spacing.betweenHalfAndFullWidth: "require" to enforce the opposite style and insert spaces for RustとTypeScript.

Save-time fixes are intentionally opt-in:

{
  "oxContent.spacing.autoFixOnSave": true
}

Publishing

Marketplace, Open VSX, and Zed release setup is documented in PUBLISHING.md.

Preview HMR

oxContent.openPreview opens a webview that subscribes to LSP push updates instead of debouncing on onDidChangeTextDocument. The flow is:

The extension calls oxContent.previewSubscribe with the document URI; the LSP returns the initial rendered HTML.
Every text change to that document triggers oxContent/previewDidChange from the LSP, which the panel applies directly.
Disposing the webview (or closing the document) sends oxContent.previewUnsubscribe.

Set oxContent.preview.autoRefresh: false to opt out — the panel still opens but stops at the initial render.

Testing

The extension has two test surfaces.

Unit tests (pure node, no VS Code host):

pnpm --filter vscode-ox-content test:unit
# or, from the repo root:
vp run test:vscode-unit

These exercise the helpers extracted into src/internal/ (path resolution, preview HTML, command guards, snippet shape). They run on every CI build and are part of vp run test.

Integration tests (real VS Code Electron host via @vscode/test-cli):

# Once, to produce the LSP the extension talks to:
vp run build:lsp

# Then run the integration suite (Linux needs xvfb-run prefix):
node scripts/run-vscode-tests.mjs
# or from the repo root:
vp run test:vscode

The driver script (scripts/run-vscode-tests.mjs) sets OX_CONTENT_LSP_PATH to the absolute path of the freshly built target/release/ox-content-lsp so the test workspace does not need a .vscode/settings.json. Integration tests that depend on the LSP responding self-skip when the binary is unavailable.

CI runs both jobs under .github/workflows/ci.yml (vscode-test).

vscode-ox-content

ubugeeei