History

Henrik Lissner 037b018cdd feat: add .doommodule files These optional dotfiles indicate the root of a module or module group (:lang), and will later contain module metadata. They will also serve as an alternative to packages.el and doctor.el, and will aide the parts of the v3.0 module API concerned with resolving the current module from a path (`doom-module-from-path`), which currently rely too heavily on parsing path strings. For now, however, they're simply placeholders.		2024-09-14 20:47:39 -04:00
..
.doommodule	feat: add .doommodule files	2024-09-14 20:47:39 -04:00
config.el	fix(nim): swap nimfmt with nimpretty	2024-03-11 00:53:43 -04:00
doctor.el	fix(nim): swap nimfmt with nimpretty	2024-03-11 00:53:43 -04:00
packages.el	bump: :lang nim	2024-03-11 00:53:43 -04:00
README.org	fix(nim): swap nimfmt with nimpretty	2024-03-11 00:53:43 -04:00

README.org

:lang nim

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
- Nim
- Formatter
Usage
Configuration
Troubleshooting
Frequently asked questions
Appendix

Description unfold

This module adds Nim support to Doom Emacs.

Code completion (doom-package:nimsuggest + doom-package:company)
Syntax checking (doom-package:nimsuggest + doom-package:flycheck)
Org babel support (doom-package:ob-nim)

Maintainers

This module needs a maintainer. Become a maintainer?

Module flags

This module has no flags.

Packages

doom-package:flycheck-nim if doom-module::checkers syntax
doom-package:nim-mode

Hacks

doom-package:nimsuggest was modified to strip invalid characters from its temp file paths (which would break nimsuggest on Windows systems).
doom-package:nim-mode was modified to fail gracefully if nimsuggest (the executable) isn't available.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires:

nim, for building & evaluation.
nimsuggest, for code completion, syntax checking, and jump-to-definition functionality.

Nim

choosenim is an installer and version manager for the Nim programming language. You can install the latest stable release of Nim by running the following in your terminal and following the onscreen instructions:

curl https://nim-lang.org/choosenim/init.sh -sSf | sh

Alternatively, nim is usually available through your OS's package manager:

MacOS: $ brew install nim
Arch Linux: $ pacman --needed --noconfirm -S nim nimble
openSUSE: $ zypper install nim

Formatter

Formatting is handled using the doom-module::editor format module via nimpretty (included with Nim).

TODO Usage

󱌣 This module has no usage documentation yet. Write some?

TODO Configuration

󱌣 This module has no configuration documentation yet. Write some?

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?