Browse Source

Add Helix configuration to the editor section (#147)

pull/149/head
Camilo De La Torre 5 months ago committed by GitHub
parent
commit
c2658e3a80
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 25
      README.md

25
README.md

@ -213,7 +213,7 @@ repository for installation and setup instructions. @@ -213,7 +213,7 @@ repository for installation and setup instructions.
Runic is not (yet) available directly in conform so the following configuration needs
to be passed to the setup function. This assumes Runic is installed in the `@runic` shared
project as suggested in the [Installation](#installation) section above. Adjust the
`--project` flag if you installed Runic elsewhere.
`--project` flag if you installed Runic somewhere else.
```lua
require("conform").setup({
@ -246,7 +246,9 @@ Runic can be used as a formatter in [VS Code](https://code.visualstudio.com/) us @@ -246,7 +246,9 @@ Runic can be used as a formatter in [VS Code](https://code.visualstudio.com/) us
extension [Custom Local Formatters](https://marketplace.visualstudio.com/items?itemName=jkillian.custom-local-formatters&ssr=false#overview).
After installing the extension you can configure Runic as a local formatter by adding the
following entry to your `settings.json`:
following entry to your `settings.json`. This assumes Runic is installed in the `@runic`
shared project as suggested in the [Installation](#installation) section above. Adjust the
`--project` flag if you installed Runic somewhere else.
```json
"customLocalFormatters.formatters": [
@ -275,13 +277,30 @@ Refer to the apheleia repository for installation and setup instruction. @@ -275,13 +277,30 @@ Refer to the apheleia repository for installation and setup instruction.
Runic is not (yet) available directly in apheleia so the
following configuration needs to be added to your `.emacs`.
This assumes that Runic is installed in the `@runic` shared project as suggested in the [Installation](#installation) section above.
This assumes Runic is installed in the `@runic` shared project as suggested in the
[Installation](#installation) section above. Adjust the `--project` flag if you installed
Runic somewhere else.
```
(push `(runic . ("julia" "--project=@runic" "--startup-file=no" "-e" "using Runic; exit(Runic.main(ARGS))" "--")) apheleia-formatters)
(push '(julia-mode . runic) apheleia-mode-alist)
```
#### Helix
Runic can be used as a formatter in [Helix](https://helix-editor.com/). Configure Helix's
`:format` command to use Runic for julia code by adding the following to the
`languages.toml` configuration file. This assumes Runic is installed in the `@runic` shared
project as suggested in the [Installation](#installation) section above. Adjust the
`--project` flag if you installed Runic somewhere else.
```
[[language]]
name = "julia"
auto-format = false
formatter = { command = "julia" , args = ["--project=@runic", "--startup-file=no", "-e", "using Runic; exit(Runic.main(ARGS))"] }
```
### Git integration
The [`git-runic`](https://github.com/fredrikekre/Runic.jl/blob/master/bin/git-runic)

Loading…
Cancel
Save