@@ -5,7 +5,7 @@ title: Getting started
55
66By following the instructions on this page, you should be able to generate a
77[ SCIP] ( https://github.com/sourcegraph/scip ) index of your Java codebase using
8- Gradle, Maven, sbt, or Bazel. See
8+ Gradle, Maven, or Bazel. See
99[ Supported build tools] ( #supported-build-tools ) for an overview of other build
1010tools that we're planning to support in the future.
1111
@@ -136,16 +136,9 @@ If you're using Maven.
136136</dependency >
137137```
138138
139- If you're using sbt.
140-
141- ``` scala
142- scalaVersion := " @SCALA_VERSION@" // Only Scala 2.13 is supported.
143- libraryDependencies += " com.sourcegraph" %% " scip-java" % " @STABLE_VERSION@"
144- ```
145-
146139## Run ` scip-java index `
147140
148- > The ` index ` command is only supported for Gradle, Maven and sbt . See
141+ > The ` index ` command is only supported for Gradle and Maven . See
149142> [ Supported build tools] ( #supported-build-tools ) for more details about other
150143> build tools.
151144
@@ -156,18 +149,16 @@ This command should automatically infer the structure of your codebase and
156149configure your build tool to generate SCIP.
157150
158151``` sh
159- # At the root of a Gradle, Maven or sbt codebase.
152+ # At the root of a Gradle or Maven codebase.
160153$ scip-java index
161154...
162155info: /path/to/index.scip
163156```
164157
165- | Build tool | Default command |
166- | ---------- | ------------------------------------------------------------------------------- |
167- | Gradle | ` clean compileTestJava compileTestScala compileTestKotlin compileTestKotlinJvm ` |
168- | Maven | ` --batch-mode clean verify -DskipTests ` |
169- | sbt | ` sourcegraphEnable sourcegraphScip ` (via sbt-sourcegraph plugin) |
170- | Mill | ` io.kipp.mill.scip.Scip/generate ` (via mill-scip plugin) |
158+ | Build tool | Default command |
159+ | ---------- | ---------------------------------------------------------- |
160+ | Gradle | ` clean compileTestJava compileTestKotlin compileTestKotlinJvm ` |
161+ | Maven | ` --batch-mode clean verify -DskipTests ` |
171162
172163Customize the build command by passing additional arguments after
173164` scip-java index -- ` .
@@ -208,11 +199,10 @@ com.sourcegraph.scip_java.ScipJava.printHelp(Console.out)
208199
209200## Supported programming languages
210201
211- | Programming language | Gradle | Maven | sbt | Mill | Tracking issue |
212- | -------------------- | ------ | ----- | --- | ---- | ----------------------------------------------------------- |
213- | Java | ✅ | ✅ | ✅ | ✅ | |
214- | Scala | ✅ | ❌ | ✅ | ✅ | [ #302 ] ( https://github.com/sourcegraph/scip-java/issues/302 ) |
215- | Kotlin | ✅ | ❌ | n/a | n/a | |
202+ | Programming language | Gradle | Maven | Tracking issue |
203+ | -------------------- | ------ | ----- | -------------- |
204+ | Java | ✅ | ✅ | |
205+ | Kotlin | ✅ | ❌ | |
216206
217207### Java
218208
@@ -239,26 +229,11 @@ For Java 17 and newer versions, the following JVM options are required:
239229--add-exports jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
240230```
241231
242- ### Scala
243-
244- Scala version support should always match the Scala versions that are supported
245- by [ Metals] ( https://scalameta.org/metals ) , the Scala language server.
246-
247- | Scala version | Goto definition | Find references | Hover |
248- | ------------- | --------------- | --------------- | ----- |
249- | Scala 2.11.x | ❌ | ❌ | ❌ |
250- | Scala 2.12.x | ❌ | ❌ | ❌ |
251- | Scala 2.13.x | ✅ | ✅ | ✅ |
252- | Scala 3.x | ✅ | ✅ | ❌ |
253-
254- > Scala.js and Scala Native have equal support as Scala on the JVM.
255-
256232### Kotlin
257233
258- The Kotlin support in scip-java is less mature compared to the Java and Scala
259- support. Don't hesitate to report issues at
260- https://github.com/sourcegraph/scip-java if you encounter issues using the
261- Kotlin support.
234+ The Kotlin support in scip-java is less mature compared to the Java support.
235+ Don't hesitate to report issues at https://github.com/sourcegraph/scip-java if
236+ you encounter issues using the Kotlin support.
262237
263238## Supported build tools
264239
@@ -271,15 +246,13 @@ tools may require [manual configuration](manual-configuration.md).
271246Please open an issue if your build tool is not listed in the table below. Feel
272247free to subscribe to the tracking issues to receive updates on your build tool.
273248
274- | Build tool | Java | Scala | Kotlin | Tracking issue |
275- | ---------- | ---- | ----- | ------ | -------------------------------------------------------------------------------- |
276- | Maven | ✅ | ❌ | ❌ | |
277- | Gradle | ✅ | ✅ | ✅ | |
278- | sbt | ✅ | ✅ | n/a | |
279- | Ant | ❌ | ❌ | ❌ | [ sourcegraph/scip-java #305 ] ( https://github.com/sourcegraph/scip-java/issues/305 ) |
280- | Bazel | ✅ | ✅ | ❌ | |
281- | Buck | ❌ | ❌ | ❌ | [ sourcegraph/scip-java #99 ] ( https://github.com/sourcegraph/scip-java/issues/99 ) |
282- | Mill | ✅ | ✅ | ❌ |
249+ | Build tool | Java | Kotlin | Tracking issue |
250+ | ---------- | ---- | ------ | -------------------------------------------------------------------------------- |
251+ | Maven | ✅ | ❌ | |
252+ | Gradle | ✅ | ✅ | |
253+ | Ant | ❌ | ❌ | [ sourcegraph/scip-java #305 ] ( https://github.com/sourcegraph/scip-java/issues/305 ) |
254+ | Bazel | ✅ | ❌ | |
255+ | Buck | ❌ | ❌ | [ sourcegraph/scip-java #99 ] ( https://github.com/sourcegraph/scip-java/issues/99 ) |
283256
284257** ✅** : automatic indexing is fully supported. Please report a bug if the
285258` scip-java index ` command does not work on your codebase.
@@ -310,7 +283,6 @@ The following Gradle integrations are not yet supported:
310283| ----------- | --------- | -------------------------------------------------------------------------------- |
311284| Android | ❌ | [ sourcegraph/scip-java #177 ] ( https://github.com/sourcegraph/scip-java/issues/177 ) |
312285| Kotlin | ✅ | |
313- | Scala | ✅ | |
314286
315287### Maven
316288
@@ -322,29 +294,8 @@ The following Maven integrations are not yet supported:
322294
323295| Integration | Supported | Tracking issue |
324296| ------------------- | --------- | -------------------------------------------------------------------------------- |
325- | scala-maven-plugin | ❌ | [ sourcegraph/scip-java #301 ] ( https://github.com/sourcegraph/scip-java/issues/301 ) |
326- | scalor-maven-plugin | ❌ | [ sourcegraph/scip-java #301 ] ( https://github.com/sourcegraph/scip-java/issues/301 ) |
327297| kotlin-maven-plugin | ❌ | [ sourcegraph/scip-java #304 ] ( https://github.com/sourcegraph/scip-java/issues/304 ) |
328298
329- ### sbt
330-
331- The ` scip-java index ` build should be able to automatically index most sbt
332- projects, with the following caveats:
333-
334- | Integration | Supported | Recommendation |
335- | ------------- | --------- | ----------------------- |
336- | sbt <v0.13.17 | ❌ | Upgrade to sbt v0.13.17 |
337-
338- ### Mill
339-
340- The ` scip-java index ` build should be able to automatically index most Mill
341- projects, with the following caveats:
342-
343- | Integration | Supported | Recommendation |
344- | ------------- | ------------------- | ------------------------------------------- |
345- | Mill <v0.10.0 | ❌ | Upgrade to Mill >= v0.10.0 |
346- | Mill <v0.10.6 | Only supports Scala | Upgrade to Mill >= v0.10.6 for Java support |
347-
348299### Bazel
349300
350301There are two approaches to index Bazel/Java codebases: automatic and manual.
0 commit comments