Experimental SCIP indexer for Ruby.
If you have any questions, bug reports, feature requests or feedback, please file an issue.
scip-ruby piggybacks on top of the Sorbet type-checker. If you use Sorbet in your project, follow the instructions below.
Projects which do not use Sorbet are not supported.
Supported platforms:
- x86_64 Linux
- x86_64 macOS
- arm64 macOS (via Rosetta)
You can download a release binary and run it directly, similar to invoking Sorbet.
OS="$(uname -s | tr '[:upper:]' '[:lower:]')" \
RELEASE_URL="https://github.com/sourcegraph/scip-ruby/releases/latest/download" \
curl -L "$RELEASE_URL/scip-ruby-x86_64-$OS" -o scip-ruby && chmod +x scip-ruby
chmod +x scip-ruby
# If using in CI with 'set -e', make sure to wrap the
# scip-ruby invocation in 'set +e' followed by 'set -e'
# so that indexing failures are non-blocking.
./scip-ruby --index-file index.scip --gem-metadata "my-gem-name@vM.N.P"
The generated index can be uploaded to a Sourcegraph instance using the Sourcegraph CLI.
See the Contributing docs.