Skip to content

Commit

Permalink
Merge pull request #4039 from kitbellew/3990
Browse files Browse the repository at this point in the history
Guide: update name of shared semanticdb library
  • Loading branch information
tgodzik authored Nov 18, 2024
2 parents d5df558 + ed70cf5 commit e297363
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions docs/semanticdb/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ features, check out [the specification](specification.html).

## Installation

This guide covers several non-standard command-line tools: `metac` and `metap`.
This guide covers several non-standard command-line tools:
[`metac`](#metac) and [`metap`](#metap).
First, install the `coursier` command-line tool by following the
[instructions here](https://get-coursier.io/docs/cli-installation). Next, use
coursier to install metac and metap.

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.scalameta/scalameta_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.scalameta/scalameta_2.12)

```
```shell
cs install metac metap
```

Expand Down Expand Up @@ -170,7 +171,7 @@ The `semanticdb-scalac` compiler plugin injects itself immediately after the
`typer` phase of the Scala compiler and then harvests and dumps semantic
information from Scalac in SemanticDB format.

```
```shell
scalac -Xplugin:path/to.jar -Yrangepos [<pluginOption> ...] [<scalacOption> ...] [<sourceFile> ...]
```

Expand Down Expand Up @@ -333,7 +334,9 @@ and produces `*.semanticdb` files instead of `*.class` files. It supports the
same command-line arguments as `scalac`, including the compiler plugin options
[described above](#scalac-compiler-plugin).

```
```shell
# downloads CLI tool based on org.scalameta.metac, version @VERSION@
cs install metac # if necessary
metac [<pluginOption> ...] [<scalacOption> ...] [<sourceFile> ...]
```

Expand Down Expand Up @@ -362,8 +365,8 @@ to
Using this library, one can model SemanticDB entities as Scala case classes and
serialize/deserialize them into bytes and streams.

```
libraryDependencies += "org.scalameta" %% "semanticdb" % "@VERSION@"
```scala
libraryDependencies += "org.scalameta" %% "semanticdb-shared" % "@VERSION@"
```

Caveats:
Expand All @@ -388,7 +391,9 @@ Metap is a command-line tool that takes a list of paths and then prettyprints
all .semanticdb files that it finds in these paths. Advanced options control
prettyprinting format.

```
```shell
# downloads CLI tool based on org.scalameta.semanticdb-metap, version @VERSION@
cs install metap # if necessary
metap [options] <classpath>
```

Expand Down

0 comments on commit e297363

Please sign in to comment.