Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kishikawakatsumi/SourceKitForSafari

SourceKit for Safari is a Safari extension for GitHub, that enables Xcode features like go to definition, find references, or documentation on hover.
https://github.com/kishikawakatsumi/SourceKitForSafari

chrome-extension safari-extension sourcekit-lsp

Last synced: 13 days ago
JSON representation

SourceKit for Safari is a Safari extension for GitHub, that enables Xcode features like go to definition, find references, or documentation on hover.

Awesome Lists containing this project

README 

        
# SourceKit for Safari





  




SourceKit for Safari is a browser extension for GitHub, that enables IDE features on your browser such as symbol navigator, go to definition and documentation on hover.






## Warning



This is really proof of concept code--functional proof of concept, but proof of concept nonetheless--and has not been thoroughly tested. Use at your own risk.



## Features



### Show Document Items



Bring up a list of document items, then select your desired document item to jump to the respective source code location.






### Quick Help popup



Hovering the mouse cursor over a symbol shows documentation.






### Jumps to Definition



If the text at the mouse cursor is a symbol defined in another file, turn it into a link navigating to the file.






### Find References






Resolve project-wide references for the symbol denoted by the given text document position.



### Highlights References



Highlights all references to the symbol scoped to this file.






## Installation






### Safari



* Download the latest `SourceKit for Safari.app` from [GitHub Releases](https://github.com/kishikawakatsumi/SourceKitForSafari/releases), run it once to install the extension.

* Open Safari - Preferences - Extension, make sure SourceKit for Safari is checked on the left panel.



### Chrome



* Download the latest `SourceKit for Safari.app` from [GitHub Releases](https://github.com/kishikawakatsumi/SourceKitForSafari/releases), run it once to install the helper app and the native messaging manifest.



* Install the extension from [Chrome Web Store](https://chrome.google.com/webstore/detail/sourcekit-for-chrome/ndfileljkldjnflefdckeiaedelndafe)



__(From version 0.6.0, Native Messaging is used to communicate with Language Protocol Server. Therefore, no longer needed to keep the host application running. The extension will automatically launch the helper application. To install the helper application, launch SourceKit for Safari.app once. Then the helper application will be installed.)__



~~(Unlike Safari Extension, Chrome Extension communicates with the language server through the host application. Therefore, the host application must be running while using the extension.)~~



## Getting Started



SourceKit for Safari depends on [SourceKit-LSP](https://github.com/apple/sourcekit-lsp). In order to use SourceKit for Safari, you need to install SourceKit-LSP and set the installation location.



If you have installed Xcode 11.4+ or the corresponding Command Line Tools package, the SourceKit-LSP server is included and can be run with `xcrun sourcekit-lsp`.



If you are using a toolchain from Swift.org, the SourceKit-LSP server is included and can be run with `xcrun --toolchain swift sourcekit-lsp`.



If your toolchain did not come with SourceKit-LSP, you should [build it from source](https://github.com/apple/sourcekit-lsp/blob/master/Documentation/Development.md).



SourceKit for Safari uses SourceKit-LSP that comes with Xcode 11.4 by default.



```

/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/sourcekit-lsp

```

If you want to use other SourceKit-LSP binary, click the toolbar icon and set its full path to the settings text field.






(for Chrome users)






Hover over symbols in the source code; then, the documentation for that symbol a popup will show or turn it link to the definition (The first may take some time).



## How it works



SourceKit for Safari will automatically clone a GitHub repository to your local filesystem (`~/Library/Group Containers/$(TeamIdentifierPrefix).com.kishikawakatsumi.SourceKitForSafari`) when you access there.



Then, when the source file is displayed on the browser, it automatically communicates with SourceKit-LSP to get information about the source code. Then show them with a popup on the browser.



SourceKit for Safari does not automatically update local repositories.



If the local repository is outdated, click the toolbar icon and press the Sync button to update it.



## Troubleshooting



### Chrome extension doesn't work



Make sure the host application (`SourceKit for Safari.app`) is running. Chrome extension requires the host application to communicate to the language server.



## Development



To use [Node Packaged Modules](https://www.npmjs.com/) in injected scripts, it requires to combine multiple modules and JavaScript files into one JavaScript file using [Browserify](http://browserify.org/).



To do that, run the following commands in `Terminal.app`. (Node.js development environment such as `npm` command must be set up in advance.)



```shell

cd ./SafariExtension/js

npm install

npm run build

```



Please make sure to perform clean build when you change injected JavaScript or CSS files. Otherwise, the changes will not install correctly.



## References



- [SourceKit-LSP](https://github.com/apple/sourcekit-lsp)

- [Safari App Extensions](https://developer.apple.com/documentation/safariservices/safari_app_extensions)

- [Language Server Protocol Specification](https://microsoft.github.io/language-server-protocol/specifications/specification-current/)