cli_pkg library

Classes

ConfigVariable<T>
A variable whose value is configurable by the user, either as a static value or as a callback that's called as-needed and whose value is cached.
JSRequire
A JavaScript dependency to require() at the beginning of the generated JS file.

Enums

JSRequireTarget
An enumeration of possible targets in which to include the require.

Properties

botEmail → ConfigVariable<String>
The email address to use for non-authentication-related recordings, such as Git commit metadata.
final
botName → ConfigVariable<String>
The human-friendly name to use for non-authentication-related recordings by this automation tool, such as Git commit metadata.
final
chocolateyDartVersion → String
The version of the Dart SDK, formatted for Chocolatey which doesn't allow dots in prerelease versions.
no setter
chocolateyFiles → ConfigVariable<List<String>>
The set of files to include directly in the Chocolatey package.
final
chocolateyNuspec → ConfigVariable<String>
The text contents of the Chocolatey package's .nuspec file.
final
chocolateyToken → ConfigVariable<String>
The Chocolatey API key (available from the Chocolatey website and the choco apikey command) to use when creating releases and making other changes.
final
dartName → String
The name of the package, as specified in the pubspec.
final
environmentConstants → ConfigVariable<Map<String, String>>
A mutable map of environment constants to pass to Dart (using -D${name}=${value}) when compiling executables for this package.
final
executables → ConfigVariable<Map<String, String>>
A mutable map from executable names to those executables' paths in bin/.
final
githubBearerToken → ConfigVariable<String?>
The GitHub token to use for bearer authorization.
final
githubPassword → ConfigVariable<String>
The GitHub password or authentication token to use when creating releases and making other changes.
final
githubReleaseNotes → ConfigVariable<String?>
The Markdown-formatted release notes to use for the GitHub release.
final
githubRepo → ConfigVariable<String>
The GitHub repository slug (for example, username/repo) to which to upload package releases.
final
githubUser → ConfigVariable<String>
The GitHub username to use when creating releases and making other changes.
final
homebrewCreateVersionedFormula → ConfigVariable<bool>
Whether to update homebrewFormula in-place or copy it to a new @-versioned formula file for the current version number.
final
homebrewEditFormula → ConfigVariable<FutureOr<String> Function(String)>
A user-defined function that modifies the formula after the automatic edits have been applied.
final
homebrewFormula → ConfigVariable<String?>
The path to the formula file within the Homebrew repository to update with the new package version.
final
homebrewRepo → ConfigVariable<String>
The GitHub repository slug (for example, username/repo) of the Homebrew repository for this package.
final
homebrewTag → ConfigVariable<String>
The Git tag for version of the package being released.
final
humanName → ConfigVariable<String>
The human-friendly name of the package.
final
jsDevFlags → ConfigVariable<List<String>>
A modifiable list of flags to pass to dart2js only when compiling executables in development mode.
final
jsEsmExports → ConfigVariable<Set<String>?>
A list of member names to export from ESM library entrypoints, since ESM exports must be explicitly listed in each wrapper library.
final
jsFlags → ConfigVariable<List<String>>
A modifiable list of additional flags to pass to dart2js when compiling executables.
final
jsForceStrictMode → ConfigVariable<bool>
Whether to force strict mode for the generated JS code.
final
jsModuleMainLibrary → ConfigVariable<String?>
The path to a Dart library whose main() method will be called when the compiled JavaScript module is loaded.
final
jsReleaseFlags → ConfigVariable<List<String>>
A modifiable list of flags to pass to dart2js only when compiling executables in release mode.
final
jsRequires → ConfigVariable<List<JSRequire>>
A modifiable list of JavaScript packages to require() at the beginning of the generated JS file.
final
name → ConfigVariable<String>
The default name of the package on package managers other than pub.
final
npmAdditionalFiles → ConfigVariable<Map<String, String>>
A set of additional files to include in the npm package.
final
npmDistTag → ConfigVariable<String>
The distribution tag to use when publishing the current npm package.
final
npmPackageJson → ConfigVariable<Map<String, dynamic>>
The decoded contents of the npm package's package.json file.
final
npmReadme → ConfigVariable<String?>
The Markdown-formatted text of the README to include in the npm package.
final
npmToken → ConfigVariable<String>
The npm authentication token to use when creating releases and making other changes.
final
pubCredentials → ConfigVariable<String>
The entire contents of the pub-credentials.json file.
final
pubspec → Pubspec
The parsed pubspec for the CLI package.
final
standaloneName → ConfigVariable<String>
The name of the standalone package.
final
version → Version
The package's version, as specified in the pubspec.
final

Functions

addAllTasks() → void
Enables all tasks from the cli_pkg package.
addChocolateyTasks() → void
Enables tasks for building and uploading packages to Chocolatey.
addGithubTasks() → void
Enables tasks for releasing the package on GitHub releases.
addHomebrewTasks() → void
Enables tasks for uploading the package to Homebrew.
addNpmTasks() → void
Enables tasks for building packages for npm.
addPubTasks() → void
Enables tasks for uploading the package to Pub.
addStandaloneTasks() → void
Enables tasks for building standalone Dart VM packages.