Project class

The project we're working with.

Constructors

Project(String projectRoot, Config _config)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addPreamble(String text) → Future<void>

Adds a new paragraph to the preamble (the free text right after the header) of the Unreleased section.

addUnreleased(String type, String description) → Future<void>

Adds a new entry to the Unreleased section. Type is one of a, c, d, f, r, s.

bumpVersion(VersionMutation mutation, {bool keepBuild = false, bool bumpBuild = false, String build = '', String pre = ''}) → Future<Version>

Bumps the project version.

describe(String? version, {bool onlyBody = false}) → Future<String>

Returns a markdown description of the given version or the Unreleased section.

getAllVersions({bool includeYanked = false, bool includeUnreleased = false}) → Future<List<String>>

Lists all versions in the changelog. If includeYanked is true, yanked version will be included. if includeUnreleased is true and the "Unreleased" section is not empty, the "Unreleased" section will be prepended to the listing.

getVersion() → Future<Version>

Reads the project version from the pubspec.yaml.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

release(DateTime date, {Version? version}) → Future<String>

Releases the Unreleased section. Returns the description of the created release.

setVersion(Version newVersion) → Future<void>

Writes the project version to pubspec.yaml.

setYanked(String version, bool yanked) → Future<String>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited