TextGuard for VS Code

VS Code integration for TextGuard.

Current capability

Run TextGuard: Scan Active Editor from the Command Palette. The extension scans the full active document and publishes each match as a VS Code warning diagnostic, so matches appear inline and in the Problems panel.

The extension also scans documents automatically when they are saved. This behavior is enabled by default and can be disabled through the textguard.scanOnSave VS Code setting.

Choose the scanning policy with textguard.preset. Supported values are strict (default), enterprise, and socialMedia. Changing the preset refreshes diagnostics for currently open file documents, and the same preset is used by Explain so diagnostics and explanations stay consistent.

Use textguard.whitelist for project-specific allowed words that should not produce diagnostics. Updating it refreshes currently open file documents immediately.

{
  "textguard.whitelist": ["project-name", "approved-term"]
}

For a TextGuard diagnostic, open VS Code Quick Fix actions and choose Explain TextGuard match. The extension reuses the Core Explain API and shows the matched text, source, and structured reason without duplicating detection logic in the extension.

Package and install locally

The extension remains outside the root pnpm workspace, so its Marketplace tooling does not affect the library workspace lockfile. The current @vscode/vsce release requires Node.js 22 or newer for packaging.

From integrations/vscode:

npm install
npm run check-types
npm run package:vsix

This produces a versioned textguard-vscode-<version>.vsix. Install it from VS Code using Extensions → … → Install from VSIX…, or from the command line with code --install-extension <file>.vsix.

The .vscodeignore file keeps TypeScript sources and build-only files out of the installable VSIX.

CI packaging

.github/workflows/vscode-extension.yml validates the extension independently from the root pnpm workspace. Changes under integrations/vscode are type-checked, built, packaged into a VSIX, and uploaded as a GitHub Actions artifact.

Marketplace publishing

TextGuard is publicly available in the Visual Studio Marketplace under publisher textguard. Marketplace releases remain deliberate and versioned; the release workflow verifies the requested version before packaging and publishing the reviewed VSIX.