dart_frog_gen library

Code generation tooling for package:dart_frog

Classes

MiddlewareFile: A class containing metadata regarding a route directory.
RouteConfiguration: An object containing all route configuration metadata required to generate a dart frog server.
RouteDirectory: A class containing metadata regarding a route directory.
RouteFile: A class containing metadata regarding a route file.

RouteStringX on String: Extension on String with helper methods regarding Dart Frog routes.

buildRouteConfiguration(Directory directory) → RouteConfiguration: Build a RouteConfiguration based on the provided root project directory.
reportRogueRoutes(RouteConfiguration configuration, {void onViolationStart()?, OnRogueRoute? onRogueRoute, void onViolationEnd()?}) → void: Reports existence of rogue routes on a RouteConfiguration.
reportRouteConflicts(RouteConfiguration configuration, {void onViolationStart()?, OnRouteConflict? onRouteConflict, void onViolationEnd()?}) → void: Reports existence of route conflicts on a RouteConfiguration.

OnRogueRoute = void Function(String filePath, String idealPath): Type definition for callbacks that report rogue routes.
OnRouteConflict = void Function(String originalFilePath, String conflictingFilePath, String conflictingEndpoint): Type definition for callbacks that report route conflicts.