doomemacs/modules/lang/common-lisp/README.org

:lang common-lisp

• Description
  • Maintainers
  • Module flags
  • Packages
  • Hacks
  • Changelog
• Installation
• Usage
  • Sly
  • org-mode
  • formatter
• Configuration
• Troubleshooting
• Frequently asked questions
• Appendix

Description   unfold

This module provides support for Common Lisp and the doom-package:Sly development environment. Common Lisp is not a single language but a specification, with many competing compiler implementations. By default, Steel Bank Common Lisp (SBCL) is assumed to be installed, but this can be configured.

Common Lisp benefits from a mature specification and rich standard library. Thanks to its powerful REPL and debugger, it boasts an "interactive programming" style often unseen in other languages. Compiled Common Lisp programs are trusted to run unmodified for a long time.

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

This module has no flags.

Packages

• doom-package:sly
• doom-package:sly-macrostep
• doom-package:sly-repl-ansi-color

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires SBCL.

TODO Usage

󱌣 This module's usage documentation is incomplete. Complete it?

This module does not integrate with doom-module::tools lsp. Sly (and SLIME before it) is considered the defacto development environment for Common Lisp and provides much of what is normally expected of an LSP, plus tight integration with the REPL and Emacs.

Sly

Using this module is mostly a matter of using Sly. Please consider reading through the Sly Tour.

A Sly session will be started when you open a .lisp file. Use <localleader> ' to switch to the REPL minibuffer.

org-mode

This module also enables the evaluation of lisp source blocks in Org Mode. However, you will need a running Sly session for this to work. M-x sly starts such a session if you didn't have one open already.

formatter

By enabling doom-module::editor format, fn:apheleia-indent-lisp-buffer will be used to format the current buffer.

Enable doom-module::editor format +onsave to format the buffer on save.

TODO Configuration

󱌣 This module's configuration documentation is incomplete. Complete it?

If you don't want Sly to use SBCL, you can configure the variable inferior-lisp-program to some other binary on your PATH.

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?