Don't start debug mode by default

Author: rrousselGit

README.md

@@ -25,7 +25,7 @@
   - [Using our custom lint package in an application](#using-our-custom-lint-package-in-an-application)
   - [Enabling/disabling and configuring lints](#enablingdisabling-and-configuring-lints)
   - [Obtaining the list of lints in the CI](#obtaining-the-list-of-lints-in-the-ci)
-  - [Using the Dart debugger](#using-the-dart-debugger)
+  - [Using the Dart debugger and enabling hot-reload](#using-the-dart-debugger-and-enabling-hot-reload)
   - [Testing your plugins](#testing-your-plugins)
     - [Testing lints](#testing-lints)
     - [Testing quick fixes and assists](#testing-quick-fixes-and-assists)
@@ -238,9 +238,26 @@ $ dart run custom_lint
 
 If you are working on a Flutter project, run `flutter pub run custom_lint` instead.
 
-### Using the Dart debugger
+### Using the Dart debugger and enabling hot-reload
 
-To debug plugins in custom_lint, you need to connect to plugins using "attach"
+By default, custom_lint does enable hot-reload or give you the necessary
+information to start the debugger. This is because most users don't need those,
+and only lint authors do.
+
+If you wish to debug lints, you'll have to update your `analysis_options.yaml` as followed:
+
+```yaml
+analyzer:
+  plugins:
+    - custom_lint
+
+custom_lint:
+  debug: true
+  # Optional, will cause custom_lint to log its internal debug information
+  verbose: true
+```
+
+Then, to debug plugins in custom_lint, you need to connect to plugins using "attach"
 mode in your IDE (`cmd+shift+p` + `Debug: attach to Dart process` in VSCode).
 
 When using this command, you will need a VM service URI provided by custom_lint.

packages/custom_lint/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Unreleased patch
 
 - Fixed Unimplemented error when running `pub get`.
+- Hot-reload and debug mode is now disabled by default.
 
 ## 0.6.2 - 2024-02-19
 

packages/custom_lint/lib/src/analyzer_plugin_starter.dart

@@ -20,7 +20,7 @@ void start(Iterable<String> _, SendPort sendPort) {
     // enable watch mode. There's no way to detect this, but this only matters
     // in the CI. So we disable watch mode if we detect that we're in CI.
     // TODO enable hot-restart only if running plugin from source (excluding pub cache)
-    watchMode: !isInCI,
+    watchMode: isInCI ? false : null,
     delegate: AnalyzerPluginCustomLintDelegate(),
     workingDirectory: Directory.current,
   );

packages/custom_lint/lib/src/v2/custom_lint_analyzer_plugin.dart

@@ -2,13 +2,17 @@ import 'dart:async';
 import 'dart:io';
 import 'dart:isolate';
 
+import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer_plugin/protocol/protocol.dart';
 import 'package:analyzer_plugin/protocol/protocol_constants.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart';
 // ignore: implementation_imports
 import 'package:analyzer_plugin/src/protocol/protocol_internal.dart'
     show ResponseResult;
 import 'package:async/async.dart';
+import 'package:custom_lint_core/custom_lint_core.dart';
+import 'package:package_config/package_config.dart';
+import 'package:path/path.dart' as p;
 import 'package:pub_semver/pub_semver.dart';
 import 'package:rxdart/rxdart.dart';
 import 'package:uuid/uuid.dart';
@@ -37,7 +41,7 @@ class CustomLintServer {
   /// errors and prints continue to be captured.
   static Future<CustomLintServer> start({
     required SendPort sendPort,
-    required bool watchMode,
+    required bool? watchMode,
     required bool includeBuiltInLints,
     required bool fix,
     required CustomLintDelegate delegate,
@@ -97,7 +101,7 @@ class CustomLintServer {
   late final AnalyzerPluginClientChannel _analyzerPluginClientChannel;
 
   /// Whether plugins should be started in watch mode
-  final bool watchMode;
+  final bool? watchMode;
 
   /// If enabled, attempt to fix all issues found before reporting them.
   /// Can only be enabled in the CLI.
@@ -368,7 +372,26 @@ class CustomLintServer {
     _clientChannelEventsSubscription = clientChannel.events.listen(
       _handleEvent,
     );
-    await clientChannel.init();
+
+    final configs = await Future.wait(
+      parameters.roots.map(
+        (e) async {
+          final packageConfig = await findPackageConfig(Directory(e.root));
+          if (packageConfig == null) return null;
+
+          return CustomLintConfigs.parse(
+            PhysicalResourceProvider.INSTANCE.getFile(
+              p.join(e.root, 'analysis_options.yaml'),
+            ),
+            packageConfig,
+          );
+        },
+      ),
+    );
+
+    await clientChannel.init(
+      debug: configs.any((e) => e != null && e.debug),
+    );
   }
 
   Future<void> _handleEvent(CustomLintEvent event) => _runner.run(() async {

packages/custom_lint/lib/src/v2/server_to_client_channel.dart

@@ -106,23 +106,13 @@ class SocketCustomLintServerToClientChannel {
   }
 
   /// Initializes and waits for the client to start
-  Future<void> init() async {
-    _processFuture = _startProcess();
+  Future<void> init({required bool debug}) async {
+    _processFuture = _startProcess(debug: debug);
     final process = await _processFuture;
     // No process started, likely because no plugin were detected. We can stop here.
     if (process == null) return;
 
-    var out = process.stdout.map(utf8.decode);
-    // Let's not log the VM service prints unless in watch mode
-    if (!_server.watchMode) {
-      out = out.skipWhile(
-        (element) =>
-            element.startsWith('The Dart VM service is listening on') ||
-            element.startsWith(
-              'The Dart DevTools debugger and profiler is available at:',
-            ),
-      );
-    }
+    final out = process.stdout.map(utf8.decode);
 
     out.listen((event) => _server.handlePrint(event, isClientMessage: true));
     process.stderr
@@ -151,7 +141,9 @@ class SocketCustomLintServerToClientChannel {
   /// without setting up the connection.
   ///
   /// Will throw if the process fails to start.
-  Future<Process?> _startProcess() async {
+  Future<Process?> _startProcess({
+    required bool debug,
+  }) async {
     final tempDir = _tempDirectory =
         Directory.systemTemp.createTempSync('custom_lint_client');
 
@@ -163,7 +155,7 @@ class SocketCustomLintServerToClientChannel {
         final process = await Process.start(
           Platform.resolvedExecutable,
           [
-            if (_server.watchMode) '--enable-vm-service=0',
+            if (_server.watchMode ?? debug) '--enable-vm-service=0',
             join('lib', 'custom_lint_client.dart'),
             _serverSocket.address.host,
             _serverSocket.port.toString(),

packages/custom_lint/pubspec.yaml

@@ -15,6 +15,7 @@ dependencies:
   ci: ^0.1.0
   cli_util: ^0.4.0
   collection: ^1.16.0
+  custom_lint_core: 0.6.2
   freezed_annotation: ^2.2.0
   json_annotation: ^4.7.0
   meta: ^1.7.0

packages/custom_lint/tools/analyzer_plugin/pubspec.yaml

@@ -8,7 +8,6 @@ environment:
 
 dependencies:
   custom_lint: 0.6.2
-
 # TODO: If you want to contribute to custom_lint, add a pubspec_overrides.yaml file
 # in this folder, containing the following:
 # dependency_overrides:

packages/custom_lint_core/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased patch
+
+- Parses `debug`/`config` flags
+
 ## 0.6.2 - 2024-02-19
 
 - Fix null exception when using `TypeChecker.isSuperTypeOf` (thanks to @charlescyt)

packages/custom_lint_core/lib/src/configs.dart

@@ -14,11 +14,12 @@ class CustomLintConfigs {
   @internal
   const CustomLintConfigs({
     required this.enableAllLintRules,
+    required this.verbose,
+    required this.debug,
     required this.rules,
   });
 
   /// Decode a [CustomLintConfigs] from a file.
-  @internal
   factory CustomLintConfigs.parse(
     File? analysisOptionsFile,
     PackageConfig packageConfig,
@@ -67,9 +68,15 @@ class CustomLintConfigs {
 
     final rules = <String, LintOptions>{...includedOptions.rules};
     final enableAllLintRulesYaml = customLint['enable_all_lint_rules'];
-    final enableAllLintRules = enableAllLintRulesYaml is bool?
-        ? enableAllLintRulesYaml ?? includedOptions.enableAllLintRules
-        : null;
+    final enableAllLintRules = enableAllLintRulesYaml is bool
+        ? enableAllLintRulesYaml
+        : includedOptions.enableAllLintRules;
+
+    final debugYaml = customLint['debug'];
+    final debug = debugYaml is bool ? debugYaml : includedOptions.debug;
+
+    final verboseYaml = customLint['verbose'];
+    final verbose = verboseYaml is bool ? verboseYaml : includedOptions.verbose;
 
     final rulesYaml = customLint['rules'] as Object?;
 
@@ -103,6 +110,8 @@ class CustomLintConfigs {
 
     return CustomLintConfigs(
       enableAllLintRules: enableAllLintRules,
+      verbose: verbose,
+      debug: debug,
       rules: UnmodifiableMapView(rules),
     );
   }
@@ -111,6 +120,8 @@ class CustomLintConfigs {
   @internal
   static const empty = CustomLintConfigs(
     enableAllLintRules: null,
+    verbose: false,
+    debug: false,
     rules: {},
   );
 
@@ -130,15 +141,25 @@ class CustomLintConfigs {
   /// along with extra per-lint configuration.
   final Map<String, LintOptions> rules;
 
+  /// Whether to enable verbose logging.
+  final bool verbose;
+
+  /// Whether enable hot-reload and log the VM-service URI.
+  final bool debug;
+
   @override
   bool operator ==(Object other) =>
       other is CustomLintConfigs &&
       other.enableAllLintRules == enableAllLintRules &&
+      other.verbose == verbose &&
+      other.debug == debug &&
       const MapEquality<String, LintOptions>().equals(other.rules, rules);
 
   @override
   int get hashCode => Object.hash(
         enableAllLintRules,
+        verbose,
+        debug,
         const MapEquality<String, LintOptions>().hash(rules),
       );
 }