Move hot restart script into a separate package (#94)

Author: passsy

.github/workflows/analyze.yml

@@ -16,6 +16,7 @@ jobs:
     - uses: subosito/flutter-action@v2
       with:
         channel: 'stable'
+    - run: cd hot_restart_timeline && flutter pub get
     - run: flutter analyze --fatal-infos --fatal-warnings
     - run: |
         dart format lib/src/timeline/html/sources/script.js.g.dart

CONTRIBUTING.md

@@ -10,5 +10,5 @@ When building the timeline, you can use the `tool/hot_restart_timeline.dart` scr
 It automatically reloads the HTML when you change any part of the Jaspr code or run the test again.
 
 ```bash
-dart run tool/hot_restart_timeline.dart
+dart run hot_restart_timeline/bin/main.dart
 ```

hot_restart_timeline/.gitignore

@@ -0,0 +1,4 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
+!pubspec.lock

hot_restart_timeline/README.md

@@ -0,0 +1,10 @@
+# Spot Hot-Restart timeline CLI
+
+File watcher, automatically rebuilding the timeline files (in `build/timeline`) when the source files are modified.
+
+
+## Usage
+
+```bash
+dart run bin/main.dart
+```

hot_restart_timeline/analysis_options.yaml

@@ -0,0 +1,27 @@
+# This file configures the analyzer to use the lint rule set from `package:lint`
+
+# include: package:lint/strict.yaml # For production apps
+include: package:lint/casual.yaml # For code samples, hackathons and other non-production code
+# include: package:lint/package.yaml # Use this for packages with public API
+
+
+# You might want to exclude auto-generated files from dart analysis
+analyzer:
+  exclude:
+    #- '**.freezed.dart'
+    #- '**.g.dart'
+
+# You can customize the lint rules set to your own liking. A list of all rules
+# can be found at https://dart-lang.github.io/linter/lints/options/options.html
+linter:
+  rules:
+    # Util classes are awesome!
+    # avoid_classes_with_only_static_members: false
+    
+    # Make constructors the first thing in every class
+    # sort_constructors_first: true
+
+    # Choose wisely, but you don't have to
+    # prefer_double_quotes: true
+    # prefer_single_quotes: true
+    

hot_restart_timeline/bin/main.dart

@@ -0,0 +1,11 @@
+import 'dart:io';
+
+import 'package:hot_restart_timeline/hot_restart_timeline.dart'
+    as hot_restart_timeline;
+
+Future<void> main(List<String> arguments) async {
+  ProcessSignal.sigint.watch().listen((event) {
+    exit(0);
+  });
+  await hot_restart_timeline.main();
+}

tool/hot_restart_timeline.dart renamed to hot_restart_timeline/lib/hot_restart_timeline.dart

@@ -2,15 +2,16 @@
 
 import 'dart:io';
 
-import 'package:server_nano/server_nano.dart';
+import 'package:dartx/dartx_io.dart';
+import 'package:hot_restart_timeline/server.dart';
 
-Future<void> main() async {
-  ProcessSignal.sigint.watch().listen((event) {
-    exit(0);
-  });
+// Platform.script points to bin/main.dart
+final packageRoot = Directory(Platform.script.path).parent.parent;
+final spotPackageRoot = packageRoot.parent;
 
+Future<void> main() async {
   // Watch for changes in lib/ and then call compile_js.dart
-  final libDir = Directory('lib');
+  final libDir = spotPackageRoot.directory('lib');
 
   final spotLibWatcher = libDir.watch(recursive: true);
   spotLibWatcher.listen((event) {
@@ -21,7 +22,7 @@ Future<void> main() async {
     rebuildHtml();
   });
 
-  final timelineHotReloadDir = Directory('build/timeline/');
+  final timelineHotReloadDir = spotPackageRoot.directory('build/timeline/');
   if (!timelineHotReloadDir.existsSync()) {
     timelineHotReloadDir.createSync(recursive: true);
   }
@@ -36,31 +37,8 @@ Future<void> main() async {
   rebuildJs();
   rebuildHtml();
 
-  final server = Server();
-  server.static('build/timeline/');
-  server.get('/', (req, resp) {
-    final timelines = timelineHotReloadDir
-        .listSync(recursive: true)
-        .where((file) => file.path.endsWith('.html'))
-        .map((file) {
-      final relative = file.path.split('build/timeline/').last;
-      return '<li><a href="/$relative">$relative</a></li>\n';
-    }).join('\n');
-    resp.sendHtmlText(
-      '<h1>Spot timelines</h1>\n\n'
-      '<ul>\n$timelines</ul>',
-    );
-  });
-
-  server.listen(port: 5907);
-  final timelineFiles = timelineHotReloadDir.listSync(recursive: true);
-  for (final file in timelineFiles) {
-    if (!file.path.endsWith('.html')) {
-      continue;
-    }
-    final relative = file.path.split('build/timeline/').last;
-    print('http://localhost:5907/$relative');
-  }
+  startServer(timelineHotReloadDir);
+  print('http://localhost:5907/');
 }
 
 bool _rebuildingJs = false;
@@ -79,7 +57,11 @@ Future<void> rebuildJs() async {
   final timestamp = DateTime.now().toIso8601String().substring(11, 19);
   print('$timestamp Recompiling...');
   try {
-    final result = await Process.run(dartExecutable, ['tool/compile_js.dart']);
+    final result = await Process.run(
+      dartExecutable,
+      ['tool/compile_js.dart'],
+      workingDirectory: spotPackageRoot.path,
+    );
     if (result.exitCode != 0) {
       print('Compilation failed');
       print(result.stdout);
@@ -110,7 +92,11 @@ Future<void> rebuildHtml() async {
   // start a new process so that it picks up the changes in the jaspr code
   final stopwatch = Stopwatch()..start();
   try {
-    final result = await Process.run(dartExecutable, ['tool/render_html.dart']);
+    final result = await Process.run(
+      dartExecutable,
+      ['tool/render_html.dart'],
+      workingDirectory: packageRoot.path,
+    );
     if (result.exitCode != 0) {
       print('Render failed');
       print(result.stdout);

hot_restart_timeline/lib/server.dart

@@ -0,0 +1,25 @@
+import 'dart:io';
+
+import 'package:dartx/dartx_io.dart';
+import 'package:hot_restart_timeline/hot_restart_timeline.dart';
+import 'package:server_nano/server_nano.dart';
+
+void startServer(Directory timelineHotReloadDir) {
+  final server = Server();
+  server.static(spotPackageRoot.directory('build/timeline/').path);
+  server.get('/', (req, resp) {
+    final timelines = timelineHotReloadDir
+        .listSync(recursive: true)
+        .where((file) => file.path.endsWith('.html'))
+        .map((file) {
+      final relative = file.path.split('build/timeline/').last;
+      return '<li><a href="/$relative">$relative</a></li>\n';
+    }).join('\n');
+    resp.sendHtmlText(
+      '<h1>Spot timelines</h1>\n\n'
+      '<ul>\n$timelines</ul>',
+    );
+  });
+
+  server.listen(port: 5907);
+}

hot_restart_timeline/pubspec.lock

@@ -0,0 +1,18 @@
+name: hot_restart_timeline
+description: A webserver which automatically reloads the timelines of spot on code changes
+version: 1.0.0
+publish_to: none
+
+environment:
+  sdk: ^3.0.0
+
+dependencies:
+  dartx: ^1.1.0
+  path: ^1.9.0
+  server_nano: ^1.5.1
+
+dev_dependencies:
+  lint: ^2.3.0
+  spot:
+    path: ../
+  test: ^1.24.0

hot_restart_timeline/pubspec.yaml

@@ -7,8 +7,14 @@ import 'package:path/path.dart' as path;
 import 'package:spot/src/timeline/html/render_timeline.dart';
 import 'package:spot/src/timeline/html/web/timeline_event.dart';
 
+// Platform.script points to tool/render_html.dart
+final packageRoot = Directory(Platform.script.path).parent.parent;
+final spotPackageRoot = packageRoot.parent;
+
+/// Renders the timeline HTML files to be served by the server
 Future<void> main() async {
-  final globalTimelineDir = Directory('build').directory('timeline');
+  final globalTimelineDir =
+      spotPackageRoot.directory('build').directory('timeline');
   if (!globalTimelineDir.existsSync()) {
     return;
   }

tool/render_html.dart renamed to hot_restart_timeline/tool/render_html.dart

@@ -105,7 +105,7 @@ extension HtmlTimelinePrinter on Timeline {
 bool? _isTimelineHotRestartServerRunningCached;
 
 /// Check if the Timeline Hot-Restart Server is running located at
-/// `tool/hot_restart_timeline.dart`
+/// `hot_restart_timeline/bin/main.dart`
 ///
 /// This method is heavily cached because it might be executed for every tests
 /// and it only is required for development.

lib/src/timeline/html/print_html.dart

@@ -30,11 +30,6 @@ dev_dependencies:
   lint: ^2.1.0
   test: ^1.24.0
   test_process: ^2.1.0
-  server_nano: ^1.5.1
-
-dependency_overrides:
-  path: '>=1.8.0 <=1.9.0'
-  mime: 1.0.4
 
 flutter:
   assets: