This is the PureScript mode package for Emacs.
To report problems or suggestions, please open an issue in the issue tracker.
Below is a brief setup guide.
When Emacs is started up, it normally loads the
Emacs initialization file
usually called ~/.emacs, ~/.emacs.el, or ~/.emacs.d/init.el;
with ~ standing for for your home directory. This file should
contain all of your personal customisations written as a series of
Emacs Lisp commands. In the following sections, this file will simply
be referred to as the .emacs file.
GNU Emacs version 24 or later is officially supported. It may work with other Emacsen, but we don't have the resources to support other versions.
Users of MELPA can install purescript-mode
using M-x package-install. This is the most straightforward
and recommended installation method.
-
git clone https://github.com/purescript-emacs/purescript-mode.gitinto a suitable directory, e.g.~/lib/emacs/purescript-mode/where~stands for your home directory. -
Assuming you have unpacked the various purescript-mode modules (
purescript-mode.eland the rest) in the directory~/lib/emacs/purescript-mode/, you need generate the autoloads file (purescript-mode-autoloads.el) by either-
Invoking
make purescript-mode-autoloads.el, ormake all(use this to perform byte-compilation and Info manual generation) -
From inside Emacs,
M-x update-directory-autoloadsand answering the question for the folder with~/lib/emacs/purescript-mode/and the question for the output-file with~/lib/emacs/purescript-mode/purescript-mode-autoloads.el
and then adding the following command to your
.emacs:(add-to-list 'load-path "~/lib/emacs/purescript-mode/") (require 'purescript-mode-autoloads) (add-to-list 'Info-default-directory-list "~/lib/emacs/purescript-mode/")
-
-
After updating your purescript-mode working directory, you need to re-run
make allorM-x update-directory-autoloads.
For setup instructions, please consult the new integrated purescript-mode
Info
manual which can be accessed after installation via
M-x info-display-manual [RET] purescript-mode.
Please make sure your pull requests are at least properly rebased and up to date.