api_tool_cli library
Classes
- AndroidPlatformConstraints
- represents Android platform constraints
- ApiChange
- Represents one API change
- ApiChangeTreeNode
- represents a tree node in the hierarchical change representation
- ColorUtils
- Utility class for handling colored terminal output. Automatically detects if stdout/stderr are attached to a terminal and disables colors when output is piped to a file.
- DartInteraction
- Helper class for interacting with Dart and Flutter
- Declaration
- interface for all Declarations
- DiffCommand
- command for diffing two packages
- ExecutableDeclaration
- Represents an executable declaration
- ExecutableParameterDeclaration
- Represents an executable parameter declaration
- ExtractCommand
- command to extract the public API of a package. This is used when, for example, the public API needs to be stored on disk
- FieldDeclaration
- represents a found FieldDeclaration
- GitInteraction
- GitRef
- Represents a parsed git reference from a package ref string
- InterfaceDeclaration
- Represents a found interface declaration
- IOSPlatformConstraints
- represents iOS platform constraints
- NamingUtils
- Utilities for naming things
- PackageApi
- represents the model of a public package API.
- PackageApiAnalyzer
- this class analyzes the public package API of a given package (packagePath)
- PackageApiDiffer
- can calculate a diff between two PackageApis
- PackageApiDifferOptions
- represents options for the PackageApiDiffer
- PackageApiDiffResult
- represents the result of a diff run
- PackageApiStorage
- provides access to the storage functionality for PackageApis makes sure to use the right version of the storage model when reading from storage and uses the latest storage version when writing to storage
- PackageDependency
- represents a package dependency
- PackageRef
- representation of a package reference
- PreparedPackageRef
- represents a prepared package ref this includes the actual packageRef and tempDirectory if the preparation had to create a temporary directory
- ProcessUtils
- utility class for running subprocesses
- PubInteraction
- helper class for interactions with pub
- StdoutSession
- defines a stdout session that supports opening a "window" for subprocesses that has a limited height
- TypeAliasDeclaration
- represents a found TypeAliasDeclaration
- TypeHierarchy
- represents the type hierarchy of the public API of a package
- TypeIdentifier
- represents a type identifier consists of name and full library name
- TypeUsage
- represents the usage of a type
Enums
- ApiChangeCode
- ApiChangeType
- represents the type of API change
- DependencyCheckMode
- ExecutableType
- Represents the type of executable found
- PackageApiSemantics
- defines the semantics used in a PackageApi model
- SdkType
- represents the type of the SDK
- TypeUsageKind
- specifies how a type is used
- VersionCheckMode
- version check mode to apply
Extensions
- AndroidPlatformConstraintsPatterns on AndroidPlatformConstraints
- Adds pattern-matching-related methods to AndroidPlatformConstraints.
- ExecutableDeclarationPatterns on ExecutableDeclaration
- Adds pattern-matching-related methods to ExecutableDeclaration.
- ExecutableParameterDeclarationPatterns on ExecutableParameterDeclaration
- Adds pattern-matching-related methods to ExecutableParameterDeclaration.
- FieldDeclarationPatterns on FieldDeclaration
- Adds pattern-matching-related methods to FieldDeclaration.
- InterfaceDeclarationPatterns on InterfaceDeclaration
- Adds pattern-matching-related methods to InterfaceDeclaration.
- IOSPlatformConstraintsPatterns on IOSPlatformConstraints
- Adds pattern-matching-related methods to IOSPlatformConstraints.
- PackageApiPatterns on PackageApi
- Adds pattern-matching-related methods to PackageApi.
- PackageDependencyPatterns on PackageDependency
- Adds pattern-matching-related methods to PackageDependency.
- TypeAliasDeclarationPatterns on TypeAliasDeclaration
- Adds pattern-matching-related methods to TypeAliasDeclaration.
- TypeIdentifierPatterns on TypeIdentifier
- Adds pattern-matching-related methods to TypeIdentifier.
- TypeUsagePatterns on TypeUsage
- Adds pattern-matching-related methods to TypeUsage.
Functions
-
getDeclarationNodeHeadline(
Declaration declaration) → String -
getOwnVersion(
) → Future< String> -
getPackageNameFromLibrary(
LibraryElement2 library) → String? -
getTypeParameterSuffix(
List< String> typeParameterNames) → String -
returns the type parameter suffix (like
<T>)
Exceptions / Errors
- PackageApiDiffError
- Error that gets thrown when an Error happens during diffing two PackageApis
- RunDartError
- Error that gets thrown when executing Dart runs into an error