Fuse all plugins (#58)

Author: rrousselGit

Diff for: .github/workflows/build.yml

@@ -47,7 +47,7 @@ jobs:
         run: flutter format --set-exit-if-changed .
 
       - name: Analyze
-        run: flutter analyze
+        run: dart analyze
 
       # - name: Run tests
       #   run: melos exec --dir-exists=test "dart test"

Diff for: .gitignore

@@ -6,7 +6,9 @@ pubspec.lock
 # Ignoring generated files, as they pollute pull requests and can create merge conflicts
 *.g.dart
 *.freezed.dart
+# Including generated files from the lib folders, as these should be published on pub
 !packages/*/lib/**/*.freezed.dart
+!packages/*/lib/**/*.g.dart
 
 # Ignoring native folders of the example as they can be re-generated easily
 **/example/android/

Diff for: README.md

@@ -24,7 +24,7 @@
   - [Creating a custom lint package](#creating-a-custom-lint-package)
   - [Using our custom lint package in an application](#using-our-custom-lint-package-in-an-application)
   - [Obtaining the list of lints in the CI](#obtaining-the-list-of-lints-in-the-ci)
-  - [Using the Dart debugger and enabling hot-restart.](#using-the-dart-debugger-and-enabling-hot-restart)
+  - [Using the Dart debugger](#using-the-dart-debugger)
   - [Testing your plugins using expect\_lint](#testing-your-plugins-using-expect_lint)
 - [FAQs](#faqs)
   - [Q. How do I get all the classes present in my source code?](#q-how-do-i-get-all-the-classes-present-in-my-source-code)
@@ -98,9 +98,7 @@ To create a custom lint, you will need two things:
 
   ```dart
   // This is the entrypoint of our custom linter
-  void main(List<String> args, SendPort sendPort) {
-    startPlugin(sendPort, _ExampleLinter());
-  }
+  MyPlugin createPlugin() => MyPlugin();
 
   // This class is the one that will analyze Dart files and return lints
   class _ExampleLinter extends PluginBase {
@@ -169,39 +167,30 @@ $ dart run custom_lint
 
 If you are working on a Flutter project, run `flutter pub run custom_lint` instead.
 
-### Using the Dart debugger and enabling hot-restart.
-
-To enable hot-restart and use the Dart debugger, we'll want to start plugins in a
-slightly different way.
-
-First, create a `tools/custom_lint_debug.dart` file next to `tools/custom_lint.dart`
-with the following content:
-
-```dart
-import 'dart:io';
-import 'package:custom_lint/basic_runner.dart';
-
-void main() {
-  await customLint(workingDirectory: Directory.current.parent);
-}
+### Using the Dart debugger
 
-```
+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).
 
-Now you can run/test the custom lints packages you are using via:
+When using this command, you will need a VM service URI provided by custom_lint.
 
-- Starting this main from your IDE (such as clicking on `debug` in VScode).
-  This will connect your IDE to the Dart debugger, allowing the usage of breakpoints.
+There are two possible ways to obtain one:
 
-- From the command line with `dart --enable-vm-service path/to/custom_lint_debug.dart`  
-  The Dart debugger will not be enabled, but hot-reload still will be enabled.
-  Changing the source of your plugin would automatically show the update.
+- if you started your plugin using `custom_lint --watch`, it should be visible
+  in the console output.
+- if your plugin is started by your IDE, you can open the `custom_lint.log` file
+  that custom_lint created next to the `pubspec.yaml` of your analyzed projects.
 
-**I have the following error when I run the program in my IDE: `Bad state: VM service not available! You need to run dart with --enable-vm-service.`**
+In both cases, what you're looking for is logs similar to:
 
-Chances are you didn't start your program in debug mode.  
-If using VScode, when starting your program, make sure to click on `debug` not `run`:
+```
+The Dart VM service is listening on http://127.0.0.1:60671/9DS43lRMY90=/
+The Dart DevTools debugger and profiler is available at: http://127.0.0.1:60671/9DS43lRMY90=/devtools/#/?uri=ws%3A%2F%2F127.0.0.1%3A60671%2F9DS43lRMY90%3D%2Fws
+```
 
-![VScode's debug button](https://raw.githubusercontent.com/invertase/dart_custom_lint/main/resources/vscode_debug.jpg)
+What you'll want is the first URI. In this example, that is `http://127.0.0.1:60671/9DS43lRMY90=/`.
+You can then pass this to your IDE, which should now be able to attach to the
+plugin.
 
 ### Testing your plugins using expect_lint
 

Diff for: analysis_options.yaml

@@ -3,9 +3,10 @@ analyzer:
   exclude:
     - "**/*.g.dart"
     - "**/*.freezed.dart"
-  strong-mode:
-    implicit-casts: false
-    implicit-dynamic: false
+  language:
+    strict-casts: true
+    strict-inference: true
+    strict-raw-types: true
   errors:
     # Otherwise cause the import of all_lint_rules to warn because of some rules conflicts.
     # We explicitly enabled even conflicting rules and are fixing the conflict
@@ -16,6 +17,8 @@ analyzer:
 
 linter:
   rules:
+    public_member_api_docs: false
+
     # temporarily disabled
     require_trailing_commas: false
 

Diff for: packages/custom_lint/CHANGELOG.md

@@ -1,3 +1,28 @@
+## Unreleased major
+
+- **Breaking**: The plugin entrypoint has moved.  
+  Plugins no-longer should define a `/bin/custom_lint.dart` file.
+  Instead they should define a `/lib/<my_package_name>.dart`
+
+- **Breaking**: The plugin entrypoint is modified. Plugins no-longer
+  define a "main", but instead define a `createPlugin` function:
+
+  Before:
+
+  ```dart
+  // /bin/custom_lint.dart
+  void main(List<String> args, SendPort sendPort) {
+    startPlugin(sendPort, MyPlugin());
+  }
+  ```
+
+  After:
+
+  ```dart
+  // /lib/<my_package_name.dart
+  MyPlugin createPlugin() => MyPlugin();
+  ```
+
 ## 0.0.16
 
 Fix `expect_lint` not working if the file doesn't contain any lint.

Diff for: packages/custom_lint/bin/custom_lint.dart

@@ -2,9 +2,9 @@ import 'dart:async';
 import 'dart:io';
 
 import 'package:args/args.dart';
-import 'package:custom_lint/basic_runner.dart';
+import 'package:custom_lint/custom_lint.dart';
 
-Future<void> main([List<String> args = const []]) async {
+Future<void> entrypoint([List<String> args = const []]) async {
   final parser = ArgParser()
     ..addFlag(
       'watch',
@@ -30,3 +30,9 @@ Future<void> main([List<String> args = const []]) async {
 
   await customLint(workingDirectory: Directory.current, watchMode: watchMode);
 }
+
+void main([List<String> args = const []]) async {
+  await entrypoint(args);
+  // TODO figure out why this exit is necessary
+  exit(exitCode);
+}

Diff for: packages/custom_lint/example/example_lint/analysis_options.yaml

@@ -1,6 +1,6 @@
-include: ../analysis_options.yaml
+# include: ../analysis_options.yaml
 
-linter:
-  rules:
-    public_member_api_docs: false
-    avoid_print: false
+# linter:
+#   rules:
+#     public_member_api_docs: false
+#     avoid_print: false

Diff for: packages/custom_lint_builder/example/example_lint/bin/custom_lint.dart renamed to packages/custom_lint/example/example_lint/lib/custom_lint_example_lint.dart

@@ -1,5 +1,3 @@
-import 'dart:isolate';
-
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
@@ -19,15 +17,13 @@ bool _isProvider(DartType type) {
   return isProviderBase || element.allSupertypes.any(_isProvider);
 }
 
-void main(List<String> args, SendPort sendPort) {
-  startPlugin(sendPort, _RiverpodLint());
-}
+PluginBase createPlugin() => _RiverpodLint();
 
 class _RiverpodLint extends PluginBase {
   @override
   Stream<Lint> getLints(ResolvedUnitResult resolvedUnitResult) async* {
     final library = resolvedUnitResult.libraryElement;
-    print('This is a print');
+    print('This is a print3');
     final providers = library.topLevelElements
         .whereType<VariableElement>()
         .where((e) => !e.isFinal)

Diff for: packages/custom_lint/example/example_lint/tools/custom_lint_debug.dart

@@ -1,5 +1,5 @@
 import 'dart:io';
-import 'package:custom_lint/basic_runner.dart';
+import 'package:custom_lint/custom_lint.dart';
 
 Future<void> main() async {
   await customLint(workingDirectory: Directory.current.parent);

Diff for: packages/custom_lint/lib/basic_runner.dart

@@ -1,183 +1,4 @@
-import 'dart:async';
-import 'dart:convert';
-import 'dart:io';
+@Deprecated('Import `package:custom_lint/custom_lint.dart` instead')
+library basic_runner;
 
-import 'package:analyzer_plugin/protocol/protocol_generated.dart';
-import 'package:path/path.dart' as p;
-
-import 'src/analyzer_plugin/analyzer_plugin.dart';
-import 'src/analyzer_plugin/plugin_delegate.dart';
-import 'src/protocol/internal_protocol.dart';
-import 'src/runner.dart';
-
-const _help = '''
-
-Custom lint runner commands:
-r: Force re-lint
-q: Quit
-
-''';
-
-/// Runs plugins with custom_lint.dart on the given directory
-///
-/// In watch mode:
-/// * This will run until the user types q to quit
-/// * The plugin will hot-reload when the user changes it's code, and will cause a re-lint
-/// * The exit code is the one from the last lint before quitting
-/// * The user can force a reload by typing r
-///
-/// Otherwise:
-/// * There is no hot-reload or watching so linting only happens once
-/// * The process exits with the most recent result of the linter
-///
-/// Watch mode cannot be enabled if in release mode.
-Future<void> customLint({
-  bool watchMode = true,
-  required Directory workingDirectory,
-}) async {
-  await runZonedGuarded(() async {
-    final runner = CustomLintRunner(
-      CustomLintPlugin(
-        delegate: CommandCustomLintDelegate(),
-        includeBuiltInLints: false,
-        watchMode: watchMode,
-      ),
-      workingDirectory,
-    );
-
-    runner.channel
-      ..responseErrors.listen((event) => exitCode = -1)
-      ..pluginErrors.listen((event) => exitCode = -1)
-      ..notifications.listen((event) async {
-        if (watchMode) {
-          switch (event.event) {
-            case PrintNotification.key:
-              final notification = PrintNotification.fromNotification(event);
-              stdout.writeln(notification.message);
-              break;
-            case DidHotReloadNotification.key:
-              stdout.writeln(
-                'Did hot-reload the sources of a plugin.\nRecomputing lints...',
-              );
-              await _runPlugins(runner, reload: true);
-              stdout.writeln(_help);
-              break;
-          }
-        }
-      });
-
-    try {
-      await runner.initialize();
-      await _runPlugins(runner, reload: false);
-
-      if (watchMode) {
-        await _startWatchMode(runner);
-      }
-    } finally {
-      await runner.close();
-    }
-  }, (err, stack) {
-    exitCode = -1;
-    stderr.writeln('$err\n$stack');
-  });
-}
-
-Future<void> _runPlugins(
-  CustomLintRunner runner, {
-  required bool reload,
-}) async {
-  // Reset the code
-  exitCode = 0;
-
-  try {
-    final lints = await runner.getLints(reload: reload);
-
-    if (lints.any((lintsForFile) => lintsForFile.errors.isNotEmpty)) {
-      exitCode = -1;
-    }
-
-    _renderLints(lints, workingDirectory: runner.workingDirectory);
-  } catch (err, stack) {
-    exitCode = -1;
-    stderr.writeln('$err\n$stack');
-  }
-
-  // Since no problem happened, we print a message saying everything went well
-  if (exitCode == 0) {
-    stdout.writeln('No issues found!');
-  }
-}
-
-void _renderLints(
-  List<AnalysisErrorsParams> lints, {
-  required Directory workingDirectory,
-}) {
-  lints.sort(
-    (a, b) => a
-        .relativeFilePath(workingDirectory)
-        .compareTo(b.relativeFilePath(workingDirectory)),
-  );
-
-  for (final lintsForFile in lints) {
-    final relativeFilePath = lintsForFile.relativeFilePath(workingDirectory);
-
-    lintsForFile.errors.sort((a, b) {
-      final lineCompare = a.location.startLine.compareTo(b.location.startLine);
-      if (lineCompare != 0) return lineCompare;
-      final columnCompare =
-          a.location.startColumn.compareTo(b.location.startColumn);
-      if (columnCompare != 0) return columnCompare;
-
-      final codeCompare = a.code.compareTo(b.code);
-      if (codeCompare != 0) return codeCompare;
-
-      return a.message.compareTo(b.message);
-    });
-
-    for (final lint in lintsForFile.errors) {
-      exitCode = -1;
-      stdout.writeln(
-        '  $relativeFilePath:${lint.location.startLine}:${lint.location.startColumn}'
-        ' • ${lint.message} • ${lint.code}',
-      );
-    }
-  }
-}
-
-Future<void> _startWatchMode(CustomLintRunner runner) async {
-  if (stdin.hasTerminal) {
-    stdin
-      // Let's not pollute the output with whatever the user types
-      ..echoMode = false
-      // Let's not force user to have to press "enter" to input a command
-      ..lineMode = false;
-  }
-
-  stdout.writeln(_help);
-
-  // Handle user inputs, forcing the command to continue until the user asks to "quit"
-  await for (final input in stdin.transform(utf8.decoder)) {
-    switch (input) {
-      case 'r':
-        // Reruning lints
-        stdout.writeln('Manual Reload...');
-        await _runPlugins(runner, reload: true);
-        break;
-      case 'q':
-        // Let's quit the command line
-        // TODO(rrousselGit) Investigate why an "exit" is required and we can't simply "return"
-        exit(exitCode);
-      default:
-      // Unknown command. Nothing to do
-    }
-  }
-}
-
-extension on AnalysisErrorsParams {
-  String relativeFilePath(Directory dir) {
-    return p.relative(
-      file,
-      from: dir.path,
-    );
-  }
-}
+export 'custom_lint.dart';