This plugin extracts the structure of an SBT build in XML format. It is used in Intellij Scala plugin in order to import arbitrary SBT projects into IDEA.
sbt-structure-extractoris SBT plugin that actually extracts information from SBT build
Add to your
resolvers += Resolver.url("jb-bintray", url("http://dl.bintray.com/jetbrains/sbt-plugins"))(Resolver.ivyStylePatterns) libraryDependencies += "org.jetbrains" %% "sbt-structure-core" % "5.1.2" // or later version
Then run extractor or get XML of the structure any other way and deserialize it:
import org.jetbrains.sbt._ import org.jetbrains.sbt.XmlSerializer._ val structureXml: Elem = XML.load(...) val structure: Either[Throwable, StructureData] = structureXml.deserialize[StructureData]
Extractor is run in several steps:
- Configure it by defining
- Create necessary tasks by applying extractor's jar to your project
Here is an example of how to run extractor from SBT REPL:
set SettingKey[Option[File]]("sbt-structure-output-file") in Global := Some(file("structure.xml")) set SettingKey[String]("sbt-structure-options") in Global := "prettyPrint download" apply -cp <path-to-extractor-jar> org.jetbrains.sbt.CreateTasks */*:dump-structure
sbt-structure-options contains space-separated list of options.
sbt-structure-output-file points to a file where structure will be written; if
it is set to
None then structure will be dump into stdout.
Available options to set in
When this option is set extractor will run
updatecommand for each project in build and build complete repository of all transitive library dependencies
downloadoption to be set as well)
download+ downloading sources and javadocs for each transitive library dependency
This option tells extractor to download sources and javadocs for SBT itself and plugins.
This option will force extractor to prettify XML output. Useful for debug purposes.
- Testing against all supported SBT versions can be done with
- Testing against specific version of SBT, for example, 0.13.7:
^^ 0.13.7 test
- Selected tests can be run with
^ testOnly -- -ex "project name"
To publish artifacts bump version in
build.sbt and run in SBT REPL:
project extractor ^^ 0.12 publish ^^ 0.13 publish
Sbt 0.12 is built against Scala 2.9 and will not run on JVM 8. To test for 0.12, you need to run sbt with Java 7