Skip to content

Commit 9c3c50c

Browse files
olafurpgolafurpg
committed
Reorganize docs on the getting started page
1 parent f2ce8b5 commit 9c3c50c

File tree

1 file changed

+73
-26
lines changed

1 file changed

+73
-26
lines changed

‎docs/getting-started.md‎

Lines changed: 73 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -132,24 +132,47 @@ options.
132132
com.sourcegraph.lsif_java.LsifJava.printHelp(Console.out)
133133
```
134134

135-
## Supported Java versions
135+
## Supported programming languages
136+
137+
| Programming language | Gradle | Maven | sbt | Tracking issue |
138+
| -------------------- | ------ | ----- | --- | --------------------------------------------------------------------------------------------------------------------------- |
139+
| Java | ✅ | ✅ | ✅ | |
140+
| Scala | ❌ | ❌ | ✅ | [Maven](https://github.com/sourcegraph/lsif-java/issues/301), [Gradle](https://github.com/sourcegraph/lsif-java/issues/302) |
141+
| Kotlin | ❌ | ❌ | ❌ | [#302](https://github.com/sourcegraph/lsif-java/issues/302) |
142+
143+
### Java
136144

137145
The `lsif-java` indexer is implemented as a Java compiler plugin that runs as
138146
part of your regular compilation in the build tool. By using Java compiler APIs,
139147
`lsif-java` is able to generate accurate indexing information for a broad range
140148
of Java versions.
141149

142-
| Language version | Support |
143-
| ---------------- | ------------------------------ |
144-
| Java 7 | ❌ |
145-
| Java 8 | ✅ |
146-
| Java 11 | ✅ |
147-
| Java 12 | Not tested in CI, but may work |
148-
| Java 13 | Not tested in CI, but may work |
149-
| Java 14 | Not tested in CI, but may work |
150-
| Java 15 | ✅ |
151-
| Java 16 | Not tested in CI, but may work |
152-
| Java 17 | Not tested in CI, but may work |
150+
| Java version | Support |
151+
| ------------ | ------------------------------ |
152+
| Java 7 | ❌ |
153+
| Java 8 | ✅ |
154+
| Java 11 | ✅ |
155+
| Java 12 | Not tested in CI, but may work |
156+
| Java 13 | Not tested in CI, but may work |
157+
| Java 14 | Not tested in CI, but may work |
158+
| Java 15 | ✅ |
159+
| Java 16 | Not tested in CI, but may work |
160+
| Java 17 | Not tested in CI, but may work |
161+
162+
### Scala
163+
164+
Scala version support should always match the Scala versions that are supported
165+
by [Metals](https://scalameta.org/metals), the Scala language server.
166+
167+
| Scala version | Goto definition | Find references | Hover |
168+
| ------------- | --------------- | --------------- | ----- |
169+
| Scala 2.10.x | ❌ | ❌ | ❌ |
170+
| Scala 2.11.x | ✅ | ✅ | ✅ |
171+
| Scala 2.12.x | ✅ | ✅ | ✅ |
172+
| Scala 2.13.x | ✅ | ✅ | ✅ |
173+
| Scala 3.x | ✅ | ✅ | ❌ |
174+
175+
> Scala.js and Scala Native have equal support as Scala on the JVM.
153176
154177
## Supported build tools
155178

@@ -162,14 +185,15 @@ tools may require [manual configuration](manual-configuration.md).
162185
Please open an issue if your build tool is not listed in the table below. Feel
163186
free to subscribe to the tracking issues to receive updates on your build tool.
164187

165-
| Build tool | Single repo navigation | Cross-repo navigation | Tracking issue |
166-
| ----------------------- | ---------------------- | --------------------- | -------------------------------------------------------------------------------- |
167-
| Maven | ✅ | ✅ | |
168-
| Gradle v4.0+ | ✅ | ✅ | |
169-
| Gradle v2.2.1+ | ✅ | ❌ | [sourcegraph/lsif-java#167](https://github.com/sourcegraph/lsif-java/issues/167) |
170-
| Bazel | ❌ | ❌ | [sourcegraph/lsif-java#88](https://github.com/sourcegraph/lsif-java/issues/88) |
171-
| Buck | ❌ | ❌ | [sourcegraph/lsif-java#99](https://github.com/sourcegraph/lsif-java/issues/99) |
172-
| sbt (v0.13.17, and v1+) | ✅ | ✅ | |
188+
| Build tool | Java | Scala | Kotlin | Tracking issue |
189+
| ---------- | ---- | ----- | ------ | -------------------------------------------------------------------------------- |
190+
| Maven | ✅ | ❌ | ❌ | |
191+
| Gradle | ✅ | ❌ | ❌ | |
192+
| sbt | ✅ | ✅ | ❌ | |
193+
| Ant | ❌ | ❌ | ❌ | [sourcegraph/lsif-java#305](https://github.com/sourcegraph/lsif-java/issues/305) |
194+
| Bazel | ❌ | ❌ | ❌ | [sourcegraph/lsif-java#88](https://github.com/sourcegraph/lsif-java/issues/88) |
195+
| Buck | ❌ | ❌ | ❌ | [sourcegraph/lsif-java#99](https://github.com/sourcegraph/lsif-java/issues/99) |
196+
| Mill | ❌ | ❌ | ❌ | [sourcegraph/lsif-java#306](https://github.com/sourcegraph/lsif-java/issues/306) |
173197

174198
**✅**: automatic indexing is fully supported. Please report a bug if the
175199
`lsif-java index` command does not work on your codebase.
@@ -183,10 +207,33 @@ free to subscribe to the tracking issues to receive updates on your build tool.
183207
See the [manual configuration](manual-configuration.md) guide for instructions
184208
on how to configure lsif-java to work with any build tool.
185209

186-
## Supported programming languages
210+
### Gradle
187211

188-
| Programming language | Gradle | Maven | sbt | Tracking issue |
189-
| -------------------- | ------ | ----- | --- | --------------------------------------------------------------------------------------------------------------------------- |
190-
| Java | ✅ | ✅ | ✅ | |
191-
| Scala | ❌ | ❌ | ✅ | [Maven](https://github.com/sourcegraph/lsif-java/issues/301), [Gradle](https://github.com/sourcegraph/lsif-java/issues/302) |
192-
| Kotlin | ❌ | ❌ | ❌ | [#302](https://github.com/sourcegraph/lsif-java/issues/302) |
212+
The `lsif-java index` build should be able to automatically index most Gradle
213+
projects. However, the following Gradle integrations are not yet supported:
214+
215+
| Integration | Supported | Tracking issue |
216+
| ----------- | --------- | -------------------------------------------------------------------------------- |
217+
| Android | ❌ | [sourcegraph/lsif-java#304](https://github.com/sourcegraph/lsif-java/issues/304) |
218+
| Kotlin | ❌ | [sourcegraph/lsif-java#177](https://github.com/sourcegraph/lsif-java/issues/177) |
219+
| Scala | ❌ | [sourcegraph/lsif-java#302](https://github.com/sourcegraph/lsif-java/issues/302) |
220+
221+
### Maven
222+
223+
The `lsif-java index` build should be able to automatically index most Maven
224+
projects. However, the following Maven integrations are not yet supported:
225+
226+
| Integration | Supported | Tracking issue |
227+
| ------------------- | --------- | -------------------------------------------------------------------------------- |
228+
| scala-maven-plugin | ❌ | [sourcegraph/lsif-java#301](https://github.com/sourcegraph/lsif-java/issues/301) |
229+
| scalor-maven-plugin | ❌ | [sourcegraph/lsif-java#301](https://github.com/sourcegraph/lsif-java/issues/301) |
230+
| kotlin-maven-plugin | ❌ | [sourcegraph/lsif-java#304](https://github.com/sourcegraph/lsif-java/issues/304) |
231+
232+
### sbt
233+
234+
The `lsif-java index` build should be able to automatically index most Maven
235+
projects, with the following caveats:
236+
237+
| Integration | Supported | Recommendation |
238+
| ------------- | --------- | ----------------------- |
239+
| sbt <v0.13.17 | ❌ | Upgrade to sbt v0.13.17 |

0 commit comments

Comments
 (0)