Skip to content

Commit

Permalink
Tweak editor integration notes
Browse files Browse the repository at this point in the history
  • Loading branch information
@fredrikekre
fredrikekre committed Oct 18, 2024
1 parent de5291f commit 0855e5d
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ In addition to the CLI there is also the two function `Runic.format_file` and
#### Neovim
Runic can be used as a formatter in [Neovim](https://neovim.io/) using
[`conform.nvim`](https://github.com/stevearc/conform.nvim). Refer to the `conform.nvim`
[conform.nvim](https://github.com/stevearc/conform.nvim). Refer to the conform.nvim
repository for installation and setup instructions.
Runic is not (yet) available directly in `conform.nvim` so the following configuration needs
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.
Expand Down Expand Up @@ -144,6 +144,10 @@ enabled by adding the following to your configuration:
vim.o.formatexpr = "v:lua.require('conform').formatexpr()"
```
> [!IMPORTANT]
> Note that conform is a third party plugin. It works as advertised but use it at your own
> risk.
#### VS Code
Runic can be used as a formatter in [VS Code](https://code.visualstudio.com/) using the
Expand All @@ -165,7 +169,7 @@ Using the "Format Document" VS Code command will now format the file using Runic
the first time you execute the command you will be prompted to select a formatter since the
Julia language extension also comes with a formatter.
> [!WARNING]
> [!IMPORTANT]
> Note that Custom Local Formatters is a third party extension. It works as advertised but
> use it at your own risk.
Expand Down

2 comments on commit 0855e5d

@fredrikekre
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/117521

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.0 -m "<description of version>" 0855e5d0a610cc74987d9b4b29ffdb7fb70d03f2
git push origin v1.0.0

Please sign in to comment.