[[file:img/crystal.png]]
Table of Contents :TOC_4_gh:noexport: :PROPERTIES: :ID: 8b291feb-383b-480e-9170-bf8aceced1c5 :END:
[[#description][Description]]
[[#install][Install]]
[[#key-bindings][Key bindings]]
Description :PROPERTIES: :ID: 17362c7c-e939-42e2-ba7f-da2dee893cdc :END: This layer provides support for the Crystal language with the following features:
Install :PROPERTIES: :ID: cf83b63e-c90d-4061-9fa7-06e3500dd43f :END:
** Pre-requires :PROPERTIES: :ID: 31dbc2e1-829e-41b6-9e0f-0a124476bb4d :END:
Because the spacemacs master and develop branches are not compatible, so this project has two branches:
develop -> =spacemacs= develop branch
Clone this repository into your ~/.emacs.d/private directory:
git clone git@github.com:brantou/spacemacs-crystal-layer.git ~/.emacs.d/private/crystal
=spacemacs= using develop branch
git clone -b develop git@github.com:brantou/spacemacs-crystal-layer.git ~/.emacs.d/private/crystal
To be able to connect to [[https://github.com/brantou/inf-crystal.el][inf-crystal]], you need to make sure that [[https://github.com/crystal-community/icr][icr]] is installed. Installation instructions can be found on the main page of [[https://github.com/crystal-community/icr#installation][icr]].
To be able to use [[https://github.com/veelenga/ameba.el][ameba.el]], you need to make sure that [[https://github.com/veelenga/ameba][ameba]] is installed. Installation instructions can be found on the main page of [[https://github.com/veelenga/ameba][ameba]].
** Layer :PROPERTIES: :ID: 22d52a72-aae2-44b9-87df-a81c67007fd5 :END: To use this configuration layer, add it to your =~/.spacemacs=. You will need to add =crystal= to the existing =dotspacemacs-configuration-layers= list in this file.
** Crystal commands: :PROPERTIES: :ID: af7863ff-8086-4ebd-b643-3423438871be :END:
| Key Binding | Description | |-------------+-----------------------------------------------------------| | ~SPC m e b~ | play-crystal submit buffer | | ~SPC m e r~ | play-crystal submit region | | ~SPC m e e~ | play-crystal show code in a browser | | ~SPC m e i~ | download play-crystal snippet | | ~SPC m g a~ | jump to matching spec file or back from spec to code file | | ~SPC m g g~ | jump to definition | | ~SPC m g G~ | jump to definition in other window | | ~SPC m t b~ | run =crystal spec= for the current buffer | | ~SPC m t p~ | run =crystal spec= for the current project | | ~SPC m u c~ | show context | | ~SPC m u e~ | show macro expansion | | ~SPC m u f~ | format the current buffer | | ~SPC m u i~ | show implementations for given call | | ~SPC m x x~ | run =crystal run= for the current file |
** inf-crystal :PROPERTIES: :ID: 531e86e4-88bb-4bbd-a3c7-94edddcbe944 :END:
Start a inferior crystal REPL process with ~SPC m '~ or ~SPC m s i~. Send code to inferior process commands:
| Key Binding | Description | |-------------+---------------------------------------------| | ~SPC m '~ | start inferior REPL process | | ~SPC m s b~ | send buffer | | ~SPC m s B~ | send buffer and switch to REPL | | ~SPC m s f~ | send function definition | | ~SPC m s F~ | send function definition and switch to REPL | | ~SPC m s i~ | start inferior REPL process | | ~SPC m s r~ | send region | | ~SPC m s R~ | send region and switch to REPL | | ~SPC m s s~ | switch to REPL |
** ameba :PROPERTIES: :ID: 414b5c9b-f3f7-4027-bea0-2cc774852b3b :END:
| Key Binding | Description | |-------------+------------------------------------------------| | ~SPC m a f~ | Runs Ameba on the current visited file | | ~SPC m a d~ | Prompts from a directory on which to run Ameba | | ~SPC m a p~ | Runs Ameba on the entire project |