-
Notifications
You must be signed in to change notification settings - Fork 272
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add document that shows how to set up experimental background indexing #1416
Conversation
@swift-ci Please test |
6e963d2
to
841c953
Compare
@swift-ci Please test |
Documentation/Background Indexing.md
Outdated
$ git clone sourcekit-lsp | ||
$ swift package update | ||
$ swift build -c release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there meant to be a proper URL for the git clone
? Also would it be worth adding a cd
? Or is this more meant as pseudocode?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was meant to be proper code. Just … didn’t check it.
Documentation/Background Indexing.md
Outdated
|
||
Next, point your editor to use the just-built copy of SourceKit-LSP and enable background indexing by passing `--experimental-feature background-indexing` to sourcekit-lsp. In VS Code, this can be done by adding the following to your settings.json | ||
```json | ||
"swift.sourcekit-lsp.serverPath": "/path/to/sourcekit-lsp/.build/arm64-apple-macosx/release/sourcekit-lsp", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could use the .build/release
symlink to avoid including the target in the path here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea 👍🏽
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM other than Hamish's comments
841c953
to
d2c0e49
Compare
@swift-ci Please test |
@swift-ci Please test Windows |
d2c0e49
to
98149dd
Compare
@swift-ci Please test |
@swift-ci Please test Windows |
1 similar comment
@swift-ci Please test Windows |
No description provided.