PubPackageMeta class abstract

Default implementation of PackageMeta depends on pub packages.

Inheritance

• Object
• PackageMeta
• PubPackageMeta

Constructors

PubPackageMeta(Folder dir, ResourceProvider resourceProvider)

Properties

description → String

The package description from pubspec.yaml, or an empty string if not available.

no setter, inherited

dir → Folder

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

homepage → String

no setter, inherited

hostedAt → String?

The hostname that the package is hosted at, usually 'pub.dev', or null if not a hosted pub package.

no setter, inherited

isSdk → bool

Whether this represents a 'Dart' SDK.

no setter, inherited

isValid → bool

Whether this is a valid package (valid enough to generate docs).

no setter, inherited

name → String

no setter, inherited

repository → String

no setter, inherited

requiresFlutter → bool

no setter, inherited

resolvedDir → String

late, final

resourceProvider → ResourceProvider

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

version → String

no setter, inherited

Methods

getInvalidReasons() → List<String>

The list of reasons this package is invalid.

inherited

getReadmeContents() → File?

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

sdkType(String? flutterRootPath) → String?

Returns 'Dart' or 'Flutter' (preferentially, 'Flutter' when the answer is "both"), or null if this package is not part of an SDK.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromDir(Folder folder, ResourceProvider resourceProvider) → PackageMeta?

This factory is guaranteed to return the same object for any given dir.absolute.path. Multiple dir.absolute.paths will resolve to the same object if they are part of the same package. Returns null if the directory is not part of a known package.

fromElement(LibraryElement libraryElement, String sdkDir, ResourceProvider resourceProvider) → PackageMeta?

Use this instead of fromDir where possible.

fromFilename(String filename, ResourceProvider resourceProvider) → PackageMeta?

sdkDirParent(Folder folder, ResourceProvider resourceProvider) → Folder?

If folder is inside a Dart SDK, returns the directory of the SDK, and null otherwise.