swiftpm: improve README

This commit is contained in:
Marc Cornellà 2019-04-08 23:22:15 +02:00 committed by GitHub
parent 651856d4a3
commit 2ec868dde4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,7 +2,7 @@
## Description ## Description
This plugin provides a few utilities that make you faster on your daily work with the [Swift Package Manager](https://github.com/apple/swift-package-manager). This plugin provides a few utilities that make you faster on your daily work with the [Swift Package Manager](https://github.com/apple/swift-package-manager), as well as autocompletion for Swift 5.0.
To start using it, add the `swiftpm` plugin to your `plugins` array in `~/.zshrc`: To start using it, add the `swiftpm` plugin to your `plugins` array in `~/.zshrc`:
@ -20,22 +20,3 @@ plugins=(... swiftpm)
| `spx` | Generates an Xcode project | `swift package generate-xcodeproj` | | `spx` | Generates an Xcode project | `swift package generate-xcodeproj` |
| `sps` | Print the resolved dependency graph | `swift package show-dependencies` | | `sps` | Print the resolved dependency graph | `swift package show-dependencies` |
| `spd` | Print parsed Package.swift as JSON | `swift package dump-package` | | `spd` | Print parsed Package.swift as JSON | `swift package dump-package` |
## Autocompletion
The `_swift` file enables autocompletion for Swift Package Manager. Current version supports Swift 5.0
### Updating the autocompletion for new version of Swift
To update autocompletion to the Swift version present on your system:
```
swift package completion-tool generate-zsh-script > ~/.oh-my-zsh/plugins/swiftpm/_swift
```
### Known issues
If `swiftpm` is not added to your zsh plugins list, autocompletion will still be triggered but will result in errors:
```
_values:compvalues:10: not enough arguments
```