Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move third-party editor integration notice to "toplevel" #100

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Move third-party editor integration notice to "toplevel" #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 11 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,17 @@ In addition to the CLI there is also the two function `Runic.format_file` and

### Editor integration

Most code editors have code formatting capabilities and many can be configured to use Runic.
Example configuration for some editors are given in the following sections.

- [Neovim](#neovim)
- [VS Code](#vs-code)
- [Emacs](#emacs)

> [!IMPORTANT]
> Note that these configurations depend on third party plugins. They works as advertised but
> use it at your own risk.

#### Neovim

Runic can be used as a formatter in [Neovim](https://neovim.io/) using
Expand Down Expand Up @@ -150,10 +161,6 @@ 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 @@ -175,10 +182,6 @@ 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.

> [!IMPORTANT]
> Note that Custom Local Formatters is a third party extension. It works as advertised but
> use it at your own risk.

#### Emacs

Runic can be used as a formatter in [Emacs](https://www.gnu.org/software/emacs/) using [apheleia](https://github.com/radian-software/apheleia).
Expand All @@ -193,11 +196,6 @@ This assumes that Runic is installed in the `@runic` shared project as suggested
(push '(julia-mode . runic) apheleia-mode-alist)
```

> [!IMPORTANT]
> Note that apheleia is a third party extension. It works as advertised but
> use it at your own risk.


## Checking formatting

Runic has a check-mode that verifies whether files are correctly formatted or not. This mode
Expand Down