Skip to content
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

blog post: writing lsif exporter #282

Merged
merged 12 commits into from Oct 14, 2019

Conversation

@uwedeportivo
Copy link
Contributor

commented Sep 29, 2019

describes https://github.com/sourcegraph/lsif-jsonnet

needs editorial work :-)

also please check for conceptual blunders and correctness (@chrismwendt, @efritz, @unknwon)

thanks

@dadlerj

This comment has been minimized.

Copy link
Member

commented Sep 30, 2019

Awesome, thanks for contributing! And sorry, I'm totally out of the loop on this — what led you to write this? Did you discuss with @vanesa at all?

blogposts/lsif_exporter.md Outdated Show resolved Hide resolved
@efritz
efritz approved these changes Sep 30, 2019
Copy link

left a comment

This looks great! I like how you justified that syntactic analysis isn't enough and you need to resolve symbols via scope in order to get precise results.

I'm approving as there's nothing incorrect about LSIF and the general structure seems like a good walkthrough for how it was implemented. Should still have an editorial pass from someone closer to product/marketing/devrel.

Copy link
Member

left a comment

This is awesome!

@uwedeportivo

This comment has been minimized.

Copy link
Contributor Author

commented Sep 30, 2019

@dadlerj after doing https://github.com/sourcegraph/lsif-jsonnet @vanesa and @ryan-blunden said that it would be good blog fodder, so this weekend i wrote it down before i forget it all again :-)

Copy link
Contributor

left a comment

Nice walkthrough! 👏

blogposts/lsif_exporter.md Outdated Show resolved Hide resolved
blogposts/lsif_exporter.md Outdated Show resolved Hide resolved
uwedeportivo and others added 4 commits Oct 1, 2019
Co-Authored-By: Chris Wendt <chrismwendt@gmail.com>
@vanesa
vanesa approved these changes Oct 1, 2019
published: true
---

At a high level an LSIF indexer analyzes a collection of input source code files and produces an LSIF data file. This LSIF data file in turn is used by an editor or a Sourcegraph instance or some other developer tool to offer functionality like "Jump to Definition", "Show References", hover results with documentation and type information, semantic search, etc.

This comment has been minimized.

Copy link
@vanesa

vanesa Oct 1, 2019

Member

I think this needs a comma: At a high level, an... because it introduces the sentence.
Then further down: LSIF data file, in turn, is used

Copy link
Member

left a comment

Nice!

blogposts/lsif-indexer.md Outdated Show resolved Hide resolved
blogposts/lsif-indexer.md Outdated Show resolved Hide resolved
blogposts/lsif-indexer.md Show resolved Hide resolved
uwedeportivo and others added 3 commits Oct 1, 2019
Co-Authored-By: Nick Snyder <nick@sourcegraph.com>
@vanesa
vanesa approved these changes Oct 2, 2019
blogposts/lsif-indexer.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

left a comment

LGTM

@vanesa vanesa merged commit 21e27f5 into master Oct 14, 2019
3 of 5 checks passed
3 of 5 checks passed
Header rules No header rules processed
Details
Pages changed 2 new files uploaded
Details
Mixed content No mixed content detected
Details
Redirect rules 69 redirect rules processed
Details
deploy/netlify Deploy preview ready!
Details
@vanesa vanesa deleted the lsif-jsonnet branch Oct 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.