doomemacs/modules/lang/crystal/README.org

:lang crystal

• Description
  • Maintainers
  • Module flags
  • Packages
  • Hacks
  • Changelog
• Installation
  • Crystal
  • ICR (REPL)
• Usage
  • formatter
• Configuration
• Troubleshooting
• Frequently asked questions
• Appendix

Description   unfold

This modules adds crystal support.

• Syntax-checking (flycheck)
• REPL (inf-crystal)

Maintainers

This module has no dedicated maintainers.

Module flags

This module has no flags.

Packages

• doom-package:crystal-mode
• doom-package:inf-crystal

• if doom-module::checkers syntax

  • doom-package:flycheck-ameba
  • doom-package:flycheck-crystal

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:

• The crystal compiler
• ICR, for the REPL

Crystal

• MacOS: $ brew install crystal
• Arch Linux: $ pacman -S crystal shards

ICR (REPL)

Installation instructions.

TODO Usage

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

formatter

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

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

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?