FishShell class Null safety

Provides a number of helper functions when dcli needs to interact with the Zsh shell.

Mixed in types

Constructors

FishShell.withPid(int? pid)
Attached to the Fish shell with the given pid.

Properties

canModifyPath bool
Returns true if this shell supports modifying the shell's PATH
read-onlyoverride
hashCode int
The hash code for this object.
read-onlyoverride
hasStartScript bool
True if this shell supports a start script or configuration file. e.g. a script that is run by the shell or a configuration file that is read when the shell starts.
read-onlyoverride
installInstructions String
Returns the instructions to install DCli.
read-onlyinherited
isCompletionInstalled bool
read-onlyoverride
isCompletionSupported bool
read-onlyoverride
isPrivilegedPasswordRequired bool
Returns true if running a privileged action would cause a password to be requested.
read-onlyinherited
isPrivilegedProcess bool
True if the processes real uid is root.
read-onlyinherited
isPrivilegedUser bool
True if the processes effictive uid is root.
read-onlyinherited
isSudo bool
Returns true if we are currently running under sudo.
read-onlyinherited
loggedInUser String
returns the username of the logged in user.
read-onlyinherited
loggedInUsersHome String
Attempts to retrive the logged in user's home directory.
read-onlyinherited
name String
The name of the shell e.g. bash
read-onlyoverride
nonPriviledgedUser Immutable<UserEnvironment>
latefinalinherited
pathToStartScript String
Returns the path to the shell's start script or config file e.g /home/
read-onlyoverride
pid int?
The pid of the current shell
final
priviledgedUser Immutable<UserEnvironment>
latefinalinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
startScriptName String
Returns the name of the shell's startup script or configuration file e.g. .bashrc
read-onlyoverride

Methods

addFileAssocation(String dcliPath) → void
Called during the install so that an OS that needs to create a file association between .dart and dcli can create that association. The implementor is responsible for not adding the association if it already exists.
override
addToPATH(String path) bool
Adds a path to the start script returns true if adding the path was successful
@Deprecated('Use appendToPATH')override
appendToPATH(String path) bool
Appends path to the end of the PATH in a persistent manner. Note: this doesn't update current scripts path. Returns true if we successfully appended the path. In almost all shells you will need to restart the terminal in order for the path change to take affect.
override
checkInstallPreconditions() String?
at this point no posix system has any preconditions.
inherited
install({bool installDart = false, bool activate = true}) bool
Install dart/dcli
inherited
installTabCompletion({bool quiet = false}) → void
If the shell supports tab completion then install it. If quiet is true then suppress any console output except for errors.
override
matchByName(String name) bool
Returns true if the shells name matches the passed name. The comparison is case insensitive.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
prependToPATH(String path) bool
Prepends path to the start of the PATH in a persistent manner. Note: this doesn't update current scripts path. Returns true if we successfully prepended the path. In almost all shells you will need to restart the terminal in order for the path change to take affect.
override
privilegesRequiredMessage(String app) String
The message used during installation if it needs to be run with sudo.
inherited
releasePrivileges() → void
revert uid and gid to original user's id's You should note that your PATH will still be the SUDO PATH not your original user's PATH.
inherited
restorePrivileges() → void
If a prior call to releasePrivileges has been made then this command will restore those privileges If releasePrivileges hasn't been called then this method does nothing.
inherited
toString() String
A string representation of this object.
inherited
withPrivileges(RunPrivileged action, {bool allowUnprivileged = false}) → void
Run action with root UID and gid
inherited

Operators

operator ==(covariant FishShell other) bool
The equality operator.
override

Constants

shellName → const String
Name of the shell
'fish'