Emacs mode for Lean
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore chore(emacs): fix cask warnings Oct 21, 2016
LICENSE Initial commit Sep 18, 2017
README.md doc(README): document M-, Sep 6, 2018
company-lean.el chore(*): "Code:" markers Nov 2, 2017
helm-lean.el chore(*): "Code:" markers Nov 2, 2017
lean-debug.el fix(emacs/lean-debug): disable undo in lean-debug buffer Feb 21, 2017
lean-dev.el chore(*): fix compilation warnings Sep 19, 2017
lean-eri.el chore(eri): prefix with `lean-` Sep 18, 2017
lean-flycheck.el feat(lean-flycheck): highlight messages May 2, 2018
lean-hole.el fix(emacs/lean-hole): fix end position computation Jun 18, 2017
lean-info.el fix(lean-info): `lean-show-goal` no longer interrupts `lean-find-defi… Jun 4, 2018
lean-input.el fix(emacs/lean-input): remove overloading of \b abbreviation Feb 21, 2017
lean-leanpkg.el fix(lean-leanpkg): read-only text error when running leanpkg multiple… May 2, 2018
lean-message-boxes.el feat(lean-message-boxes): make `lean-message-boxes-enabledp` customiz… Sep 6, 2018
lean-mode.el feat(lean-server): support switching Lean versions on the fly via ela… May 2, 2018
lean-right-click.el feat(emacs): Add a right-click menu to the Emacs mode Jun 16, 2017
lean-server.el fix(lean-server): restore accidentally removed code May 2, 2018
lean-settings.el Default to executable name "lean" Jun 3, 2018
lean-syntax.el feat(lean-syntax): highlight the ubiquitous `$` Jul 12, 2018
lean-type.el fix(lean-info): `lean-show-goal` no longer interrupts `lean-find-defi… Jun 4, 2018
lean-util.el feat(lean-util): verify `lean-rootdir` value Apr 21, 2018

README.md

This is the Emacs mode for the Lean theorem prover.

Installation

lean-mode requires GNU Emacs 24.3 or newer. The recommended way to install it is via MELPA. If you have not already configured MELPA, put the following code in your Emacs init file (typically ~/.emacs.d/init.el):

(require 'package) ; You might already have this line
(add-to-list 'package-archives '("melpa" . "http://melpa.org/packages/"))
(package-initialize) ; You might already have this line

See also MELPA: Getting Started.

With MELPA configured, you can M-x package-install the packages lean-mode and company-lean. The latter package gives you auto completion and is strongly recommended. There is a third package, helm-lean, which provides a searchable list of declarations on C-c C-d using the Helm interface. helm-lean requires Emacs 24.4 or newer.

For company-lean, you should also bind a key to trigger completion, if you have not already done so:

;; Trigger completion on Shift-Space
(global-set-key (kbd "S-SPC") #'company-complete)

Updating

For updating the Lean MELPA packages, use package-list-packages. See the section "Updating Packages" on MELPA: Getting Started for details.

Trying It Out

If things are working correctly, you should see the word Lean in the Emacs mode line when you open a file with extension .lean. If you type

#check id

the word #check will be underlined, and hovering over it will show you the type of id. The mode line will show FlyC:0/1, indicating that there are no errors and one piece of information displayed.

Key Bindings and Commands

Key Function
M-. jump to definition in source file (lean-find-definition)
M-, jump back to position before M-. (xref-pop-marker-stack)
C-c C-k shows the keystroke needed to input the symbol under the cursor
C-c C-x execute lean in stand-alone mode (lean-std-exe)
C-c SPC run a command on the hole at point (lean-hole)
C-c C-d show a searchable list of definitions (helm-lean-definitions)
C-c C-g toggle showing current tactic proof goal (lean-toggle-show-goal)
C-c C-n toggle showing next error in dedicated buffer (lean-toggle-next-error)
C-c C-b toggle showing output in inline boxes (lean-message-boxes-toggle)
C-c C-r restart the lean server (lean-server-restart)
C-c C-s switch to a different Lean version via elan (lean-server-switch-version)
C-c ! n flycheck: go to next error
C-c ! p flycheck: go to previous error
C-c ! l flycheck: show list of errors

In the default configuration, the Flycheck annotation FlyC:n/n indicates the number of errors / responses from Lean; clicking on FlyC opens the Flycheck menu.

Message Boxes

To view the output of commands such as check and print in boxes in the buffer, enable the feature using C-c C-b. If you then type

#check id

a box appears after the line showing the type of id. Customize lean-message-boxes-enabled-captions to choose categories of boxes. In particular, add "trace output" to the list to see proof states and other traces in the buffer.

Known Issues and Possible Solutions

Unicode

If you experience a problem rendering unicode symbols on emacs, please download the following fonts and install them on your machine:

Then, have the following lines in your emacs setup to use DejaVu Sans Mono font:

(when (member "DejaVu Sans Mono" (font-family-list))
  (set-face-attribute 'default nil :font "DejaVu Sans Mono-11"))

You may also need to install the emacs-unicode-fonts package, after which you should add the following lines to your emacs setup:

(require 'unicode-fonts)
(unicode-fonts-setup)

Contributions

Contributions are welcome!

Building from Source

When working on lean-mode itself, it is much easier to just require the sources than repeatedly building the MELPA packages:

(add-to-load-path "~/path/to/lean-mode/")
(require 'company-lean)
(require 'helm-lean)

Make sure you have the packages' dependencies listed on MELPA installed -- the easiest way to do this may be to just install the official Lean MELPA packages and making sure the require commands above are execute before package-initialize.