vcshooks library
Classes
- ConfigCache
- Script Configuration cache.
- PreCommitConfig
- Pre-commit configuration for the current project.
- ScriptArgument
- Script arguments.
- ScriptConfig
- Script configuration for the current project.
- SoftwareDownloader
- Script software downloader.
- VCSHooksHandler
- Hooks handler that take care of handling related git hooks actions.
Enums
- OperatingSystem
- Script supported computer operating system.
Extensions
- ArgResultsExtenstion on ArgResults
- Script arguments parser.
- ScriptConfigExtension on ScriptConfig
- Script Configuration Extensions.
- SupportedOperatingSystemExtensions on OperatingSystem
- OperatingSystem extensions functions.
Constants
- dartProjectType → const String
-
Script parameter used for
_projectTypeArgument
parameter to specify that the script is run on a dart project. - exitInvalidArgument → const int
- Process exit code for invalid command line argument.
- exitMissingRequiredArgument → const int
- Process exit code for missing required command line argument.
- exitUnexpectedError → const int
- Process exit code when an unexpected error occurred.
- flutterProjectType → const String
-
Script parameter used for
_projectTypeArgument
parameter to specify that the script is run on a flutter project. - helpArgument → const String
- Script parameter used to print help.
-
supportedProjectType
→ const List<
String> - List of project type supported by the script.
Properties
- argumentParser → ArgParser
-
Script argument parser.
final
Functions
-
getCurrentOs(
) → OperatingSystem - Get the current operating system running on the computer.
-
getResolvedProjectDir(
String projectDir) → Directory - Get the project Directory with a full path.
-
loadScriptConfig(
OperatingSystem currentOS, Directory currentDir) → Future< ScriptConfig> - Load the current project script config and validate that its content.
-
printHelpMessage(
[String? message]) → void - Print help message to the console.
Exceptions / Errors
- UnrecoverableException
- A class that represent a exception that can't be recovered.
- UnsupportedOsException
- Exception that's thrown when the script is used on an OperatingSystem that's not supported.