Skip to content

Commit 17e1ee3

Browse files
docs: Add brief docs for developing scip-ruby.
1 parent 7fff89f commit 17e1ee3

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
# Sorbet
66

7+
NOTE: This code is in Sourcegraph's fork of Sorbet, modified to add support
8+
for emitting SCIP indexes. See scip-ruby.md for details on running tests etc.
9+
The original README follows below.
10+
11+
---
12+
713
This repository contains Sorbet, a fast, powerful type checker designed for Ruby.
814
It aims to be easy to add to existing codebases with gradual types, and fast to
915
respond with errors and suggestions.

scip-ruby.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# scip-ruby
2+
3+
## Building
4+
5+
```
6+
./bazel build //main:scip-ruby --config=dbg
7+
```
8+
9+
For more information about configurations, see the main [README](./README.md).
10+
11+
## IDE Integration
12+
13+
Generate `compile_commands.json` as per the main [README](./README.md),
14+
and point your editor to it.
15+
16+
## Generating a SCIP index
17+
18+
NOTE: The binary will be somewhere under `bazel-out` depending on the exact config.
19+
20+
```
21+
scip-ruby myfile.rb --index-file index.scip
22+
```
23+
24+
## Running SCIP tests
25+
26+
```
27+
./bazel test //test/scip --config=dbg
28+
```
29+
30+
Updating snapshots
31+
32+
```
33+
./bazel test //test/scip:update --config=dbg
34+
```

0 commit comments

Comments
 (0)