dart_pre_commit library

Classes

ConfigurableTaskProviderBuilder
A helper class to easily create a ConfigurableTaskProviderFamily.
ConfigurableTaskProviderFamily<State extends TaskBase, Arg>
A custom riverpod provider family for TaskBase classes that are configurable.
ConsoleLogger
An advanced logger, that providers console optimized, interactive logging.
DartPreCommit
A simple static class that provides a method to simply run the pre commit hooks.
DefaultTasksLoader
A helper class to automatically register all tasks that are provided with this package in the TaskLoader.
FileTask
A task that is run multiple times, once for every matching file.
Hooks
A callable class the runs the hooks on a repository.
HooksConfig
A configuration class for launching the Hooks instance.
Logger
The primary logger interface, with status functionality.
RepoEntry
Describes a file in the repository to be analyzed.
RepoTask
A task that runs once for the whole repository.
SimpleLogger
A simple logger class, the provides file-optimized logs.
TaskBase
The base class for all tasks.
TaskLoader
A helper class to register TaskProviders in the application to be used by the Hooks instance.
TaskLogger
The interface for the logger as TaskBase classes expect it.
TaskProvider<State extends TaskBase>
A custom riverpod provider for TaskBase classes.

Enums

HookResult
The result of a Hooks call.
LogLevel
The logging level that different log messages can have.
TaskResult
The possible result states of a generic task.
TaskStatus
The status a TaskBase can be in.

Mixins

PatternTaskMixin
A mixin for TaskBase that implements TaskBase.canProcess based on a filePattern.

Properties

analyzeTaskProvider → ConfigurableTaskProviderFamily<AnalyzeTask, AnalyzeConfig>
A riverpod provider for the analyze task.
final
consoleLoggerProvider → ProviderFamily<Logger, LogLevel>
A riverpod provider family for the ConsoleLogger.
final
customLintTaskProvider → TaskProvider<CustomLintTask>
A riverpod provider for the custom-lint task.
final
defaultTasksLoaderProvider → Provider<DefaultTasksLoader>
A riverpod provider for the DefaultTasksLoader.
final
flutterCompatTaskProvider → TaskProvider<FlutterCompatTask>
A riverpod provider for the flutter compatibility task.
final
formatTaskProvider → ConfigurableTaskProviderFamily<FormatTask, FormatConfig>
A riverpod provider for the format task.
final
hooksProvider → ProviderFamily<Hooks, HooksConfig>
A riverpod provider for the Hooks class, configurable with the HooksConfig.
final
loggerProvider → Provider<Logger>
A riverpod provider family for the Logger.
final
osvScannerTaskProvider → ConfigurableTaskProviderFamily<OsvScannerTask, OsvScannerConfig>
A riverpod provider for the osv scanner task.
final
outdatedTaskProvider → ConfigurableTaskProviderFamily<OutdatedTask, OutdatedConfig>
A riverpod provider for the outdated task.
final
pullUpDependenciesTaskProvider → ConfigurableTaskProviderFamily<PullUpDependenciesTask, PullUpDependenciesConfig>
A riverpod provider for the pull up dependencies task.
final
simpleLoggerProvider → ProviderFamily<Logger, LogLevel>
A riverpod provider family for the ConsoleLogger.
final
taskLoaderProvider → Provider<TaskLoader>
A riverpod provider for the TaskLoader
final

Typedefs

ArgFromJson<Arg> = Arg Function(Map<String, dynamic> json)
Typedef for a function that can parse a task configuration.
RegisterTasksCallback = FutureOr<void> Function(TaskLoader taskLoader)
A configuration callback to register custom tasks