feat: removing external dependencies checking from dev brick (#927)

Author: erickzanardo

bricks/dart_frog_dev_server/hooks/pre_gen.dart

@@ -17,12 +17,9 @@ Future<void> run(HookContext context) async => preGen(context);
 
 Future<void> preGen(
   HookContext context, {
-  io.Directory? directory,
   RouteConfigurationBuilder buildConfiguration = buildRouteConfiguration,
   void Function(int exitCode) exit = _defaultExit,
 }) async {
-  final projectDirectory = directory ?? io.Directory.current;
-
   final RouteConfiguration configuration;
   try {
     configuration = buildConfiguration(io.Directory.current);
@@ -57,18 +54,6 @@ Future<void> preGen(
       );
     },
   );
-  await reportExternalPathDependencies(
-    projectDirectory,
-    onViolationStart: () {
-      context.logger
-        ..info('')
-        ..err('All path dependencies must be within the project.')
-        ..err('External path dependencies detected:');
-    },
-    onExternalPathDependency: (dependencyName, dependencyPath) {
-      context.logger.err('  \u{2022} $dependencyName from $dependencyPath');
-    },
-  );
 
   context.vars = {
     'port': context.vars['port'] ?? '8080',

bricks/dart_frog_dev_server/hooks/test/pre_gen_test.dart

@@ -1,9 +1,6 @@
-import 'dart:io';
-
 import 'package:dart_frog_gen/dart_frog_gen.dart';
 import 'package:mason/mason.dart';
 import 'package:mocktail/mocktail.dart';
-import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 
 import '../pre_gen.dart';
@@ -90,8 +87,8 @@ void main() {
               route: '/',
               params: [],
               wildcard: false,
-            )
-          ]
+            ),
+          ],
         },
       );
 
@@ -142,53 +139,6 @@ void main() {
       expect(exitCalls, isEmpty);
     });
 
-    test('complains about r external dependencies', () async {
-      const configuration = RouteConfiguration(
-        middleware: [],
-        directories: [],
-        routes: [],
-        rogueRoutes: [],
-        endpoints: {},
-      );
-
-      final directory = Directory.systemTemp.createTempSync();
-      File(path.join(directory.path, 'pubspec.yaml')).writeAsStringSync(
-        '''
-name: example
-version: 0.1.0
-environment:
-  sdk: ^2.17.0
-dependencies:
-  mason: any
-  foo:
-    path: ../../foo
-dev_dependencies:
-  test: any
-''',
-      );
-
-      final exitCalls = <int>[];
-      await preGen(
-        context,
-        buildConfiguration: (_) => configuration,
-        exit: exitCalls.add,
-        directory: directory,
-      );
-
-      verify(
-        () => logger.err('All path dependencies must be within the project.'),
-      ).called(1);
-      verify(
-        () => logger.err('External path dependencies detected:'),
-      ).called(1);
-      verify(
-        () => logger.err('  \u{2022} foo from ../../foo'),
-      ).called(1);
-      expect(exitCalls, isEmpty);
-
-      directory.delete(recursive: true).ignore();
-    });
-
     test('retains custom port if specified', () async {
       const customPort = '8081';
       context.vars['port'] = customPort;
@@ -209,16 +159,18 @@ dev_dependencies:
       verifyNever(() => logger.err(any()));
       expect(
         context.vars,
-        equals({
-          'port': customPort,
-          'directories': <RouteDirectory>[],
-          'routes': <RouteFile>[],
-          'middleware': <MiddlewareFile>[],
-          'globalMiddleware': false,
-          'serveStaticFiles': false,
-          'invokeCustomEntrypoint': false,
-          'invokeCustomInit': false
-        }),
+        equals(
+          {
+            'port': customPort,
+            'directories': <RouteDirectory>[],
+            'routes': <RouteFile>[],
+            'middleware': <MiddlewareFile>[],
+            'globalMiddleware': false,
+            'serveStaticFiles': false,
+            'invokeCustomEntrypoint': false,
+            'invokeCustomInit': false,
+          },
+        ),
       );
     });
 
@@ -243,16 +195,18 @@ dev_dependencies:
       verifyNever(() => logger.err(any()));
       expect(
         context.vars,
-        equals({
-          'port': customPort,
-          'directories': <RouteDirectory>[],
-          'routes': <RouteFile>[],
-          'middleware': <MiddlewareFile>[],
-          'globalMiddleware': false,
-          'serveStaticFiles': false,
-          'invokeCustomEntrypoint': true,
-          'invokeCustomInit': false
-        }),
+        equals(
+          {
+            'port': customPort,
+            'directories': <RouteDirectory>[],
+            'routes': <RouteFile>[],
+            'middleware': <MiddlewareFile>[],
+            'globalMiddleware': false,
+            'serveStaticFiles': false,
+            'invokeCustomEntrypoint': true,
+            'invokeCustomInit': false,
+          },
+        ),
       );
     });
 
@@ -277,16 +231,18 @@ dev_dependencies:
       verifyNever(() => logger.err(any()));
       expect(
         context.vars,
-        equals({
-          'port': customPort,
-          'directories': <RouteDirectory>[],
-          'routes': <RouteFile>[],
-          'middleware': <MiddlewareFile>[],
-          'globalMiddleware': false,
-          'serveStaticFiles': false,
-          'invokeCustomEntrypoint': false,
-          'invokeCustomInit': true
-        }),
+        equals(
+          {
+            'port': customPort,
+            'directories': <RouteDirectory>[],
+            'routes': <RouteFile>[],
+            'middleware': <MiddlewareFile>[],
+            'globalMiddleware': false,
+            'serveStaticFiles': false,
+            'invokeCustomEntrypoint': false,
+            'invokeCustomInit': true,
+          },
+        ),
       );
     });
 
@@ -301,7 +257,7 @@ dev_dependencies:
           MiddlewareFile(
             name: 'hello_middleware',
             path: 'hello/middleware.dart',
-          )
+          ),
         ],
         directories: [
           RouteDirectory(
@@ -325,7 +281,7 @@ dev_dependencies:
               ),
             ],
             params: [],
-          )
+          ),
         ],
         routes: [
           RouteFile(
@@ -361,7 +317,7 @@ dev_dependencies:
               params: [],
               wildcard: false,
             ),
-          ]
+          ],
         },
         rogueRoutes: [],
         serveStaticFiles: true,
@@ -376,56 +332,64 @@ dev_dependencies:
       verifyNever(() => logger.err(any()));
       expect(
         context.vars,
-        equals({
-          'port': '8080',
-          'directories': [
-            {
-              'name': '_',
-              'route': '/',
-              'middleware': <Map<String, dynamic>>[],
-              'files': [
-                {
-                  'name': 'index',
-                  'path': 'index.dart',
-                  'route': '/',
-                  'file_params': <String>[],
-                  'wildcard': false,
-                },
-                {
-                  'name': 'hello',
-                  'path': 'hello.dart',
-                  'route': '/hello',
-                  'file_params': <String>[],
-                  'wildcard': false,
-                }
-              ],
-              'directory_params': <String>[],
-            }
-          ],
-          'routes': [
-            {
-              'name': 'index',
-              'path': 'index.dart',
-              'route': '/',
-              'file_params': const <String>[],
-              'wildcard': false,
+        equals(
+          {
+            'port': '8080',
+            'directories': [
+              {
+                'name': '_',
+                'route': '/',
+                'middleware': <Map<String, dynamic>>[],
+                'files': [
+                  {
+                    'name': 'index',
+                    'path': 'index.dart',
+                    'route': '/',
+                    'file_params': <String>[],
+                    'wildcard': false,
+                  },
+                  {
+                    'name': 'hello',
+                    'path': 'hello.dart',
+                    'route': '/hello',
+                    'file_params': <String>[],
+                    'wildcard': false,
+                  }
+                ],
+                'directory_params': <String>[],
+              }
+            ],
+            'routes': [
+              {
+                'name': 'index',
+                'path': 'index.dart',
+                'route': '/',
+                'file_params': const <String>[],
+                'wildcard': false,
+              },
+              {
+                'name': 'hello',
+                'path': 'hello.dart',
+                'route': '/hello',
+                'file_params': const <String>[],
+                'wildcard': false,
+              }
+            ],
+            'middleware': [
+              {
+                'name': 'hello_middleware',
+                'path': 'hello/middleware.dart',
+              },
+            ],
+            'globalMiddleware': {
+              'name': 'middleware',
+              'path': 'middleware.dart',
             },
-            {
-              'name': 'hello',
-              'path': 'hello.dart',
-              'route': '/hello',
-              'file_params': const <String>[],
-              'wildcard': false,
-            }
-          ],
-          'middleware': [
-            {'name': 'hello_middleware', 'path': 'hello/middleware.dart'}
-          ],
-          'globalMiddleware': {'name': 'middleware', 'path': 'middleware.dart'},
-          'serveStaticFiles': true,
-          'invokeCustomEntrypoint': false,
-          'invokeCustomInit': false
-        }),
+            'serveStaticFiles': true,
+            'invokeCustomEntrypoint': false,
+            'invokeCustomInit': false,
+          },
+        ),
       );
     });
   });