Neovim Setup for Sight

This guide explains how to configure Neovim to use the Sight language server and tree-sitter grammar for Stata syntax highlighting.

Contents

• Prerequisites
• Language Server
  • Installing the Language Server
  • LazyVim / lazy.nvim
  • Standard Neovim
• Tree-sitter
• Send to Stata
• Troubleshooting

Prerequisites

• Neovim 0.8+ (for native LSP support)
• nvim-lspconfig plugin
• nvim-treesitter plugin
• Sight language server installed (see Installation)

Language Server

Installing the Language Server

Install the Sight language server globally:

# From a Sight checkout
./scripts/setup.sh

Verify the installation:

sight --help

LazyVim / lazy.nvim Configuration

Copy neovim/sight-lsp-lazyvim.lua to ~/.config/nvim/lua/plugins/stata.lua.

Standard Neovim Configuration (without lazy.nvim)

Copy neovim/sight-lsp.lua to ~/.config/nvim/lua/ or add its contents to your init.lua.

Tree-sitter Configuration

For syntax highlighting, install and configure tree-sitter-stata:

1. Add the parser to nvim-treesitter

Add this to your configuration:

local parser_config = require('nvim-treesitter.parsers').get_parser_configs()

parser_config.stata = {
  install_info = {
    url = 'https://github.com/jbearak/tree-sitter-stata',
    files = { 'src/parser.c', 'src/scanner.c' },
    branch = 'main',
  },
  filetype = 'stata',
}

2. Install the parser

Run in Neovim:

:TSInstall stata

3. Enable highlighting

Ensure tree-sitter highlighting is enabled in your config:

require('nvim-treesitter.configs').setup({
  highlight = {
    enable = true,
  },
})

Send to Stata (macOS)

Neovim can send code to the Stata GUI application using AppleScript.

Setup:

1. Copy neovim/stata-send.lua to ~/.config/nvim/lua/stata-send.lua
2. Add keybindings (see below)

Multi-line statements using /// continuation are automatically detected.

Keybinding Configuration

LazyVim / lazy.nvim: Add to ~/.config/nvim/lua/plugins/stata-send.lua:

return {
  {
    "neovim/nvim-lspconfig",
    ft = "stata",
    config = function()
      require("stata-send").setup()
      vim.api.nvim_create_autocmd("FileType", {
        pattern = "stata",
        callback = function()
          local opts = { buffer = true, silent = true }
          vim.keymap.set({ "n", "v" }, "<leader>ss", function() require("stata-send").send("do") end, vim.tbl_extend("force", opts, { desc = "Stata: Do line/selection" }))
          vim.keymap.set({ "n", "v" }, "<leader>sf", function() require("stata-send").send_file("do") end, vim.tbl_extend("force", opts, { desc = "Stata: Do file" }))
          vim.keymap.set({ "n", "v" }, "<leader>si", function() require("stata-send").send("include") end, vim.tbl_extend("force", opts, { desc = "Stata: Include line/selection" }))
          vim.keymap.set({ "n", "v" }, "<leader>sF", function() require("stata-send").send_file("include") end, vim.tbl_extend("force", opts, { desc = "Stata: Include file" }))
        end,
      })
    end,
  },
}

Standard Neovim: Add to your init.lua:

require("stata-send").setup()

vim.api.nvim_create_autocmd("FileType", {
  pattern = "stata",
  callback = function()
    local opts = { buffer = true, silent = true }
    vim.keymap.set({ "n", "v" }, "<leader>ss", function() require("stata-send").send("do") end, vim.tbl_extend("force", opts, { desc = "Stata: Do line/selection" }))
    vim.keymap.set({ "n", "v" }, "<leader>sf", function() require("stata-send").send_file("do") end, vim.tbl_extend("force", opts, { desc = "Stata: Do file" }))
    vim.keymap.set({ "n", "v" }, "<leader>si", function() require("stata-send").send("include") end, vim.tbl_extend("force", opts, { desc = "Stata: Include line/selection" }))
    vim.keymap.set({ "n", "v" }, "<leader>sF", function() require("stata-send").send_file("include") end, vim.tbl_extend("force", opts, { desc = "Stata: Include file" }))
  end,
})

Keyboard Shortcuts

Action	Shortcut
Do line or selection	<leader>ss
Do file	<leader>sf
Include line or selection	<leader>si
Include file	<leader>sF

(Default <leader> is typically space)

User Commands

All commands are available via :Sight<Tab>:

Command	Description
:SightDo	Execute current line or visual selection
:SightDoUpwardLines	Execute from start of file to current line
:SightDoDownwardLines	Execute from current line to end of file
:SightDoFile	Execute entire file
:SightInclude	Include current line or visual selection
:SightIncludeFile	Include entire file
:SightCdFile	Change Stata's working directory to file's directory
:SightCdWorkspace	Change Stata's working directory to workspace root

Troubleshooting

LSP not starting

• Ensure sight is in your PATH: which sight
• Check :LspLog for error messages
• Verify the filetype is detected: :set filetype? should show stata

No syntax highlighting

• Run :TSInstallInfo and check if stata is installed
• Try reinstalling: :TSInstall! stata
• Check :TSModuleInfo to verify highlight module is enabled

Parser compilation errors

If the tree-sitter parser fails to compile, ensure you have a C compiler installed:

• macOS: xcode-select --install
• Linux: sudo apt install build-essential (Debian/Ubuntu)