dependency_manager
library
Classes
-
Ansi
-
Helper class to assist in printing text to the console with a color.
-
AnsiColor
-
Helper class to assist in printing text to the console with a color.
-
ArgParser
-
A class for taking a list of raw command line arguments and parsing out
options and flags from them.
-
ArgResults
-
The results of parsing a series of command line arguments using
ArgParser.parse.
-
Ask
-
Class for ask and related code.
-
AskValidator
-
Base class for all AskValidators.
You can add your own by extending this class.
-
AskValidatorIPAddress
-
Validates that input is a IP address
By default both v4 and v6 addresses are valid
Pass a version to limit the input to one or the
other. If passed version must be ipv4 or ipv6.
-
CollectionStyle
-
An enum of collection styles.
-
Column
-
Defined a column to sort by for the FileSort
class.
-
Command<T>
-
A single command.
-
CommandRunner<T>
-
A class for invoking Commands based on raw command-line arguments.
-
Context
-
An instantiable class for manipulating paths. Unlike the top-level
functions, this lets you explicitly select what platform the paths will use.
-
DartProject
-
-
DartScript
-
Used to manage a DCli script.
-
DartSdk
-
The DartSdk provides access to a number of the dart sdk tools
as well as details on the active sdk instance.
-
DCliPaths
-
platform specific names of the dcli commands.
-
Dependency
-
Defines a pubspec.yaml dependency.
-
Digest
-
A message digest as computed by a
Hash or HMAC function.
-
Env
-
Sets gets an environment variable for the current process.
-
FetchData
-
Used with the fetch function to send data for
the likes of a POST command.
-
FetchProgress
-
Passed to the progress method to indicate the current progress of
a download.
-
FetchUrl
-
Used to describe a url that is being downloaded including
the location where it is going to be stored.
-
FileSort
-
FileSort provides the ability to sort files
based on their columns.
-
FileSync
-
Provides a set of methods to read/write
a file synchronisly.
-
Find
-
Implementation for the
_find function.
-
FindItem
-
Holds details of a file system entity returned by the
find function.
-
Format
-
provides a random collection of formatters
EXPERIMENTAL
-
NamedLock
-
A NamedLock can be used to control access to a resource
across processes and isolates.
-
Option
-
A command-line option.
-
OptionType
-
What kinds of values an option accepts.
-
PackedResource
-
Base class used by all PackedResources.
-
PathMap<V>
-
A map whose keys are paths, compared using p.equals and p.hash.
-
PathSet
-
A set containing paths, compared using p.equals and p.hash.
-
ProcessDetails
-
Represents a running Process.
As processes are transitory by the time you access
these details the process may no longer be running.
-
ProcessHelper
-
EXPERIMENTAL
-
Progress
-
central class that provides progress information about a running
process.
-
PubCache
-
Used to locate and manipulate the dart pub cache
-
PubSpec
-
Used to read a pubspec.yaml file
-
Remote
-
Provides remote access methods for posix based systems.
-
ScalarStyle
-
An enum of source scalar styles.
-
Settings
-
Holds all of the global settings for DCli
including dcli paths and any global
flags passed on the command line to DCli.
-
Shell
-
an abstract class which allows each shell (bash, zsh)
to provide specific implementation of features
required by DCli.
-
StackList<T>
-
A classic Stack of items with a push and pop method.
-
StackTraceImpl
-
Provides dart stack frame handling.
-
Style
-
An enum type describing a "flavor" of path.
-
TagDirective
-
A directive describing a custom tag handle.
-
TemplateFlag
-
Allows a user to select which template to use when
creating a project.
-
TemplateListFlag
-
Prints a list of the templates and exists
-
Terminal
-
Provides access to the Ansi Terminal.
-
UnknownShell
-
Used by dcli to interacte with the shell
environment when we are unable to detect
what shell is active.
This may simply be the parent process of the
dart app so not a shell at all.
-
VersionDirective
-
A directive indicating which version of YAML a document was written to.
-
YamlDocument
-
A YAML document, complete with metadata.
-
YamlList
-
A read-only List parsed from YAML.
-
YamlMap
-
A read-only Map parsed from YAML.
-
YamlNode
-
An interface for parsed nodes from a YAML source tree.
-
YamlScalar
-
A wrapped scalar value parsed from YAML.
Properties
-
context
→ Context
-
The system path context.
final
-
current
→ String
-
Gets the path to the current working directory.
no setter
-
env
→ Env
-
Provides access to shell environment variables.
no setter
-
envs
→ Map<String, String>
-
Returns a map of all the environment variables
inherited from the parent as well as any changes
made by calls to
env[]=.
no setter
-
fileList
→ List<String>
-
returns the list of files and directories
in the current directory.
no setter
-
HOME
→ String
-
returns the path to the OS specific HOME directory
no setter
-
PATH
→ List<String>
-
Returns the list of directory paths that are contained
in the OS's PATH environment variable.
They are returned in the same order that they appear within
the PATH environment variable (as order is important.)
no setter
-
posix
→ Context
-
A default context for manipulating POSIX paths.
final
-
pwd
→ String
-
Returns the current working directory.
no setter
-
rootPath
→ String
-
Returns the root path of your file system.
no setter
-
separator
→ String
-
Gets the path separator for the current platform. This is
\ on Windows
and / on other platforms (including the browser).
no setter
-
style
→ Style
-
Returns the Style of the current context.
no setter
-
url
→ Context
-
A default context for manipulating URLs.
final
-
windows
→ Context
-
A default context for manipulating Windows paths.
final
-
yamlWarningCallback
↔ YamlWarningCallback
-
A callback for emitting a warning.
getter/setter pair
Functions
-
absolute(String part1, [String? part2, String? part3, String? part4, String? part5, String? part6, String? part7, String? part8, String? part9, String? part10, String? part11, String? part12, String? part13, String? part14, String? part15])
→ String
-
Returns a new path with the given path parts appended to current.
-
ask(String prompt, {bool toLower = false, bool hidden = false, bool required = true, String? defaultValue, AskValidator validator = Ask.dontCare})
→ String
-
Reads a line of text from stdin with an optional prompt.
-
backupFile(String pathToFile, {bool ignoreMissing = false})
→ void
-
Provide a very simple mechanism to backup a single file.
-
basename(String path)
→ String
-
Gets the part of
path after the last separator.
-
basenameWithoutExtension(String path)
→ String
-
Gets the part of
path after the last separator, and without any trailing
file extension.
-
black(String text, {AnsiColor background = AnsiColor.white, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
-
blue(String text, {AnsiColor background = AnsiColor.none, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
-
calculateHash(String path)
→ Digest
-
Calculates the sha256 hash of a file's
content.
-
canonicalize(String path)
→ String
-
Canonicalizes
path.
-
capture<R>(R action(), {Progress? progress})
→ Future<Progress>
-
Run code in a zone which traps calls to print and printerr
redirecting them to the passed progress.
-
cat(String path, {LineAction stdout = print})
→ void
-
Prints the contents of the file located at
path to stdout.
-
confirm(String prompt, {bool? defaultValue})
→ bool
-
confirm is a specialized version of ask that returns true or
false based on the value entered.
-
copy(String from, String to, {bool overwrite = false})
→ void
-
Copies the file
from to the path to.
-
copyTree(String from, String to, {bool overwrite = false, bool includeHidden = false, bool recursive = true, bool filter(String file) = _allowAll})
→ void
-
Copies the contents of the
from directory to the
to path with an optional filter.
-
createDir(String path, {bool recursive = false})
→ String
-
Creates a directory as described by
path.
Path may be a single path segment (e.g. bin)
or a full or partial tree (e.g. /usr/bin)
-
createTempDir()
→ String
-
Creates a temporary directory under the system temp folder.
The temporary directory name is formed from a uuid.
It is your responsiblity to delete the directory once you have
finsihed with it.
-
createTempFile({String? suffix})
→ String
-
Generates a temporary filename in the system temp directory
that is guaranteed to be unique.
-
createTempFilename({String? suffix, String? pathToTempDir})
→ String
-
Generates a temporary filename in
pathToTempDir
or if inTempDir os not passed then in
the system temp directory.
The generated filename is is guaranteed to be globally unique.
-
cyan(String text, {AnsiColor background = AnsiColor.none, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
-
dcliExit(int exitCode)
→ void
-
Use this method rather than dart:io.exit()
as it is unit test friendly in that it
will throw an ExitException to avoid
shutting the entire unit test framework down.
-
delete(String path, {bool ask = false})
→ void
-
Deletes the file at
path.
-
deleteDir(String path, {bool recursive = true})
→ void
-
Deletes the directory located at
path.
-
deleteSymlink(String linkPath)
→ void
-
Deletes the symlink at
linkPath
-
devNull(String? line)
→ void
-
devNull is a convenience function which you can use
if you want to ignore the output of a LineAction.
Its typical useage is a forEach where you don't want
to see any stdout but you still want to see errors
printed to stderr.
-
dirname(String path)
→ String
-
Gets the part of
path before the last separator.
-
echo(String text, {bool newline = false})
→ void
-
Writes
text to stdout including a newline.
-
equals(String path1, String path2)
→ bool
-
Returns
true if path1 points to the same location as path2, and
false otherwise.
-
exists(String path, {bool followLinks = true})
→ bool
-
Returns true if the given path exists.
It may be a file, directory or link.
-
extension(String path, [int level = 1])
→ String
-
Gets the file extension of
path: the portion of basename from the last
. to the end (including the . itself).
-
fetch({required String url, required String saveToPath, FetchMethod method = FetchMethod.get, OnFetchProgress fetchProgress = _devNull, FetchData? data})
→ void
-
Fetches the given resource at the passed
url.
-
fetchMultiple({required List<FetchUrl> urls})
→ void
-
Fetches the list of of resources indicated by
urls;
-
fileLength(String pathToFile)
→ int
-
Returns the length of the file at
pathToFile in bytes.
-
find(String pattern, {bool caseSensitive = false, bool recursive = true, bool includeHidden = false, String workingDirectory = '.', Progress? progress, List<FileSystemEntityType> types = const [Find.file]})
→ FindProgress
-
Returns the list of files in the current and child
directories that match the passed glob pattern.
-
fromUri(Object? uri)
→ String
-
Returns the path represented by
uri, which may be a String or a Uri.
-
green(String text, {AnsiColor background = AnsiColor.none, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
-
grey(String text, {double level = 0.5, AnsiColor background = AnsiColor.none, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
-
hash(String path)
→ int
-
Returns a hash code for
path such that, if equals returns true for two
paths, their hash codes are the same.
-
head(String path, int lines)
→ HeadProgress
-
Prepares to read count
lines from the file at path.
-
isAbsolute(String path)
→ bool
-
Returns
true if path is an absolute path and false if it is a
relative path.
-
isDirectory(String path)
→ bool
-
Returns true if the given
path is a directory.
-
isEmpty(String pathToDirectory)
→ bool
-
Returns true if the passed
pathToDirectory is an
empty directory.
For large directories this operation can be expensive.
-
isExecutable(String path)
→ bool
-
checks if the passed
path (a file or directory) is
executable by the user that owns this process
-
isFile(String path)
→ bool
-
Returns true if the given
path points to a file.
If path is a link the link will be followed and
we report on the resolved path.
-
isLink(String path)
→ bool
-
Returns true if the given
path is a symlink
-
isOnPATH(String path)
→ bool
-
Tests if the given
path is contained
in the OS's PATH environment variable.
An canonicalized match of path is made against
each path on the OS's path.
-
isReadable(String path)
→ bool
-
checks if the passed
path (a file or directory) is
readable by the user that owns this process
-
isRelative(String path)
→ bool
-
Returns
true if path is a relative path and false if it is absolute.
On POSIX systems, absolute paths start with a / (forward slash). On
Windows, an absolute path starts with \\, or a drive letter followed by
:/ or :\.
-
isRootRelative(String path)
→ bool
-
Returns
true if path is a root-relative path and false if it's not.
-
isWithin(String parent, String child)
→ bool
-
Returns
true if child is a path beneath parent, and false otherwise.
-
isWritable(String path)
→ bool
-
checks if the passed
path (a file or directory) is
writable by the user that owns this process
-
join(String part1, [String? part2, String? part3, String? part4, String? part5, String? part6, String? part7, String? part8, String? part9, String? part10, String? part11, String? part12, String? part13, String? part14, String? part15, String? part16])
→ String
-
Joins the given path parts into a single path using the current platform's
separator. Example:
-
joinAll(Iterable<String> parts)
→ String
-
Joins the given path parts into a single path using the current platform's
separator. Example:
-
lastModified(String path)
→ DateTime
-
Returns the datetime the path was last modified
-
loadYaml(String yaml, {Uri? sourceUrl, bool recover = false, ErrorListener? errorListener})
→ dynamic
-
Loads a single document from a YAML string.
-
loadYamlDocument(String yaml, {Uri? sourceUrl, bool recover = false, ErrorListener? errorListener})
→ YamlDocument
-
Loads a single document from a YAML string as a YamlDocument.
-
loadYamlDocuments(String yaml, {Uri? sourceUrl})
→ List<YamlDocument>
-
Loads a stream of documents from a YAML string.
-
loadYamlNode(String yaml, {Uri? sourceUrl, bool recover = false, ErrorListener? errorListener})
→ YamlNode
-
Loads a single document from a YAML string as a YamlNode.
-
loadYamlStream(String yaml, {Uri? sourceUrl})
→ YamlList
-
Loads a stream of documents from a YAML string.
-
magenta(String text, {AnsiColor background = AnsiColor.none, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
-
Displays a menu with each of the provided
options, prompts
the user to select an option and returns the selected option.
-
move(String from, String to, {bool overwrite = false})
→ void
-
Moves the file
from to the location to.
-
moveDir(String from, String to)
→ void
-
Moves or renames the
from directory to the
to the to path.
-
moveTree(String from, String to, {bool overwrite = false, bool includeHidden = false, bool filter(String file) = _allowAll})
→ void
-
Recursively moves the contents of the
from directory to the
to the to path with an optional filter.
-
normalize(String path)
→ String
-
Normalizes
path, simplifying it by handling .., and ., and
removing redundant path separators whenever possible.
-
orange(String text, {AnsiColor background = AnsiColor.none, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
-
prettyUri(Object? uri)
→ String
-
Returns a terse, human-readable representation of
uri.
-
printerr(String? line)
→ void
-
printerr provides the equivalent functionality to the
standard Dart print function but instead writes
the output to stderr rather than stdout.
-
privatePath(String part1, [String? part2, String? part3, String? part4, String? part5, String? part6, String? part7])
→ String
-
Removes the users home directory from a path replacing it with ~
-
read(String path, {String delim = '\n'})
→ Progress
-
Reads lines from the file at
path.
-
readStdin()
→ Progress
-
Read lines from stdin
-
red(String text, {AnsiColor background = AnsiColor.none, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
-
relative(String path, {String? from})
→ String
-
Attempts to convert
path to an equivalent relative path from the current
directory.
-
replace(String path, Pattern existing, String replacement, {bool all = false})
→ int
-
Does an insitu replacement on the file located at
path.
-
resolveSymLink(String pathToLink)
→ String
-
Resolves the a symbolic link
pathToLink
to the ultimate target path.
-
restoreFile(String pathToFile, {bool ignoreMissing = false})
→ void
-
Designed to work with backupFile to restore
a file from backup.
The existing file is deleted and restored
from the .bak/
-
rootPrefix(String path)
→ String
-
Returns the root of
path, if it's absolute, or the empty string if it's
relative.
-
run(String commandLine, {bool runInShell = false, bool nothrow = false, bool privileged = false, String? workingDirectory, bool extensionSearch = true})
→ int?
-
Runs the given cli
commandLine writing any output
from both stdout and stderr to the console.
-
setExtension(String path, String extension)
→ String
-
Returns
path with the trailing extension set to extension.
-
setLastModifed(String path, DateTime lastModified)
→ void
-
Sets the last modified datetime on the given the path.
-
showEditor(String path)
→ void
-
Launches the systems default cli editor on Linux and MacOS
using the EDITOR environment variable.
-
sleep(int duration, {Interval interval = Interval.seconds})
→ void
-
sleeps for the provided
duration of the given interval.
-
split(String path)
→ List<String>
-
Splits
path into its components using the current platform's separator.
-
start(String commandLine, {Progress? progress, bool runInShell = false, bool detached = false, bool terminal = false, bool nothrow = false, bool privileged = false, String? workingDirectory, bool extensionSearch = true})
→ Progress
-
Allows you to execute a cli
commandLine.
-
startFromArgs(String command, List<String> args, {Progress? progress, bool runInShell = false, bool detached = false, bool terminal = false, bool privileged = false, bool nothrow = false, String? workingDirectory, bool extensionSearch = true})
→ Progress
-
Allows you to execute a command by passing a
command
and a list of args in args.
-
stat(String path)
→ FileStat
-
Returns a FileStat instance describing the
file or directory located by
path.
-
symlink(String existingPath, String linkPath)
→ void
-
Creates a link at
linkPath which points to an
existing file or directory at existingPath
-
tail(String path, int lines)
→ TailProgress
-
Returns count
lines from the end of the file at path.
-
touch(String path, {bool create = false})
→ String
-
Updates the last modified time stamp of a file.
-
toUri(String path)
→ Uri
-
Returns the URI that represents
path.
-
translateAbsolutePath(String absolutePath, {String? workingDirectory, Context? context})
→ String
-
Windows, an absolute path starts with
\\, or a drive letter followed by
:/ or :\.
This method will strip the prefix so the path start with a \ or /
and the prepend the drive letter so that it becomes a valid
path. If the absolutePath doesn't contain a drive letter
then we take the drive letter from the workingDirectory.
If this is a linux absolute path it is returned unchanged.
-
truepath(String part1, [String? part2, String? part3, String? part4, String? part5, String? part6, String? part7])
→ String
-
truepath creates an absolute and normalized path.
-
verbose(String callback())
→ void
-
If Settings.isVerbose is true then
this method will call
callback to
get a String which will be logged to the
console or the log file set via the verbose command line
option.
-
waitForEx<T>(Future<T> future)
→ T
-
Wraps the standard cli waitFor
but rethrows any exceptions with a repaired stacktrace.
-
which(String appname, {bool first = true, bool verbose = false, bool extensionSearch = true, Sink<String>? progress})
→ Which
-
Searches the PATH for the location of the application
give by
appname.
-
white(String text, {AnsiColor background = AnsiColor.none, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
-
withEnvironment<R>(R callback(), {required Map<String, String> environment})
→ R
-
Creates a environment that is contained to the scope
of the
callback method.
-
withFileProtection<R>(List<String> protected, R action(), {String? workingDirectory})
→ R
-
EXPERIMENTAL - use with caution and the api may change.
-
withOpenFile<R>(String pathToFile, R action(FileSync), {FileMode fileMode = FileMode.writeOnlyAppend})
→ R
-
Opens a File and calls
action passing in the open file.
When action completes the file is closed.
Use this method in preference to directly callling FileSync()
-
withoutExtension(String path)
→ String
-
Removes a trailing extension from the last part of
path.
-
withTempDir<R>(R action(String tempDir), {bool keep = false, String? pathToTempDir})
→ R
-
Creates a temp directory and then calls
action.
Once action completes the temporary directory will be deleted.
-
withTempFile<R>(R action(String tempFile), {String? suffix, String? pathToTempDir, bool create = true, bool keep = false})
→ R
-
Creates a temp file and then calls
action.
-
yellow(String text, {AnsiColor background = AnsiColor.none, bool bold = true})
→ String
-
Wraps the passed text with the ANSI escape sequence for
the color red.
Use this to control the color of text when printing to the
console.
