Skip to content

Latest commit

 

History

History
341 lines (265 loc) · 15.6 KB

README.md

File metadata and controls

341 lines (265 loc) · 15.6 KB
Raw
lean.nvim

lean.nvim

Neovim support for the Lean Theorem Prover

Lua Neovim MIT dotfiles using lean.nvim

demo.mp4

Installation

lean.nvim can be installed via your favorite plugin manager. Here's an example doing so with lazy.nvim:

{
  'Julian/lean.nvim',
  event = { 'BufReadPre *.lean', 'BufNewFile *.lean' },

  dependencies = {
    'neovim/nvim-lspconfig',
    'nvim-lua/plenary.nvim',
    -- you also will likely want nvim-cmp or some completion engine
  },

  -- see details below for full configuration options
  opts = {
    lsp = {},
    mappings = true,
  }
}

or with vim-plug:

Plug 'Julian/lean.nvim'
Plug 'neovim/nvim-lspconfig'
Plug 'nvim-lua/plenary.nvim'

" Optional Dependencies:

Plug 'hrsh7th/nvim-cmp'        " For LSP completion
Plug 'hrsh7th/cmp-nvim-lsp'
Plug 'hrsh7th/cmp-buffer'
Plug 'hrsh7th/vim-vsnip'       " For snippets
Plug 'andrewradev/switch.vim'  " For Lean switch support
Plug 'tomtom/tcomment_vim'     " For commenting motions
Plug 'nvim-telescope/telescope.nvim' " For Loogle search

lean.nvim supports the latest stable neovim release (currently 0.10.x) as well as the latest nightly. If you are on an earlier version of neovim, e.g. 0.9.5, you can have your plugin manager install the nvim-0.9 tag until you upgrade.

Features

  • Abbreviation (unicode character) insertion (in insert mode & the command window accessible via q/)

  • An infoview which can show persistent goal, term & tactic state, as well as interactive widget support (for most widgets renderable as text)

  • Hover (preview) commands:

    • :LeanGoal for showing goal state in a preview window

    • :LeanTermGoal for showing term-mode type information in a preview window

  • If satellite.nvim is present an extension is registered for showing progress information for the whole document. Otherwise, we show progress information in the sign column.

  • switch.vim base definitions for Lean

  • If telescope.nvim is present, a :Telescope loogle command is available as a frontend for the Loogle JSON API.

  • Simple snippets (in VSCode-compatible format, usable with e.g. vim-vsnip)

  • Lean library search path access via lean.current_search_path(), suitable for use e.g. with telescope.nvim for live grepping. See the wiki for a sample configuration.

Configuration & Usage

The short version -- if you followed the instructions above for lazy.nvim, you likely simply want opts = { mappings = true } to call lean.setup and enable its default key mappings.

This is all you need if you already have something registered to run on the LspAttach autocmd which defines any language server key mappings you like, e.g. if you use Neovim with any other language. In particular your LspAttach handler should likely bind things like vim.lsp.buf.code_action (AKA "the lightbulb") to ensure that you have easy access to code actions in Lean buffers. Lean (or really Std) uses code actions for replacing "Try this:" suggestions, which you will almost certainly want to be able to perform.

If you do not already have a preferred setup which includes LSP key mappings and (auto)completion, you may find the fuller example here in the wiki helpful.

If you are using another plugin manager (such as vim-plug), after following the installation instructions, add the below to ~/.config/nvim/plugin/lean.lua or an equivalent:

require('lean').setup{ mappings = true }

More detail on the full list of supported configuration options can be found below.

(If you find you can't modify your source files due to the nvim E21 error, this might be due to lean.nvim's effort prevent users from accidentally shooting themselves in the foot by modifying the Lean standard library. See the definition of nomodifiable below.)

Semantic Highlighting

Lean supports semantic highlighting, in which the Lean server itself will signal how to highlight terms and symbols within the editor using information available to it.

Note that even though neovim supports this highlighting, you still will want to map the semantic highlighting groups to your color scheme appropriately. For a sample setup, see the wiki.

Mappings

If you've set mappings = true in your configuration (or have called lean.use_suggested_mappings() explicitly), a number of keys will be mapped either within Lean source files or within Infoview windows:

In Lean Files

The key binding <LocalLeader> below refers to a configurable prefix key within neovim. You can check what this key is set to within neovim by running the command :echo maplocalleader. An error like E121: Undefined variable: maplocalleader indicates that it may not be set to any key. This can be configured by putting a line at the top of your ~/.config/nvim/init.lua of the form vim.g.maplocalleader = ' ' (in this example, mapping <LocalLeader> to hitting the space key twice).

Key Function
<LocalLeader>i toggle the infoview open or closed
<LocalLeader>p pause the current infoview
<LocalLeader>x place an infoview pin
<LocalLeader>c clear all current infoview pins
<LocalLeader>dx place an infoview diff pin
<LocalLeader>dc clear current infoview diff pin
<LocalLeader>dd toggle auto diff pin mode
<LocalLeader>dt toggle auto diff pin mode without clearing diff pin
<LocalLeader>v interactively configure infoview view options
<LocalLeader><Tab> jump into the infoview window associated with the current lean file
<LocalLeader>\\ show what abbreviation produces the symbol under the cursor
<LocalLeader>r Restart the Lean server for the current file.

Tip

See :help <LocalLeader> if you haven't previously interacted with the local leader key. Some nvim users remap this key to make it easier to reach, so you may want to consider what key that means for your own keyboard layout. My (Julian's) <Leader> is set to <Space>, and my <LocalLeader> to <Space><Space>, which may be a good choice for you if you have no other preference.

Tip

If you are also looking for a way to restart the Lean server, you can use the :LspRestart command, or map it to a key of your choice. It will restart the language servers for the current buffer/file, so this also applies to other language servers you may be using.

In Infoview Windows

Key Function
<CR> click a widget or interactive area of the infoview
K click a widget or interactive area of the infoview
<Tab> jump into a tooltip (from a widget click)
<Shift-Tab> jump out of a tooltip and back to its parent
<Esc> clear all open tooltips
J jump into a tooltip (from a widget click)
C clear all open tooltips
gd go-to-definition of what is under the cursor
gD go-to-declaration of what is under the cursor
gy go-to-type of what is under the cursor
<LocalLeader><Tab> jump to the lean file associated with the current infoview window

Full Configuration & Settings Information

  ---@module 'lean'
  ---@type lean.Config
  require('lean').setup {
    -- Enable suggested mappings?
    --
    -- false by default, true to enable
    mappings = false,

    -- Enable the Lean language server(s)?
    --
    -- false to disable, otherwise should be a table of options to pass to `leanls`
    --
    -- See https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#leanls for details.
    -- In particular ensure you have followed instructions setting up a callback
    -- for `LspAttach` which sets your key bindings!
    lsp = {
      init_options = {
        -- See Lean.Lsp.InitializationOptions for details and further options.

        -- Time (in milliseconds) which must pass since latest edit until elaboration begins.
        -- Lower values may make editing feel faster at the cost of higher CPU usage.
        -- Note that lean.nvim changes the Lean default for this value!
        editDelay = 0,

        -- Whether to signal that widgets are supported.
        hasWidgets = true,
      }
    },

    ft = {
      -- A list of patterns which will be used to protect any matching
      -- Lean file paths from being accidentally modified (by marking the
      -- buffer as `nomodifiable`).
      nomodifiable = {
          -- by default, this list includes the Lean standard libraries,
          -- as well as files within dependency directories (e.g. `_target`)
          -- Set this to an empty table to disable.
      }
    },

    -- Abbreviation support
    abbreviations = {
      -- Enable expanding of unicode abbreviations?
      enable = true,
      -- additional abbreviations:
      extra = {
        -- Add a \wknight abbreviation to insert ♘
        --
        -- Note that the backslash is implied, and that you of
        -- course may also use a snippet engine directly to do
        -- this if so desired.
        wknight = '♘',
      },
      -- Change if you don't like the backslash
      -- (comma is a popular choice on French keyboards)
      leader = '\\',
    },

    -- Infoview support
    infoview = {
      -- Automatically open an infoview on entering a Lean buffer?
      -- Should be a function that will be called anytime a new Lean file
      -- is opened. Return true to open an infoview, otherwise false.
      -- Setting this to `true` is the same as `function() return true end`,
      -- i.e. autoopen for any Lean file, or setting it to `false` is the
      -- same as `function() return false end`, i.e. never autoopen.
      autoopen = true,

      -- Set infoview windows' starting dimensions.
      -- Windows are opened horizontally or vertically depending on spacing.
      width = 50,
      height = 20,

      -- Put the infoview on the top or bottom when horizontal?
      -- top | bottom
      horizontal_position = "bottom",

      -- Always open the infoview window in a separate tabpage.
      -- Might be useful if you are using a screen reader and don't want too
      -- many dynamic updates in the terminal at the same time.
      -- Note that `height` and `width` will be ignored in this case.
      separate_tab = false,

      -- Show indicators for pin locations when entering an infoview window?
      -- always | never | auto (= only when there are multiple pins)
      indicators = "auto",
    },

    -- Progress bar support
    progress_bars = {
      -- Enable the progress bars?
      -- By default, this is `true` if satellite.nvim is not installed, otherwise
      -- it is turned off, as when satellite.nvim is present this information would
      -- be duplicated.
      enable = true,  -- see above for default
      -- What character should be used for the bars?
      character = '│',
      -- Use a different priority for the signs
      priority = 10,
    },

    -- Redirect Lean's stderr messages somehwere (to a buffer by default)
    stderr = {
      enable = true,
      -- height of the window
      height = 5,
      -- a callback which will be called with (multi-line) stderr output
      -- e.g., use:
      --   on_lines = function(lines) vim.notify(lines) end
      -- if you want to redirect stderr to `vim.notify`.
      -- The default implementation will redirect to a dedicated stderr
      -- window.
      on_lines = nil,
    },
  }

Other Useful Plugins

Particularly if you're also a VSCode user, there may be other plugins you're interested in. Below is a (hopelessly incomplete) list of a few:

Contributing

Contributions are most welcome. Feel free to send pull requests for anything you'd like to see, or open an issue if you'd like to discuss.

Running the tests can be done via just using the adjacent justfile:

  just

which will execute against a minimal init.lua isolated from your own setup.

After running the test suite once, you can save some time re-cloning dependencies by instead now running:

  just retest

You can also run single test files by running:

  just retest lua/tests/ft_spec.lua

Some linting and style checking is done via pre-commit, which once installed (via the linked instructions) is run via:

  just lint

or on each commit automatically if you have run pre-commit install in your repository checkout.

You can also use

  just nvim '{ mappings = true }'

to get a normal running neovim (again isolated from your own configuration), where the provided argument is a (Lua) table like one would pass to lean.setup. Any further arguments will be passed to nvim.