Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A Scala source code browser
Branch: master
Pull request Compare This branch is 76 commits behind harrah:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
project
src/main
.gitignore
LICENSE
README

README

Browsable Scala source code in HTML with:
- syntax highlighting
- types/applied implicits in tooltips
- references/definition highlighted on mouseover
- links to definition

See http://harrah.github.com/browse/samples/index.html for samples.

Still in development.  Bugs are features and features are accidental.

To build with sbt (see http://code.google.com/p/simple-build-tool/wiki/Setup for setup instructions):

$ sbt "+update" "+package"

This produces a compiler plugin in target/.

Usage

Add the following options to your compile command for your project:
  -Xplugin:<path-to-sxr>/sxr-0.2.1.jar
  -P:sxr:base-directory:<src-dir>

If you are using sbt, make your project definition extend AutoCompilerPlugins, add sxr as a plugin, and configure the plugin:

class YourProject(info: ProjectInfo) extends DefaultProject(info) with AutoCompilerPlugins
{
  val sxr = compilerPlugin("org.scala-tools.sxr" %% "sxr" % "0.2.1")
  override def compileOptions =
    CompileOption("-P:sxr:base-directory:" + mainScalaSourcePath.asFile.getAbsolutePath) ::
    super.compileOptions.toList
}

You will get a directory <classes-output>.sxr that mirrors the directory structure of your sources relative
to the specified base directory with one HTML file for each source file.  You can make simple
changes to the syntax highlighting in the style.css file in the root output directory.  The linked.js
file implements the highlighting of refererences.
Something went wrong with that request. Please try again.