GitXplorerGitXplorer
s

emacs-sourcegraph-mode

public
4 stars
1 forks
0 issues

Commits

List of commits on branch master.
Unverified
2f9872d34e97ea44dab64b1b4b85f65059774975

Unescape forward slashes in output

ssamertm committed 10 years ago
Unverified
561ac1843842e3738f714045077792bc47422ec0

require shr

ssamertm committed 10 years ago
Unverified
03450fda768453274fcd964a1b256bb4c511ecc1

add screencast link

ssqs committed 10 years ago
Unverified
9e877ea635ed06f02dc5c369e1f8e66afc93c412

Merge pull request #1 from samertm/master

ssqs committed 10 years ago
Unverified
6112d2a76f7e0925a6ee1476ea2f53f94443fb4f

Additional error checking.

ssamertm committed 10 years ago
Unverified
72f56c66275926be562f25395de34c6306d32e12

install and images

ssqs committed 10 years ago

README

The README file for this repository.

emacs-sourcegraph-mode Build Status

WORK IN PROGRESS

Emacs mode for Sourcegraph, powered by srclib, for automatically configured, high-quality programming language support in Emacs. Currently provides:

  • documentation lookups
  • type information
  • find usages (across all open-source projects globally)

for any language srclib supports, currently:

  • Go
  • JavaScript (Node.js)

Check out the screenshots below, and the screencast on YouTube.

screenshot

screenshot

Installation

Put this in your .emacs.d, and then add a hook or just run sourcegraph-mode manually to enable it in a buffer.

Be sure you've installed the srclib toolchains for the programming language you're using.

Then, in any file (with sourcegraph-mode enabled), run sourcegraph-describe (or C-M-.) to see docs, type info, and examples.

Docs and type info are retrieved locally if possible; otherwise they are fetched from Sourcegraph.com. Examples are always fetched from Sourcegraph.com.

Security

Your local code is never uploaded to Sourcegraph, but the "definition paths" of things you look up are sent (to retrieve examples from the Sourcegraph API). The definition paths include the following information about the definition under your cursor (but do not include any source code):

  • repository URI (e.g., "github.com/user/repo")
  • package name (e.g., "foo" for an npm package named "foo")
  • scope path (e.g., MyClass.prototype.foo for a JavaScript foo method on MyClass)