This repository has been archived by the owner on May 8, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Re-organize since there is now a Swift language server
- Loading branch information
Showing
34 changed files
with
118 additions
and
1,092 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,67 @@ | ||
# Swift for Visual Studio Code | ||
|
||
This extension adds rich language support for the Swift language to VS Code. These features are | ||
provided by the Swift framework itself through | ||
[SourceKit](https://github.com/apple/swift/tree/master/tools/SourceKit) | ||
and [SourceKitten](https://github.com/jpsim/SourceKitten). | ||
This extension adds rich language support for the Swift language to VS Code. These features are provided by the Swift framework itself through [SourceKit](https://github.com/apple/swift/tree/master/tools/SourceKit) and [SourceKitten](https://github.com/jpsim/SourceKitten). | ||
|
||
![https://github.com/RLovelett/vscode-swift/blob/master/vscode-swift-language/images/vscode-swift-documentation.gif?raw=true](https://github.com/RLovelett/vscode-swift/blob/master/vscode-swift-language/images/vscode-swift-documentation.gif?raw=true) | ||
Currently the extension provides rudimentary support for: | ||
|
||
## Development setup | ||
- run npm install inside the `vscode-swift-language` and `vscode-swift-language-server` folders | ||
- open VS Code on `vscode-swift-language` and `vscode-swift-language-server` | ||
- Completion lists | ||
- Symbol resolution | ||
|
||
## Developing the server | ||
- open VS Code on `vscode-swift-language-server` | ||
- run `npm run compile` or `npm run watch` to build the server and copy it into the `vscode-swift-language` folder | ||
- to debug press F5 which attaches a debugger to the server | ||
Future support for: | ||
|
||
## Developing the extension/client | ||
- open VS Code on `vscode-swift-language` | ||
- run F5 to build and debug the extension | ||
- Document Highlights: highlights all 'equal' symbols in a Swift document. | ||
- Hover: provides hover information for a symbol selected in a Swift document. | ||
- Signature Help: provides signature help for a symbol selected in a Swift document. | ||
- Find References: find all project-wide references for a symbol selected in a Swift document. | ||
- List Workspace Symbols: list all project-wide symbols. | ||
- CodeLens: compute CodeLens statistics for a given Swift document. | ||
- Rename: project-wide rename of a symbol. | ||
- Debugger | ||
- [Swift Package Manger](https://swift.org/package-manager/) | ||
|
||
## Features | ||
|
||
### Completion Lists | ||
|
||
Use completion lists to find out about available standard library types and function signatures. | ||
|
||
![Struct Def](http://i.giphy.com/26gJAJzxzZDsVEs24.gif) | ||
|
||
Do the same for your own custom types. Including documentation comments. | ||
|
||
![Struct Docs](http://i.giphy.com/l0HlzNmlfLl7fyc0g.gif) | ||
|
||
## Requirements | ||
|
||
This extension requires Swift to be installed on your system. More specifically it requires [SourceKit](https://github.com/apple/swift/tree/master/tools/SourceKit) and [SourceKitten](https://github.com/jpsim/SourceKitten) to be available as well. | ||
|
||
[Currently, SourceKit and by extension SourceKitten, do not compile on Linux.](https://github.com/jpsim/SourceKitten/pull/223) This limits the extension to only work on macOS. This is not expected to be the long-term solution. In fact running on Linux was the whole reason why I started this extension. | ||
|
||
The extension expects [`v0.13.0` of SourceKitten](https://github.com/jpsim/SourceKitten/releases/tag/0.13.0) to be installed at `/usr/local/bin/sourcekitten`. | ||
|
||
With [homebrew]() this can easily be achieved by running `brew install sourcekitten`. | ||
|
||
## Extension Settings | ||
|
||
* `sourcekitten` path | ||
|
||
## Known Issues | ||
|
||
- Does not run on Linux | ||
|
||
## Release Notes | ||
For detailed release notes see: [Releases](https://github.com/RLovelett/vscode-swift/releases) | ||
|
||
### 0.0.5 | ||
|
||
* Completions use snippet formatting for placeholders, allows the cursor to tab between placeholders | ||
* Completions index against all swift files in the workspace | ||
* Bug fixes | ||
|
||
### 0.0.3 | ||
|
||
* Allow configuring sourceKitten install location | ||
|
||
### 0.0.2 | ||
|
||
Preview release of the extension |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.