Zed Extension for Stata

A Zed extension providing support for the Stata statistical programming language.

Features

• Code completion
• Diagnostics (e.g., detects syntax errors and undefined macros)
• Syntax highlighting
• Run Stata code from the editor (requires additional setup—see below)
  • Send to Stata
  • Jupyter REPL

⚠️ Development Status: This is an early-stage implementation. While functional, it requires substantial testing and code review. Contributions and feedback are welcome!

Related Repositories:

• Sight - A language server and VS Code extension for Stata
• tree-sitter-stata - A tree-sitter grammar
• send-to-stata - A utility for sending Stata code to the Stata application This Zed extension uses the tree-sitter grammar and language server from those repositories to provide syntax highlighting and diagnostics. The send-to-stata utility sends code to Stata on Windows; macOS uses AppleScript.

Installation

Install from the Zed extension marketplace by searching for "Stata".

Syntax highlighting, completions, and diagnostics will work immediately once you open a ".do" file.

Outline Configuration

Zed can populate the outline and breadcrumbs from Sight's LSP textDocument/documentSymbol response instead of the tree-sitter outline query.

Add the following to your Zed user settings:

{
  "languages": {
    "Stata": {
      "document_symbols": "on"
    }
  }
}

You can add this in either of these places:

• User settings (~/.config/zed/settings.json on macOS/Linux, %APPDATA%\Zed\settings.json on Windows) to enable LSP-backed outline for all Stata files

• Project settings (.zed/settings.json in a repository) to enable it only for that project

Without this setting, Zed uses the tree-sitter outline query, which is currently much narrower than Sight's document symbols.

Send to Stata (Optional)

Execute Stata code directly from Zed with keyboard shortcuts. Works with both the Stata application and terminal sessions.

See tools/send-to-stata/README.md for full documentation, configuration options, and troubleshooting.

Keyboard Shortcuts

macOS

Run the installer in Terminal:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/jbearak/zed-stata/main/tools/send-to-stata/install-macos.sh)"

Windows

winget install Microsoft.PowerShell

Run the installer in PowerShell:

irm https://raw.githubusercontent.com/jbearak/zed-stata/main/tools/send-to-stata/install-windows.ps1 | iex

Jupyter REPL (Optional)

The installer creates two Jupyter kernels:

The workspace kernel walks up from the file's directory looking for .git, .stata-project, or .project markers to find the project root. If no marker is found, it falls back to the file's directory.

Usage in Zed:

1. Open a .do file
2. Select stata or stata_workspace as the kernel
3. Click the 🔄 icon in the editor toolbar to execute code or use Control+Shift+Enter keyboard shortcut

Note: stata_kernel works well for interactive exploration but can hang on long-running loops or operations taking more than several seconds. For batch scripts or iterative workflows, use Send to Stata instead. See comparison table below.

macOS

Run the installer in Terminal:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/jbearak/zed-stata/main/tools/jupyter-kernel/install-macos.sh)"

Windows

winget install Microsoft.PowerShell

Run the installer in PowerShell:

irm https://raw.githubusercontent.com/jbearak/zed-stata/main/tools/jupyter-kernel/install-windows.ps1 | iex

Choosing Between Send-to-Stata and Jupyter REPL

What the Install Scripts Do

Why Install Scripts Are Required

The extension provides basic tasks that show installation instructions, but full Send-to-Stata and Jupyter REPL functionality requires running the installers because:

• Temp file management: Stata executes code from .do files, so the script creates temp files and manages cleanup
• Statement detection: Multi-line statements with /// continuations require parsing logic
• Stata variant detection: The script auto-detects which Stata variant (MP, SE, IC) is installed
• Keybindings: Zed extensions cannot register keybindings; they must be added to user config files
• Platform-specific binaries: Windows requires a native executable for clipboard/SendKeys automation

Send-to-Stata Installer

The send-to-stata installer configures keyboard shortcuts to send code from Zed to Stata.

What It Does NOT Do:

• Does not modify Stata installation
• Does not require admin/sudo privileges
• Does not install system-wide packages

Files Created (macOS)

Files Created (Windows)

Jupyter Kernel Installer

The Jupyter kernel installer sets up stata_kernel for use with Zed's REPL.

Files Created (macOS)

Files Created (Windows)

Manual Keybindings Setup

If you prefer to configure keybindings manually instead of running the installer, add the following to your Zed keymap file.

macOS

Add to ~/.config/zed/keymap.json:

[
  {
    "context": "Editor && extension == do",
    "bindings": {
      "cmd-enter": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: Do Statement"}]]],
      "shift-cmd-enter": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: Do File"}]]],
      "alt-cmd-enter": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: Include Statement"}]]],
      "alt-shift-cmd-enter": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: Include File"}]]],
      "shift-enter": ["workspace::SendKeystrokes", "cmd-c ctrl-` cmd-v enter"],
      "alt-enter": ["workspace::SendKeystrokes", "cmd-left shift-cmd-right cmd-c ctrl-` cmd-v enter"],
      "ctrl-shift-w": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: CD to Workspace"}]]],
      "ctrl-shift-f": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: CD to File Directory"}]]]
    }
  }
]

Windows

Add to %APPDATA%\Zed\keymap.json:

[
  {
    "context": "Editor && extension == do",
    "bindings": {
      "ctrl-enter": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: Do Statement"}]]],
      "shift-ctrl-enter": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: Do File"}]]],
      "alt-ctrl-enter": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: Include Statement"}]]],
      "alt-shift-ctrl-enter": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: Include File"}]]],
      "shift-enter": ["workspace::SendKeystrokes", "ctrl-c ctrl-` ctrl-v enter"],
      "alt-enter": ["workspace::SendKeystrokes", "home shift-end ctrl-c ctrl-` ctrl-v enter"],
      "ctrl-shift-w": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: CD to Workspace"}]]],
      "ctrl-shift-f": ["action::Sequence", ["workspace::Save", ["task::Spawn", {"task_name": "Stata: CD to File Directory"}]]]
    }
  }
]

Building from Source

See DEVELOPMENT.md for detailed development setup, directory structure, and workflows.

Send-to-Stata

Install from a local clone:

git clone https://github.com/jbearak/zed-stata
cd zed-stata

# macOS
./tools/send-to-stata/install-macos.sh

# Windows (PowerShell 7+)
pwsh -File .\tools\send-to-stata\install-windows.ps1

Jupyter Kernel

Install stata_kernel from a local clone:

git clone https://github.com/jbearak/zed-stata
cd zed-stata

# macOS
./tools/jupyter-kernel/install-macos.sh

# Windows (PowerShell 7+)
pwsh -File .\tools\jupyter-kernel\install-windows.ps1

Related Projects

• Sight LSP - A language server protocol implementation for the Stata statistical programming language
• tree-sitter-stata - Tree-sitter grammar for Stata

License

Copyright © 2026 Jonathan Marc Bearak

GPLv3 - This project is open source software. You can use, modify, and distribute it with attribution, but any derivative works must also be open source under GPLv3.