Split Go bindings into separate module (#364)

Author: jupblb

.github/workflows/nix-checks.yaml

@@ -21,3 +21,17 @@ jobs:
       - uses: DeterminateSystems/nix-installer-action@v21
       - uses: DeterminateSystems/magic-nix-cache-action@v13
       - run: nix build .#checks.x86_64-linux.${{ matrix.check }}
+
+  packages:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        package:
+          - scip
+          - speedtest
+          - proto-generate
+    steps:
+      - uses: actions/checkout@v6
+      - uses: DeterminateSystems/nix-installer-action@v21
+      - uses: DeterminateSystems/magic-nix-cache-action@v13
+      - run: nix build .#${{ matrix.package }}

.gitignore

@@ -28,3 +28,5 @@ dist-newstyle/
 
 # Nix output
 /result
+
+vendor/

bindings/go/scip/go.mod

@@ -0,0 +1,50 @@
+module github.com/sourcegraph/scip/bindings/go/scip
+
+go 1.25.0
+
+require (
+	github.com/cockroachdb/errors v1.12.0
+	github.com/fatih/color v1.18.0
+	github.com/hexops/gotextdiff v1.0.3
+	github.com/sourcegraph/beaut v0.0.0-20240611013027-627e4c25335a
+	golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa
+	google.golang.org/protobuf v1.36.6
+)
+
+require (
+	github.com/google/go-cmp v0.7.0
+	github.com/google/gofuzz v1.2.0
+	github.com/hexops/autogold/v2 v2.3.1
+	github.com/jedib0t/go-pretty/v6 v6.6.3
+	github.com/sourcegraph/conc v0.3.0
+	github.com/stretchr/testify v1.11.1
+	pgregory.net/rapid v1.1.0
+)
+
+require (
+	github.com/cockroachdb/logtags v0.0.0-20230118201751-21c54148d20b // indirect
+	github.com/cockroachdb/redact v1.1.5 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/getsentry/sentry-go v0.27.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/hexops/valast v1.5.0 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/mattn/go-colorable v0.1.14 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-runewidth v0.0.15 // indirect
+	github.com/nightlyone/lockfile v1.0.0 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rivo/uniseg v0.2.0 // indirect
+	github.com/rogpeppe/go-internal v1.14.1 // indirect
+	go.uber.org/atomic v1.7.0 // indirect
+	go.uber.org/multierr v1.9.0 // indirect
+	golang.org/x/mod v0.33.0 // indirect
+	golang.org/x/sync v0.19.0 // indirect
+	golang.org/x/sys v0.41.0 // indirect
+	golang.org/x/text v0.34.0 // indirect
+	golang.org/x/tools v0.42.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	mvdan.cc/gofumpt v0.9.2 // indirect
+)

bindings/go/scip/go.sum

@@ -27,13 +27,15 @@
     pname = "scip-bindings-go";
     inherit version;
     src = ./.;
-    vendorHash = "sha256-JuGh7/CnpCWABK6WYE+Mo7P8X0glFrFa9ve9eO//1v8=";
+    modRoot = "./bindings/go/scip";
+    vendorHash = "sha256-pCYfH/CvzwCh13twl1Xq2Ma+jUNgFFrdGpQH+i3y6u8=";
+    env.GOWORK = "off";
     buildTags = [ "asserts" ];
     subPackages = [
-      "bindings/go/scip"
-      "bindings/go/scip/internal"
-      "bindings/go/scip/memtest"
-      "bindings/go/scip/testutil"
+      "."
+      "internal"
+      "memtest"
+      "testutil"
     ];
     preCheck = ''
       export SCIP_SAMPLE_INDEXES_DIR=${sampleIndexes}
@@ -66,8 +68,9 @@
       inherit version;
       src = ./.;
       modRoot = "./reprolang";
-      vendorHash = "sha256-H6RLXmQsufwKtI5BujsUEibVuCMpILqtX3W0Wg9m3T8=";
+      vendorHash = "sha256-tOTxbCRFjCJYfCrICY74mrh9Tfqzx/rG77MiZXrRRok=";
       proxyVendor = true;
+      env.GOWORK = "off";
       buildInputs = [ pkgs.tree-sitter ];
       subPackages = [
         "grammar"

checks.nix

@@ -37,8 +37,10 @@ fi
 } >&2
 
 TAG="v$NEW_VERSION"
+BINDINGS_TAG="bindings/go/scip/$TAG"
 git tag "$TAG"
-git push origin "$TAG"
+git tag "$BINDINGS_TAG"
+git push origin "$TAG" "$BINDINGS_TAG"
 
 {
   echo "See the [CHANGELOG](https://github.com/sourcegraph/scip/blob/main/CHANGELOG.md) to see what's new in scip v$NEW_VERSION."

dev/publish-release.sh

@@ -26,10 +26,12 @@
             inherit version;
 
             src = ./.;
-            vendorHash = "sha256-ywSR9yRysnm2E6kI8UJS6XcpuqKJF8wJpHcYS7TGmjI=";
+            vendorHash = "sha256-ag3r00bqP1x+HX6o8W99RTmk/RARRCJIDloIYO6syOw=";
+            proxyVendor = true;
 
             subPackages = [ "cmd/scip" ];
 
+            env.GOWORK = "off";
             ldflags = [ "-X main.Reproducible=true" ];
 
             meta = {
@@ -45,15 +47,19 @@
             inherit version;
 
             src = ./.;
-            vendorHash = "sha256-ywSR9yRysnm2E6kI8UJS6XcpuqKJF8wJpHcYS7TGmjI=";
+            modRoot = "./bindings/go/scip";
+            vendorHash = "sha256-pCYfH/CvzwCh13twl1Xq2Ma+jUNgFFrdGpQH+i3y6u8=";
+            env.GOWORK = "off";
 
-            subPackages = [ "bindings/go/scip/speedtest" ];
+            subPackages = [ "speedtest" ];
 
             nativeBuildInputs = [ pkgs.makeWrapper ];
             postFixup = ''
               wrapProgram $out/bin/speedtest \
                 --set SCIP_SAMPLE_INDEXES_DIR ${sampleIndexes}
             '';
+
+            meta.mainProgram = "speedtest";
           };
 
           proto-generate =

flake.nix

@@ -1,73 +1,63 @@
 module github.com/sourcegraph/scip
 
-go 1.24.1
+go 1.25.0
+
+replace github.com/sourcegraph/scip/bindings/go/scip => ./bindings/go/scip
 
 require (
 	github.com/bytedance/sonic v1.14.1
-	github.com/cockroachdb/errors v1.8.9
-	github.com/fatih/color v1.15.0
-	github.com/google/go-cmp v0.6.0
-	github.com/google/gofuzz v1.2.0
-	github.com/hexops/autogold/v2 v2.2.1
-	github.com/hexops/gotextdiff v1.0.3
+	github.com/cockroachdb/errors v1.12.0
 	github.com/hhatto/gocloc v0.4.2
-	github.com/jedib0t/go-pretty/v6 v6.6.3
 	github.com/k0kubun/pp/v3 v3.1.0
 	github.com/klauspost/compress v1.18.0
 	github.com/montanaflynn/stats v0.7.1
-	github.com/sourcegraph/beaut v0.0.0-20240611013027-627e4c25335a
-	github.com/sourcegraph/conc v0.3.0
-	github.com/stretchr/testify v1.10.0
+	github.com/sourcegraph/scip/bindings/go/scip v0.0.0-00010101000000-000000000000
+	github.com/stretchr/testify v1.11.1
 	github.com/urfave/cli/v2 v2.25.7
-	golang.org/x/exp v0.0.0-20241217172543-b2144cdd0a67
+	golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa
 	google.golang.org/protobuf v1.36.6
-	pgregory.net/rapid v1.1.0
 	zombiezen.com/go/sqlite v1.0.0
 )
 
 require (
 	github.com/bytedance/gopkg v0.1.3 // indirect
 	github.com/bytedance/sonic/loader v0.3.0 // indirect
 	github.com/cloudwego/base64x v0.1.6 // indirect
-	github.com/cockroachdb/logtags v0.0.0-20211118104740-dabe8e521a4f // indirect
-	github.com/cockroachdb/redact v1.1.3 // indirect
+	github.com/cockroachdb/logtags v0.0.0-20230118201751-21c54148d20b // indirect
+	github.com/cockroachdb/redact v1.1.5 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.6 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dustin/go-humanize v1.0.1 // indirect
-	github.com/getsentry/sentry-go v0.12.0 // indirect
+	github.com/fatih/color v1.18.0 // indirect
+	github.com/getsentry/sentry-go v0.27.0 // indirect
 	github.com/go-enry/go-enry/v2 v2.7.2 // indirect
 	github.com/go-enry/go-oniguruma v1.2.1 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/uuid v1.6.0 // indirect
-	github.com/hexops/valast v1.4.4 // indirect
+	github.com/hexops/autogold/v2 v2.3.1 // indirect
+	github.com/hexops/gotextdiff v1.0.3 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.9 // indirect
 	github.com/kr/pretty v0.3.1 // indirect
 	github.com/kr/text v0.2.0 // indirect
-	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-colorable v0.1.14 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/mattn/go-runewidth v0.0.15 // indirect
 	github.com/ncruces/go-strftime v0.1.9 // indirect
-	github.com/nightlyone/lockfile v1.0.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
-	github.com/rivo/uniseg v0.2.0 // indirect
-	github.com/rogpeppe/go-internal v1.13.1 // indirect
+	github.com/rogpeppe/go-internal v1.14.1 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/sourcegraph/beaut v0.0.0-20240611013027-627e4c25335a // indirect
 	github.com/spf13/afero v1.10.0 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
-	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/arch v0.0.0-20210923205945-b76863e36670 // indirect
-	golang.org/x/mod v0.28.0 // indirect
-	golang.org/x/sync v0.17.0 // indirect
-	golang.org/x/sys v0.36.0 // indirect
-	golang.org/x/text v0.29.0 // indirect
-	golang.org/x/tools v0.37.0 // indirect
+	golang.org/x/sys v0.41.0 // indirect
+	golang.org/x/text v0.34.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	modernc.org/libc v1.41.0 // indirect
 	modernc.org/mathutil v1.6.0 // indirect
 	modernc.org/memory v1.7.2 // indirect
 	modernc.org/sqlite v1.27.0 // indirect
-	mvdan.cc/gofumpt v0.5.0 // indirect
 )