Skip to content

Commit 0017543

Browse files
committed
Add syntastic integration to the readme
1 parent b73c0ba commit 0017543

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,28 @@ If you don't have a preferred installation method check out
1010
![](https://raw.githubusercontent.com/keith/swift.vim/master/screenshots/screen.png)
1111
![](https://raw.githubusercontent.com/keith/swift.vim/master/screenshots/screen2.png)
1212

13+
## [Syntastic](https://github.com/scrooloose/syntastic/) Integration
1314

14-
### Development
15+
swift.vim can show errors inline from
16+
[swift package manager](https://github.com/apple/swift-package-manager/)
17+
or from [swiftlint](https://github.com/realm/SwiftLint) using
18+
[syntastic](https://github.com/scrooloose/syntastic/).
1519

16-
I plan to continue improving this plugin as I find more issues with
17-
it. If you find anything strange with highlighting or indention *please*
18-
[submit an issue](https://github.com/keith/swift.vim/issues/new).
20+
![](https://raw.githubusercontent.com/keith/swift.vim/master/screenshots/screen3.png)
21+
22+
### Usage
23+
24+
- Install [syntastic](https://github.com/scrooloose/syntastic/)
25+
26+
- swiftpm integration will be automatically enabled if you're running vim
27+
from a directory containing a `Package.swift` file.
28+
29+
- SwiftLint integration will be automatically enabled if you have
30+
SwiftLint installed and if you're running vim from a directory
31+
containing a `.swiftlint.yml` file.
32+
33+
- To enable both at once add this to your vimrc:
34+
35+
```vim
36+
let g:syntastic_swift_checkers = ['swiftpm', 'swiftlint']
37+
```

screenshots/screen3.png

137 KB
Loading

0 commit comments

Comments
 (0)