Overview

• module Teapot
  • module Command
    • class BuildFailedError

      Raised when the build fails.
    • class Build

      A command to build targets in the project.

      • options
    • class Clean

      A command to clean build artifacts.
    • class Clone

      A command to clone a remote repository and fetch all dependencies.
    • class Create

      A command to create a new teapot project.
    • class FetchError

      Raised when a fetch operation fails.
    • class Fetch

      A command to fetch remote packages and dependencies.

      • options
    • class List

      A command to list project definitions and dependencies.
    • class Selection

      Base class for commands that work with selections.
    • class Status

      A command to show git status of packages.
    • class Visualize

      A command to visualize dependency graphs.

      • class Packages

        Visualize package-level dependencies.

        • options
      • class Targets

        Visualize target-level dependencies.

        • options
      • class Files

        Visualize file-level dependencies from the build graph.

        • options
    • class Top

      Represents the top-level command for the teapot CLI.

      • options
  • class Configuration

    A configuration represents a mapping between package/dependency names and actual source locations. Usually, there is only one configuration, but in some cases it is useful to have more than one, e.g. one for local development using local source code, one for continuous integration, and one for deployment.
  • class Context

    A context represents a specific root package instance with a given configuration and all related definitions. A context is stateful in the sense that package selection is specialized based on #select and #dependency_chain. These parameters are usually set up initially as part of the context setup.
  • class Definition

    Base class for definitions (target, configuration, or project).
  • class IncompatibleTeapotError

    Raised when a teapot file requires an incompatible version.
  • class MissingTeapotError

    Raised when a teapot file cannot be found.
  • class Script

    The DSL exposed to the teapot.rb file.
  • class Loader

    Loads the teapot.rb script and can reload it if it was changed.
  • class Package

    A package in the dependency graph.
  • class Project

    A project definition.
  • class AlreadyDefinedError

    Raised when a definition is already defined.
  • class Select

    A selection is a specific view of the data exposed by the context at a specific point in time.
  • class BuildError

    Raised during build operations.
  • class Target

    A build target.