ANN: Scala X-Ray (sxr)

Whoah... this is nifty stuff!  When are we going to get this as part of the Scala-Maven plugin?

On Thu, Apr 16, 2009 at 6:24 AM, Mark Harrah <harrah [at] bu [dot] edu> wrote:

I would like to announce an experimental new project, sxr: Scala X-Ray (thanks
for the name Nathan!):

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

Check out the samples: sources for sbt, sxr, and the Scala library and
compiler:
http://harrah.github.com/browse/samples/index.html

sxr is a compiler plugin.  The source code is available here (BSD licensed):
http://github.com/harrah/browse/tree/master

There is much room for improvement, so please feel free to contribute patches!

Thanks,
Mark

--
Lift, the simply functional web framework http://liftweb.net
Beginning Scala http://www.apress.com/book/view/1430219890
Follow me: http://twitter.com/dpp
Git some: http://github.com/dpp

On Thu, Apr 16, 2009 at 2:24 PM, Mark Harrah wrote:
> I would like to announce an experimental new project, sxr: Scala X-Ray (thanks
> for the name Nathan!):

Very nice!

Cheers,

Miles

Yeah, awesome. That's immediately useful and a great starting point
for further improvements.

Thanks

This is all cool and stuff, but can it fly? ;)

On Thu, Apr 16, 2009 at 3:42 PM, Johannes Rudolph <johannes [dot] rudolph [at] googlemail [dot] com> wrote:

Yeah, awesome. That's immediately useful and a great starting point
for further improvements.

Thanks

--
Johannes

-----------------------------------------------
Johannes Rudolph
http://virtual-void.net


On Thu, Apr 16, 2009 at 3:26 PM, David Pollak
<feeder [dot] of [dot] the [dot] bears [at] gmail [dot] com> wrote:
> Whoah... this is nifty stuff!  When are we going to get this as part of the
> Scala-Maven plugin?
>
> On Thu, Apr 16, 2009 at 6:24 AM, Mark Harrah <harrah [at] bu [dot] edu> wrote:
>>
>> I would like to announce an experimental new project, sxr: Scala X-Ray
>> (thanks
>> for the name Nathan!):
>>
>> Browsable Scala source code in HTML with:
>> - syntax highlighting
>> - types/applied implicits in tooltips
>> - references/definition of symbols/types highlighted on mouseover
>> - links to definition of symbols/types
>>
>> Check out the samples: sources for sbt, sxr, and the Scala library and
>> compiler:
>> http://harrah.github.com/browse/samples/index.html
>>
>> sxr is a compiler plugin.  The source code is available here (BSD
>> licensed):
>> http://github.com/harrah/browse/tree/master
>>
>> There is much room for improvement, so please feel free to contribute
>> patches!
>>
>> Thanks,
>> Mark
>
>
>
> --
> Lift, the simply functional web framework http://liftweb.net
> Beginning Scala http://www.apress.com/book/view/1430219890
> Follow me: http://twitter.com/dpp
> Git some: http://github.com/dpp
>

--
Viktor Klang
Senior Systems Analyst

There might be some issues because it is a compiler plugin, but I'm happy to
assist anyone more familiar with maven plugins.

Thanks,
Mark

On Thursday 16 April 2009, David Pollak wrote:
> Whoah... this is nifty stuff! When are we going to get this as part of the
> Scala-Maven plugin?
>
> On Thu, Apr 16, 2009 at 6:24 AM, Mark Harrah wrote:
> > I would like to announce an experimental new project, sxr: Scala X-Ray
> > (thanks
> > for the name Nathan!):
> >
> > Browsable Scala source code in HTML with:
> > - syntax highlighting
> > - types/applied implicits in tooltips
> > - references/definition of symbols/types highlighted on mouseover
> > - links to definition of symbols/types
> >
> > Check out the samples: sources for sbt, sxr, and the Scala library and
> > compiler:
> > http://harrah.github.com/browse/samples/index.html
> >
> > sxr is a compiler plugin. The source code is available here (BSD
> > licensed):
> > http://github.com/harrah/browse/tree/master
> >
> > There is much room for improvement, so please feel free to contribute
> > patches!
> >
> > Thanks,
> > Mark

Congrats. Neat !

On Thu, Apr 16, 2009 at 4:24 PM, Mark Harrah <harrah [at] bu [dot] edu> wrote:

I would like to announce an experimental new project, sxr: Scala X-Ray (thanks
for the name Nathan!):

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

Check out the samples: sources for sbt, sxr, and the Scala library and
compiler:
http://harrah.github.com/browse/samples/index.html

sxr is a compiler plugin.  The source code is available here (BSD licensed):
http://github.com/harrah/browse/tree/master

There is much room for improvement, so please feel free to contribute patches!

Thanks,
Mark

As a first step towards Maven integration, I have configured the
maven-scala-plugin to compile the main source files with the X-Ray plugin
enabled during the 'site' phase. This generates at least some of the output
to target/classes.sxr. However, I get a "OutOfMemoryError: Java heap space"
from the Scala compiler logged to the console, despite a generous -Xmx
setting. Oddly, this doesn't fail the build.

The snippet from the POM file is below.

Remaining steps: figure out OOM Error (it may be specific to this project);
create maven plugin to simplify usage and to contribute the reports to the
maven site. See https://sorcerer.dev.java.net/ for an example.

Mark -- I would love to see the which implicit values are being passed to
implicit parameter lists.

-jason

org.scala-tools
maven-scala-plugin

${scala.version}

-Xmx900M

false
src/main/scala

scala-compile
compile

add-source
compile

scala-xray
site

compile

true

-P:sxr:base-directory:src/main/scala

org.scala-tools.sxr
sxr_2.7.5
0.2.1

Mark Harrah wrote:
>
> There might be some issues because it is a compiler plugin, but I'm happy
> to
> assist anyone more familiar with maven plugins.
>
> Thanks,
> Mark
>
> On Thursday 16 April 2009, David Pollak wrote:
>> Whoah... this is nifty stuff! When are we going to get this as part of
>> the
>> Scala-Maven plugin?
>