Packages

package workspace

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait Layer extends AnyRef

    Project metadata is modeled as an ordered sequence of namespace layers which contain an ordered sequence of module layers.

    Project metadata is modeled as an ordered sequence of namespace layers which contain an ordered sequence of module layers. The layers should be ordered by deploy order, this means external layers defined via $.plugins.dependencies will appear first before the namespace layer for the target project. Namespaces must be unique, which means you can not use dependencies to reference a second sfdx-project.json using the same namespace, all 2GP modules must be contained in a single sfdx-project.json.

  2. case class ModuleLayer(projectPath: PathLike, relativePath: String, dependencies: Seq[ModuleLayer]) extends Product with Serializable

    A package layer encompasses a packageDirectory from sfdx-project.json or a 1GP style MDAPI metadata directory.

    A package layer encompasses a packageDirectory from sfdx-project.json or a 1GP style MDAPI metadata directory. The dependencies should only reference layers defined within the same NamespaceLayer.

  3. case class NamespaceLayer(namespace: Option[Name], isGulped: Boolean, layers: Seq[ModuleLayer]) extends Layer with Product with Serializable

    A namespace layer provides the namespace for some list of module layers.

    A namespace layer provides the namespace for some list of module layers. The list will be empty for 'ghosted' packages where only knowledge of a namespace is provided. In a 1GP package each layer will depend on its predecessor, with 2GP the layer dependencies are declared.

  4. case class ProjectConfig(maxDependencyCount: Option[Int]) extends Product with Serializable

    Contains any config option that can be used by the Org

  5. case class Workspace(layers: Seq[NamespaceLayer], projectConfig: Option[ProjectConfig] = None) extends Product with Serializable

    Metadata workspace, maintains information on available metadata within a project/package.

    Metadata workspace, maintains information on available metadata within a project/package.

    Duplicate detection is based on the relevant MetadataDocumentType(s) being able to generate an accurate TypeName for the metadata. Where multiple metadata items may contribute to a type, e.g. labels, make sure that duplicatesAllowed is set which will bypass the duplicate detection. Duplicates are reported as errors and then ignored.

    During an upsert/deletion of new types the index will also need to be updated so that it maintains an accurate view of the metadata files being used.

Value Members

  1. object Workspace extends Serializable

Ungrouped