TSQX Compiler

VS Code Marketplace

English | 简体中文

Compile TSQX geometry files to high-quality PDF diagrams via Asymptote, with live preview, syntax highlighting, and auto-compile — all inside VS Code.

Features

• Persistent Live Preview — View a vector preview side-by-side; refreshes retain the panel, zoom, and scroll position.
• Auto-Compile on Save — Enabled by default. Every time you save a .tsqx file, the PDF is recompiled and refreshed automatically.
• Syntax Highlighting — Full TextMate grammar for .tsqx files: comments, point definitions, draw commands, built-in functions, Asymptote color names, and operators.
• TXT File Support — Right-click any .txt file and choose Set Current File as TSQX to get full TSQX support.
• Inline Diagnostics — Compilation errors and warnings appear directly in the editor's Problems panel.
• Status Bar — Shows compilation status and auto-compile toggle (click to switch on/off).
• Configurable Paths — Point the extension at custom tsqx and asy executables if they aren't on $PATH.
• First-Use Setup — Check the toolchain and choose output and auto-compile behavior from a guided setup.
• Project Output Directory — Keep generated files beside sources or under a workspace build folder without filename collisions.
• Workspace Compilation — Compile every .tsqx file with progress, cancellation, and a result summary.
• Templates and Snippets — Start common triangle, center, foot, circle, and drawing constructions quickly.
• Language Assistance — Built-in and point completion, hover documentation, document outline, and go-to-definition.
• SVG and PNG Export — Convert the generated PDF through Poppler with configurable PNG resolution.

Quick Start

1. Open a .tsqx file
2. Click the preview icon (⧉) in the editor toolbar
3. A persistent vector preview opens beside the editor — edit, save, and it refreshes without replacing the panel

Requirements

Commands

Settings

{
  "tsqx.autoCompileOnSave": true,   // auto-compile on save (default: true)
  "tsqx.autoCompileDelay": 1000,    // delay in ms before auto-compile after save
  "tsqx.compilationTimeout": 30,    // max seconds per compilation
  "tsqx.tsqxPath": "tsqx",          // path to tsqx executable
  "tsqx.asyPath": "asy",            // path to Asymptote executable
  "tsqx.pdfConverterPath": "pdftocairo", // Poppler converter used by preview/export
  "tsqx.pngDpi": 144,                // PNG export resolution (72–600 DPI)
  "tsqx.outputDirectory": "",       // empty: beside source; e.g. ".tsqx-build"
  "tsqx.extraTsqxArgs": ["-p"]      // extra CLI args; each argument is a separate array item
}

For example, use ["-p", "-s", "200"] to pass a size. Legacy string values remain supported. Commands are executed directly without a shell.

Relative output directories are resolved from the workspace root. The source folder structure is retained below that directory, so chapter1/figures/a.tsqx becomes .tsqx-build/chapter1/figures/a.pdf. Absolute paths and the ${workspaceFolder} / ${fileDirname} variables are also supported.

First-Use Setup

When the first TSQX editor opens, the extension offers to run setup. It checks the configured tsqx, asy, and pdftocairo commands, then lets you choose whether outputs stay beside source files or under .tsqx-build, and whether save-time compilation is enabled. Run TSQX: Run First-Use Setup at any time to repeat it.

Language Assistance

Completion includes documented TSQX geometry functions, points already defined in the current document, colors, and pen styles. Hover shows function signatures or the nearest preceding point definition. The Outline view lists point definitions, and Go to Definition follows point references in the current file. Static snippets are available with prefixes such as tsqx-triangle, tsqx-point, tsqx-foot, tsqx-fill, and tsqx-asy.

Preview and Export

The persistent preview converts the current PDF to SVG in the extension's private cache and displays it in a dedicated Webview. Saving recompiles and refreshes the same panel while preserving its zoom and scroll state. If pdftocairo is unavailable, the command falls back to VS Code's PDF viewer. Use Open Generated PDF whenever you want to inspect the formal PDF directly.

Development

npm ci
npm run compile
npm run lint
npm test

For a real local smoke test against the installed tsqx and asy toolchain:

npm run smoke:compile -- /path/to/file.tsqx
npm run smoke:templates
npm run smoke:export -- /path/to/file.pdf

Example:

npm run smoke:compile -- /Users/leyudame/Documents/tsqx/examples/figures/fig1.tsqx

Release workflow details are documented in docs/RELEASE.md.

How It Works

1. tsqx -p < input.tsqx > output.asy — generates Asymptote source
2. asy output.asy — compiles to PDF
3. The PDF is converted to a cached SVG for the persistent Webview preview; the formal PDF remains available separately

Activity Bar

The extension adds a TSQX panel to the Activity Bar (left sidebar). Commands are arranged in collapsible Create & Compile, Preview & Export, and Tools & Settings groups:

• Compile Current File — run the tsqx → asy → pdf pipeline
• New Figure from Template — choose a save location and create a common TSQX construction
• Compile Workspace — compile all TSQX sources sequentially with progress and cancellation
• Live Preview — open or refresh the persistent SVG preview panel
• Open Generated PDF — inspect the formal PDF in VS Code's viewer
• Export as SVG / PNG — save the current figure in another format
• Clean Generated Artifacts — remove the selected source's generated ASY and PDF after confirmation
• Toggle Auto-Compile — switch auto-compile on save on/off
• Set File as TSQX — mark a .txt file for TSQX support

Development

git clone https://github.com/yzdame/tsqx-compiler.git
cd tsqx-compiler
npm install
npm run compile   # build once
npm run watch     # rebuild on change
# Press F5 in VS Code to launch the Extension Development Host

Packaging

npx vsce package
# Produces tsqx-compiler-x.x.x.vsix

License

MIT