JetBrains/sbt-structure

Dernière activité source enregistrée: 14 avril 2026 à 10:34

Catalogue SkillsMP mis à jour: 9 novembre 2026 à 14:22

skills collectés: 1

Étoiles GitHub: 76
Forks GitHub: 32

Installer avec un assistant IA

Copiez ce prompt dans l’assistant IA que vous utilisez.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/JetBrains/sbt-structure.

README du dépôt

Fichier source du README : README.md

Lire le README source

Afficher le README complet

[![official JetBrains project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub) [![sbt-structure-core Scala version support](https://index.scala-lang.org/jetbrains/sbt-structure/sbt-structure-extractor/latest.svg)](https://index.scala-lang.org/jetbrains/sbt-structure/sbt-structure-extractor) ![Build Status](https://github.com/jetbrains/sbt-structure/actions/workflows/build.yml/badge.svg) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/aUKpZzeHCK) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JetBrains/intellij-scala) # sbt-structure 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. ## Problems? Please report any issues related to sbt-structure in IntelliJ on the [IntelliJ Scala YouTrack project]( https://youtrack.jetbrains.com/issues/SCL). ## Project structure - `extractor` is an sbt plugin that actually extracts information from the sbt build. - `core` is a shared library that is used by both `extractor` and the Intellij Scala plugin. **_Note:_** `extractor` is packaged as a fat jar, by compiling the sources of `core` and including the output `.class` files in the resulting jar. This packaging structure is implicitly expected by the Intellij Scala plugin, due to how the jar is injected in sbt for extracting the information of a sbt build. The shared sources are contained in the `shared` directory and linked in the `extractor` and `core` modules, in order to create a source dependency that can be recognized by IDEA. ## Usage ### Core Add to your `build.sbt` ```scala libraryDependencies += "org.jetbrains.scala" %% "sbt-structure-core" % "<version>" ``` Then run extractor or get XML of the structure any other way and deserialize it: ```scala import org.jetbrains.sbt._ import org.jetbrains.sbt.XmlSerializer._ val structureXml: Elem = XML.load(...) val structure: Either[Throwable, StructureData] = structureXml.deserialize[StructureData] ``` ### Extractor Extractor can be run as a regular sbt plugin, or loaded into the build during an sbt shell session. #### As an sbt plugin The quickest way to try out the extractor is by adding it to your build in `project/plugins.sbt` as an sbt plugin: ```scala addSbtPlugin("org.jetbrains.scala" % "sbt-structure-extractor" % "<version>", "1.3") ``` Then from the sbt shell run: */*:dumpStructure This will output the xml directly to the shell. To write the xml to a file, run: set org.jetbrains.sbt.StructureKeys.sbtStructureOptions in Global := "prettyPrint download" */*:dumpStructureTo structure.xml The deprecated `dumpStructure` task uses the settings described below. Prefer `dumpStructureTo`, which takes the output file as an argument instead. #### Sideloading This is the way Intellij-Scala imports projects by default. The preferred side-loading flow is: - Configure it by defining the `sbtStructureOptions` setting in `Global` scope. - Create necessary tasks by applying the extractor jar to your project. - Run the `dumpStructureTo` task with the target XML file. Here is an example of the preferred approach from sbt REPL: ```scala set SettingKey[String]("sbtStructureOptions") in Global := "prettyPrint download" apply -cp <path-to-extractor-jar> org.jetbrains.sbt.CreateTasks */*:dumpStructureTo "structure.xml" ``` The deprecated `dumpStructure` task is still available for compatibility with old side-loaded import clients. It reads the output file from `sbtStructureOutputFile` and writes to stdout if that setting is `None`: ```scala set SettingKey[Option[File]]("sbtStructureOutputFile") in Global := Some(file("structure.xml")) set SettingKey[String]("sbtStructureOptions") in Global := "prettyPrint download" apply -cp <path-to-extractor-jar> org.jetbrains.sbt.CreateTasks dumpStructure ``` #### Settings `sbtStructureOptions` contains a space-separated list of options. `sbtStructureOutputFile` points to a file where the deprecated `dumpStructure` task writes the structure; if it is set to `None`, the structure is dumped to stdout. Available options to set in `sbtStructureOptions`: - `download` When this option is set extractor will run `update` command for each project in build and build complete repository of all transitive library dependencies - `resolveClassifiers` (requires `download` option to be set as well) Same as `download` + downloading sources and javadocs for each transitive library dependency - `resolveSbtClassifiers` This option tells extractor to download sources and javadocs for sbt itself and plugins. - `prettyPrint` This option will force extractor to prettify XML output. Useful for debug purposes. ## Development notes - The plugin is cross-built for sbt 0.13, 1.x and 2. - JDK 17 is required for building the plugin. The plugin is correctly compiled for JDK 8 compatibility. (see https://www.scala-sbt.org/1.x/docs/Cross-Build-Plugins.html) \ The project is not imported correctly in IntelliJ (some source folders are not detected, etc...) This is a known issue, see [correctly handle cross-projects ](https://youtrack.jetbrains.com/issue/SCL-12945) - Testing against all supported sbt versions can be done with `^ test` command - Testing against specific version of sbt, for example, 0.13.7: `^^ 0.13.7 test` - Selected tests can be run with `testOnly` command, e.g. `^ testOnly -- -ex "project name"` To publish artifacts locally bump version in `build.sbt` and run in sbt REPL: ``` publishAllLocal ``` ## Compatibility sbt-structure is built and published for sbt 0.13.x, 1.x and 2. sbt-structure-core is built and published for Scala 2.10, 2.11, 2.12, 2.13

Chargement du README du dépôt…

Skills dans ce dépôt

Analystes en assurance qualité des logiciels et testeurs

1 catégories métier · 100% classifié

skill

métier

description

mis à jour

update-test-sbt-versions

Analystes en assurance qualité des logiciels et testeurs

Updates the latest sbt test versions. Use when the user asks "update the latest sbt versions".

Langue du texte source : anglais

2026-04-14

Affichage de 1 skills collectés sur 1.