Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nathankot/company-sourcekit
Completion for Swift projects via SourceKit with the help of SourceKitten
https://github.com/nathankot/company-sourcekit
autocomplete company-mode emacs sourcekit sourcekitten swift
Last synced: 6 days ago
JSON representation
Completion for Swift projects via SourceKit with the help of SourceKitten
- Host: GitHub
- URL: https://github.com/nathankot/company-sourcekit
- Owner: nathankot
- Created: 2015-10-01T20:55:17.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-26T20:15:04.000Z (about 2 years ago)
- Last Synced: 2024-12-26T09:06:40.880Z (14 days ago)
- Topics: autocomplete, company-mode, emacs, sourcekit, sourcekitten, swift
- Language: Emacs Lisp
- Homepage:
- Size: 437 KB
- Stars: 207
- Watchers: 11
- Forks: 16
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# company-sourcekit
[](http://melpa.milkbox.net/#/company)
_[company-mode][company] completion for Swift projects via SourceKit with the help of [SourceKittenDaemon][sourcekittendaemon]._
## Limitations
* Only works when there is a `*.xcodeproj` up the directory tree.
* OSX-only, since this communicates with SourceKit which only runs on OSX (AFAIK)
* You need to have `curl` on your machine
## Installation
First install [SourceKittenDaemon][sourcekittendaemon]. Make sure that it's in
the `exec-path` of your Emacs.
And then you can install `company-sourcekit` in the following ways:
### MELPA
```sh
M-x package-install company-sourcekit
```
### Source
Make sure this repository is in your `load-path`, and then:
```elisp
(require 'company-sourcekit)
(add-to-list 'company-backends 'company-sourcekit)
```
## Configuration
* _`company-sourcekit-use-yasnippet`_ - Use yasnippet for completion expansion. By default this is enabled if yasnippet is detected.
* _`company-sourcekit-verbose`_ - Log company-related messages to `*messages*` with verbosity
* _`sourcekit-available-ports`_ - A list of ports that `sourcekittendaemon` is allowed to listen on.
* _`sourcekit-sourcekittendaemon-executable`_ - Location of the `sourcekittendaemon` executable
* _`sourcekit-curl-executable`_ - Location of the `curl` executable
* _`sourcekit-verbose`_ - Log sourcekittendaemon-related messages to `*messages*` with verbosity
## How it works
* company-sourcekit communicates with sourcekittendaemon via HTTP.
* Which in turn communicates with SourceKit using the [sourcekitten][sourcekitten] framework.
* sourcekittendaemon will read your `.xcodeproj` file and determine the best configuration options to pass to sourcekit.
## Credits
* Big thanks to [@terhechte][terhechte] for spearheading [SourceKittenDaemon][sourcekittendaemon]!
* [@jpsim][jpsim] for researching Sourcekit and making [sourcekitten][sourcekitten]. Without which this would not be possible!
[jpsim]: https://github.com/jpsim
[terhechte]: https://github.com/terhechte
[company]: https://github.com/company-mode/company-mode
[sourcekittendaemon]: https://github.com/terhechte/SourceKittenDaemon
[sourcekitten]: https://github.com/jpsim/SourceKitten
## Contributing
Is most welcome. Please use a feature branch and format your code with
`indent-region` d(^.^)b