https://github.com/avdv/sbt-hyperlink
sbt plugin to hyperlink files in compiler messages
https://github.com/avdv/sbt-hyperlink
sbt sbt-plugin terminal
Last synced: 5 months ago
JSON representation
sbt plugin to hyperlink files in compiler messages
- Host: GitHub
- URL: https://github.com/avdv/sbt-hyperlink
- Owner: avdv
- License: mit
- Created: 2018-07-14T12:58:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-30T08:26:13.000Z (over 3 years ago)
- Last Synced: 2025-04-11T07:28:19.118Z (over 1 year ago)
- Topics: sbt, sbt-plugin, terminal
- Language: Scala
- Homepage:
- Size: 120 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SBT Hyperlink [![travis-badge][]][travis] [![bintray-badge][]][bintray]
[travis]: https://travis-ci.com/github/avdv/sbt-hyperlink
[travis-badge]: https://img.shields.io/travis/com/avdv/sbt-hyperlink.svg?label=travis&style=for-the-badge
[bintray]: https://bintray.com/cbley/sbt-plugins/sbt-hyperlink/_latestVersion
[bintray-badge]: https://img.shields.io/bintray/v/sbt/sbt-plugin-releases/sbt-hyperlink.svg?style=for-the-badge
A plugin to hyperlink files from error messages on the console
Before:
After:
A link is generated using ANSI escape sequences and the path is shortened. Clicking the link opens your editor at the referenced line and column.
## Usage
This plugin requires sbt 1.0.0+
Add this to your `~/.sbt/1.0/plugins/plugins.sbt`:
```scala
addSbtPlugin("de.cbley" % "sbt-hyperlink" % "0.0.1")
```
You need a terminal emulator which supports hyperlinks. Here is a
[comprehensive list](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#supporting-apps).
I am using [Termite](https://github.com/thestinger/termite). _(Note, you need to set
the `hyperlinks` option to `true` in your config which is by default `false`)_
By default, `file://` links will be generated for any absolute path to a file of the project in the format:
```
baseDirectory/path/file:line[:column]:
```
which matches paths in compiler error messages like:
```
src/main/scala/sbthyperlink/HyperlinkPlugin.scala:36:1: not found: value xxx
```
Clicking on these links opens the file using the default application associated with the file type.
Unfortunately, that method does not support specifying the line and column number to open. If you want to position the
cursor at the specified line (or column), have a look at [termlink](termlink/).
When you want to use the `termlink` helper, simply add this to `~/.sbt/1.0/global.sbt`:
```scala
hyperlinkAction := sbthyperlink.TermlinkAction
```
### Testing
Run `test` for regular unit tests.
Run `scripted` for [sbt script tests](http://www.scala-sbt.org/1.x/docs/Testing-sbt-plugins.html).