A Neovim plugin for Macaulay2, providing REPL integration, syntax support, and completion for .m2 files.

• Integrated REPL with multiple layout options (vertical, horizontal, float, tab)
• Send code to REPL (line, selection, or buffer)
• Inline help lookup with viewHelp
• Keyword completion
• Filetype detection for .m2 files
• LSP integration via M2-language-server (hover, completion, and go-to-definition)

• Neovim >= 0.8 (>= 0.9 for LSP support)
• Macaulay2 installed and available in your PATH
• M2-language-server (optional, for LSP features; bundled with Macaulay2)

Using nvim's pack.add:

In your init.lua, add

vim.pack.add({'https://github.com/Macaulean/macaulay2.nvim'})

Using lazy.nvim:

{
  "Macaulean/macaulay2.nvim",
  ft = "macaulay2",
  opts = {},
}

Default configuration with all options:

{
  "mattrobball/macaulay2.nvim",
  ft = "macaulay2",
  opts = {
    repl = {
      cmd = "M2",              -- Macaulay2 executable
      args = {},               -- Additional arguments to pass to M2
      direction = "vertical",  -- "vertical", "horizontal", "float", or "tab"
      size = 0.4,              -- Size of the REPL window (0.0 to 1.0)
      float_opts = {
        border = "rounded",    -- Border style for floating window
        width = 0.8,
        height = 0.8,
      },
    },
    completion = {
      enabled = true,          -- Enable keyword completion
    },
    lsp = {
      enabled = true,          -- Auto-start LSP when M2-language-server is found
      cmd = { "M2-language-server" }, -- Command to launch the server
      settings = {},           -- Server-specific settings passed via LSP
    },
    keymaps = {
      enabled = true,          -- Enable default keymaps
      prefix = "<localleader>",
    },
  },
}

Default keymaps are enabled in .m2 files:

When the LSP server is active, the following additional keymaps are set on attach:

For custom keymap configurations, the following <Plug> mappings are available:

• <Plug>(macaulay2-start) - Start REPL
• <Plug>(macaulay2-stop) - Stop REPL
• <Plug>(macaulay2-toggle) - Toggle REPL
• <Plug>(macaulay2-focus) - Focus REPL
• <Plug>(macaulay2-send-line) - Send current line
• <Plug>(macaulay2-send-selection) - Send visual selection
• <Plug>(macaulay2-send-buffer) - Send buffer
• <Plug>(macaulay2-help-cursor) - Help for word under cursor

All commands are available under the :M2 prefix:

MIT