installer library
Contains the functions related to the installation process
Classes
- CompletionConfiguration
- A configuration that stores information on how to handle command completions.
- CompletionInstallation
- Manages the installation of completion scripts for the current shell.
- ScriptConfigurationEntry
-
A script entry is a section of a file that starts with
_startCommentand ends with_endComment. - ShellCompletionConfiguration
- Describes all the configuration needed to install completion scripts on a specific shell.
Enums
- SystemShell
- A type definition for a shell.
Extensions
- ShellCommandsMapExtension on ShellCommandsMap
- Provides convinience methods for ShellCommandsMap.
Properties
- bashConfiguration → ShellCompletionConfiguration
-
A ShellCompletionConfiguration for bash.
final
- zshConfiguration → ShellCompletionConfiguration
-
A ShellCompletionConfiguration for zsh.
final
Typedefs
- CompletionScriptTemplate = String Function(String rootCommand)
-
A type definition for functions that creates the content of a
completion script given a
rootCommand -
ShellCommandsMap
= UnmodifiableMapView<
SystemShell, UnmodifiableSetView< String> > - A map of SystemShells to a list of uninstalled commands.
- SourceStringTemplate = String Function(String scriptPath)
-
A type definition for functions that describes
the source line given a
scriptPath
Exceptions / Errors
- CompletionInstallationException
- Describes an exception during the installation of completion scripts.
- CompletionUninstallationException
- Describes an exception during the uninstallation of completion scripts.