feat(dart_frog_dev_server): report rogue routes (#251)

Author: felangel

bricks/dart_frog_dev_server/hooks/pre_gen.dart

@@ -26,6 +26,7 @@ Future<void> preGen(
   }
 
   reportRouteConflicts(context, configuration);
+  reportRogueRoutes(context, configuration);
 
   context.vars = {
     'port': context.vars['port'] ?? '8080',
@@ -62,7 +63,27 @@ void reportRouteConflicts(
         '''Route conflict detected. ${lightCyan.wrap(originalFilePath)} and ${lightCyan.wrap(conflictingFilePath)} both resolve to ${lightCyan.wrap(conflict.key)}.''',
       );
     }
+  }
+}
+
+void reportRogueRoutes(
+  HookContext context,
+  RouteConfiguration configuration,
+) {
+  if (configuration.rogueRoutes.isNotEmpty) {
     context.logger.info('');
+    for (final route in configuration.rogueRoutes) {
+      final filePath = path.normalize(path.join('routes', route.path));
+      final fileDirectory = path.dirname(filePath);
+      final idealPath = path.join(
+        fileDirectory,
+        path.basenameWithoutExtension(filePath),
+        'index.dart',
+      );
+      context.logger.err(
+        '''Rogue route detected.${defaultForeground.wrap(' ')}Rename ${lightCyan.wrap(filePath)} to ${lightCyan.wrap(idealPath)}.''',
+      );
+    }
   }
 }
 

bricks/dart_frog_dev_server/hooks/pubspec.yaml

@@ -5,7 +5,7 @@ environment:
   sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
-  dart_frog_gen: ^0.0.2-dev.6
+  dart_frog_gen: ^0.0.2-dev.7
   mason: ^0.1.0-dev.31
 
 dev_dependencies:

bricks/dart_frog_dev_server/hooks/test/pre_gen_test.dart

@@ -69,6 +69,7 @@ void main() {
         middleware: [],
         directories: [],
         routes: [],
+        rogueRoutes: [],
         endpoints: {},
       );
       final exitCalls = <int>[];
@@ -128,6 +129,7 @@ void main() {
             RouteFile(name: 'hello', path: 'hello.dart', route: '/hello'),
           ]
         },
+        rogueRoutes: [],
         serveStaticFiles: true,
       );
       final exitCalls = <int>[];
@@ -248,6 +250,60 @@ void main() {
     });
   });
 
+  group('reportRogueRoutes', () {
+    late HookContext context;
+    late Logger logger;
+    late RouteConfiguration configuration;
+
+    setUp(() {
+      context = _MockHookContext();
+      logger = _MockLogger();
+      configuration = _MockRouteConfiguration();
+
+      when(() => context.logger).thenReturn(logger);
+    });
+
+    test('reports nothing when there are no rogue routes', () {
+      when(() => configuration.rogueRoutes).thenReturn([]);
+      reportRogueRoutes(context, configuration);
+      verifyNever(() => logger.err(any()));
+    });
+
+    test('reports single rogue route', () {
+      when(() => configuration.rogueRoutes).thenReturn(
+        const [
+          RouteFile(name: 'hello', path: 'hello.dart', route: '/hello'),
+        ],
+      );
+      reportRogueRoutes(context, configuration);
+      verify(
+        () => logger.err(
+          '''Rogue route detected.${defaultForeground.wrap(' ')}Rename ${lightCyan.wrap('routes/hello.dart')} to ${lightCyan.wrap('routes/hello/index.dart')}.''',
+        ),
+      );
+    });
+
+    test('reports multiple rogue routes', () {
+      when(() => configuration.rogueRoutes).thenReturn(
+        const [
+          RouteFile(name: 'hello', path: 'hello.dart', route: '/hello'),
+          RouteFile(name: 'hi', path: 'hi.dart', route: '/hi'),
+        ],
+      );
+      reportRogueRoutes(context, configuration);
+      verify(
+        () => logger.err(
+          '''Rogue route detected.${defaultForeground.wrap(' ')}Rename ${lightCyan.wrap('routes/hello.dart')} to ${lightCyan.wrap('routes/hello/index.dart')}.''',
+        ),
+      );
+      verify(
+        () => logger.err(
+          '''Rogue route detected.${defaultForeground.wrap(' ')}Rename ${lightCyan.wrap('routes/hi.dart')} to ${lightCyan.wrap('routes/hi/index.dart')}.''',
+        ),
+      );
+    });
+  });
+
   group('ExitOverrides', () {
     group('runZoned', () {
       test('uses default exit when not specified', () {