p

org.jetbrains.sbt

structure

package structure

Since

12/15/15.

Linear Supertypes
DataSerializers, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. structure
  2. DataSerializers
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class BuildData extends Product

    Information about build dependencies and implicit imports for proper editing of .sbt files

  2. case class CommandData(name: String, help: Seq[(String, String)]) extends Product with Serializable
  3. case class CompilerOptions(configuration: Configuration, options: Seq[String]) extends Product with Serializable
  4. case class Configuration(name: String) extends Product with Serializable
  5. case class ConfigurationData(id: String, sources: Seq[DirectoryData], resources: Seq[DirectoryData], excludes: Seq[File], classes: File) extends Product with Serializable

    Lists of directories in specified configuration

    Lists of directories in specified configuration

    id

    Name of configuration, usually "compile" or "test"

    sources

    List of source directories

    resources

    List of resource directories

    excludes

    List of excluded directories

    classes

    Directory containing compiled classes and copied resources

  6. trait DataSerializers extends AnyRef
  7. case class Dependencies[T](forProduction: Seq[T], forTest: Seq[T]) extends Product with Serializable

    forProduction

    dependencies that should go to the main module. If separate modules for production/test sources are disabled, then all dependencies are put in this field.

    forTest

    dependencies that should go to the test module. If separate modules for production/test sources are disabled, then this field contains en empty Seq.

  8. case class DependencyData(projects: Dependencies[ProjectDependencyData], modules: Dependencies[ModuleDependencyData], jars: Dependencies[JarDependencyData]) extends Product with Serializable
  9. case class DirectoryData(file: File, managed: Boolean) extends Product with Serializable
  10. case class JarDependencyData(file: File, configurations: Seq[Configuration]) extends Product with Serializable

    Unmanaged dependency

    Unmanaged dependency

    file

    File to depend on

  11. case class JavaData(home: Option[File], options: Seq[CompilerOptions]) extends Product with Serializable
  12. case class ModuleData(id: ModuleIdentifier, binaries: Set[File], docs: Set[File], sources: Set[File]) extends Product with Serializable

    External library data.

    External library data. Corresponds to a project-level library in IDEA.

    id

    Library identifier

    binaries

    List of binary jars

    docs

    List of javadoc jars

    sources

    List of source jars

  13. case class ModuleDependencyData(id: ModuleIdentifier, configurations: Seq[Configuration]) extends Product with Serializable

    External library dependency

    External library dependency

    id

    Library identifier

  14. case class ModuleIdentifier(organization: String, name: String, revision: String, artifactType: String, classifier: String) extends Product with Serializable

    Library identifier

    Library identifier

    revision

    AKA version

  15. case class Play2Data(playVersion: Option[String], templatesImports: Seq[String], routesImports: Seq[String], confDirectory: Option[File], sourceDirectory: File) extends Product with Serializable

    List of parameters specific to Play projects

  16. case class ProjectData(id: String, buildURI: URI, name: String, organization: String, version: String, base: File, packagePrefix: Option[String], basePackages: Seq[String], target: File, configurations: Seq[ConfigurationData], java: Option[JavaData], scala: Option[ScalaData], compileOrder: String, dependencies: DependencyData, resolvers: Set[ResolverData], play2: Option[Play2Data], settings: Seq[SettingData], tasks: Seq[TaskData], commands: Seq[CommandData], mainSourceDirectories: Seq[File], testSourceDirectories: Seq[File], generatedManagedSources: Boolean) extends Product with Serializable

    Represents single project in build.

    Represents single project in build. Corresponds to IDEA module.

    basePackages

    List of packages to use as base prefixes in chaining

    target

    Compiler output directory (value of target key)

    mainSourceDirectories

    List of source directories in all available source configurations. Unlike org.jetbrains.sbt.structure.ConfigurationData#sources(), which was obtained from managedSourceDirectories and unmanagedSourceDirectories keys, this value is sourced from the sourceDirectory key. In a simple sbt project in e.g. compile configuration org.jetbrains.sbt.structure.ConfigurationData#sources() will be (the project path at the beginning of these paths is skipped)

    • /target/scala-3.3.3/src_managed/main - /src/main/scala - /src/main/scala-3 - /src/main/java But value of this field will be just /src/main. It is needed to identify ContentRootData#rootPath in the Scala plugin.
  17. case class ProjectDependencyData(project: String, buildURI: Option[URI], configurations: Seq[Configuration]) extends Product with Serializable

    Inter-project dependency

    Inter-project dependency

    project

    What project to depend on

  18. case class RepositoryData(modules: Seq[ModuleData]) extends Product with Serializable

    List of external libraries

  19. case class ResolverData(name: String, root: String) extends Product with Serializable

    Repository used to resolve external library dependencies

    Repository used to resolve external library dependencies

    root

    URL or local path to a repo

  20. case class ScalaData(organization: String, version: String, libraryJars: Seq[File], compilerJars: Seq[File], extraJars: Seq[File], compilerBridgeBinaryJar: Option[File], options: Seq[CompilerOptions]) extends Product with Serializable

    Analog of sbt.internal.inc.ScalaInstance

    Analog of sbt.internal.inc.ScalaInstance

    libraryJars

    contains scala-library.jar and (in case of Scala 3) scala3-library_3.jar

    compilerJars

    contains all jars required to instantiate scala compiler
    (except for library jars, which should also be included when creating a compiler instance)

    extraJars

    other jars, usually contain jars required to run ScalaDoc

    compilerBridgeBinaryJar

    scala3-compiler-bridge_3.x.jar, extracted from sbt.Keys.scalaCompilerBridgeBinaryJar

  21. case class SettingData(label: String, description: Option[String], rank: Int, stringValue: Option[String]) extends Product with Serializable
  22. case class StructureData(sbtVersion: String, builds: Seq[BuildData], projects: Seq[ProjectData], repository: Option[RepositoryData], localCachePath: Option[File]) extends Product with Serializable

    Represent specified build.

    Represent specified build. Corresponds to IDEA project.

    projects

    List of projects in build

    repository

    List of libraries in build

    localCachePath

    Path to a place where Ivy downloads artifacts. Usually ~/.ivy2/cache

  23. case class TaskData(label: String, description: Option[String], rank: Int) extends Product with Serializable
  24. trait XmlSerializer[T] extends AnyRef

    Since

    4/8/15.

Value Members

  1. implicit val buildDataSerializer: XmlSerializer[BuildData]
    Definition Classes
    DataSerializers
  2. implicit val commandDataSerializer: XmlSerializer[CommandData]
    Definition Classes
    DataSerializers
  3. implicit val compilerOptionsSerializer: XmlSerializer[CompilerOptions]
    Definition Classes
    DataSerializers
  4. implicit val configurationDataSerializer: XmlSerializer[ConfigurationData]
    Definition Classes
    DataSerializers
  5. implicit val dependencyDataSerializer: XmlSerializer[DependencyData]
    Definition Classes
    DataSerializers
  6. implicit val jarDependenciesSerializer: XmlSerializer[Dependencies[JarDependencyData]]
    Definition Classes
    DataSerializers
  7. implicit val jarDependencyDataSerializer: XmlSerializer[JarDependencyData]
    Definition Classes
    DataSerializers
  8. implicit val javaDataSerializer: XmlSerializer[JavaData]
    Definition Classes
    DataSerializers
  9. implicit val moduleDataSerializer: XmlSerializer[ModuleData]
    Definition Classes
    DataSerializers
  10. implicit val moduleDependenciesSerializer: XmlSerializer[Dependencies[ModuleDependencyData]]
    Definition Classes
    DataSerializers
  11. implicit val moduleDependencyDataSerializer: XmlSerializer[ModuleDependencyData]
    Definition Classes
    DataSerializers
  12. implicit val moduleIdentifierSerializer: XmlSerializer[ModuleIdentifier]
    Definition Classes
    DataSerializers
  13. implicit val play2DataSerializer: XmlSerializer[Play2Data]
    Definition Classes
    DataSerializers
  14. implicit val projectDataSerializer: XmlSerializer[ProjectData]
    Definition Classes
    DataSerializers
  15. implicit val projectDependenciesSerializer: XmlSerializer[Dependencies[ProjectDependencyData]]
    Definition Classes
    DataSerializers
  16. implicit val projectDependencySerializer: XmlSerializer[ProjectDependencyData]
    Definition Classes
    DataSerializers
  17. implicit val repositoryDataSerializer: XmlSerializer[RepositoryData]
    Definition Classes
    DataSerializers
  18. implicit val resolverDataSerializer: XmlSerializer[ResolverData]
    Definition Classes
    DataSerializers
  19. implicit val scalaDataSerializer: XmlSerializer[ScalaData]
    Definition Classes
    DataSerializers
  20. implicit val settingDataSerializer: XmlSerializer[SettingData]
    Definition Classes
    DataSerializers
  21. implicit val structureDataSerializer: XmlSerializer[StructureData]
    Definition Classes
    DataSerializers
  22. implicit val taskDataSerializer: XmlSerializer[TaskData]
    Definition Classes
    DataSerializers
  23. object BuildData
  24. object Configuration extends Serializable
  25. object XmlSerializer

Inherited from DataSerializers

Inherited from AnyRef

Inherited from Any

Ungrouped