You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,9 @@ Async formatting and linting utility for neovim `0.10+`.
8
8
9
9
## Features
10
10
11
-
- Blazingly fast
12
-
- Async using coroutine and luv spawn
11
+
- Async and blazingly fast
13
12
- Builtin support for popular formatters and linters
14
-
-Easy configuration for custom tools
13
+
-Minimal API allowing for full customization
15
14
- Light-weight
16
15
17
16
## Usage
@@ -64,8 +63,12 @@ vim.g.guard_config = {
64
63
}
65
64
```
66
65
67
-
- Use `Guard fmt` to manually call format, when there is a visual selection only the selection is formatted. **NOTE**: Regional formatting just sends your selection to the formatter, if there's not enough context incoherent formatting might occur (e.g. indent being erased)
66
+
- Use `Guard fmt` to manually call format, when there is a visual selection only the selection is formatted. **NOTE**: Regional formatting is best-effort, expect inconsistencies.
68
67
-`enable-fmt`, `disable-fmt` turns auto formatting on and off for the current buffer.
68
+
- Use `Guard Lint` to lint manually.
69
+
-`enable-lint` and `disable-lint` controls auto linting for the current buffer.
70
+
71
+
## Examples
69
72
70
73
Format c files with clang-format and lint with clang-tidy:
71
74
@@ -95,9 +98,6 @@ Lint all your files with `codespell`
95
98
ft('*'):lint('codespell')
96
99
```
97
100
98
-
- Use `Guard Lint` to lint manually.
99
-
-`enable-lint` and `disable-lint` controls auto linting for the current buffer.
100
-
101
101
You can also easily create your own configuration that's not in `guard-collection`, see [CUSTOMIZE.md](./CUSTOMIZE.md).
102
102
103
103
For more niche use cases, [ADVANCED.md](./ADVANCED.md) demonstrates how to:
0 commit comments