Do not write progress if format is json (#225)

Author: kzrnm

packages/custom_lint/lib/custom_lint.dart

@@ -96,7 +96,8 @@ Future<void> _runServer(
       await runner.initialize;
 
       final log = CliLogger();
-      final progress = log.progress('Analyzing');
+      final progress =
+          format == OutputFormatEnum.json ? null : log.progress('Analyzing');
 
       await _runPlugins(
         runner,
@@ -134,12 +135,12 @@ Future<void> _runServer(
 Future<void> _runPlugins(
   CustomLintRunner runner, {
   required Logger log,
-  required Progress progress,
   required bool reload,
   required Directory workingDirectory,
   required bool fatalInfos,
   required bool fatalWarnings,
   required OutputFormatEnum format,
+  Progress? progress,
 }) async {
   final lints = await runner.getLints(reload: reload);
 

packages/custom_lint/lib/src/cli_logger.dart

@@ -61,9 +61,12 @@ class CliLogger implements Logger {
   Progress progress(String message) {
     _cancelProgress();
 
-    final progress = ansi.useAnsi
-        ? AnsiProgress(ansi, message)
-        : SimpleProgress(this, message);
+    final progress = _LineOnFinishProgress(
+      ansi.useAnsi
+          ? AnsiProgress(ansi, message)
+          : SimpleProgress(this, message),
+      log: this,
+    );
     _currentProgress = progress;
     return progress;
   }
@@ -72,3 +75,29 @@ class CliLogger implements Logger {
   @Deprecated('This method will be removed in the future')
   void flush() {}
 }
+
+class _LineOnFinishProgress implements Progress {
+  const _LineOnFinishProgress(this.impl, {required this.log});
+
+  final CliLogger log;
+  final Progress impl;
+
+  @override
+  Duration get elapsed => impl.elapsed;
+
+  @override
+  String get message => impl.message;
+
+  @override
+  void cancel() {
+    impl.cancel();
+  }
+
+  @override
+  void finish({String? message, bool showTiming = false}) {
+    impl.finish(message: message, showTiming: showTiming);
+
+    // Separate progress from results
+    log.stdout('');
+  }
+}

packages/custom_lint/lib/src/output/render_lints.dart

@@ -13,11 +13,11 @@ import 'output_format.dart';
 void renderLints(
   List<AnalysisErrorsParams> lints, {
   required Logger log,
-  required Progress progress,
   required Directory workingDirectory,
   required bool fatalInfos,
   required bool fatalWarnings,
   required OutputFormatEnum format,
+  Progress? progress,
 }) {
   final OutputFormat outputFormat;
   switch (format) {
@@ -69,10 +69,7 @@ void renderLints(
   });
 
   // Finish progress and display duration (only when ANSI is supported)
-  progress.finish(showTiming: true);
-
-  // Separate progress from results
-  log.stdout('');
+  progress?.finish(showTiming: true);
 
   outputFormat.render(
     errors: errors,

packages/custom_lint/test/cli_process_test.dart

@@ -208,7 +208,7 @@ No issues found!
                 }
               ],
             });
-            expect(process.stdout, 'Analyzing...\n\n$json\n');
+            expect(process.stdout, '$json\n');
           } else {
             expect(process.stdout, '''
 Analyzing...

packages/custom_lint/test/cli_test.dart

@@ -154,8 +154,6 @@ void main() {
 
           if (format == 'json') {
             expect(process.stdout, '''
-Analyzing...
-
 {"version":1,"diagnostics":[]}
 ''');
           } else {
@@ -202,24 +200,32 @@ No issues found!
           final err = process.stderr.map(utf8.decode);
 
           expect(err, emitsDone);
-          expect(
-            out.join(),
-            completion(
-              allOf(
-                startsWith('Analyzing...'),
-                format == 'json'
-                    ? endsWith('${jsonLints(app.resolveSymbolicLinksSync())}\n')
-                    : endsWith('''
+
+          if (format == 'json') {
+            expect(
+              out.join(),
+              completion(
+                equals('${jsonLints(app.resolveSymbolicLinksSync())}\n'),
+              ),
+            );
+          } else {
+            expect(
+              out.join(),
+              completion(
+                allOf(
+                  startsWith('Analyzing...'),
+                  endsWith('''
   lib/another.dart:1:6 • Hello world • hello_world • INFO
   lib/another.dart:1:6 • Oy • oy • INFO
   lib/main.dart:1:6 • Hello world • hello_world • INFO
   lib/main.dart:1:6 • Oy • oy • INFO
 
 4 issues found.
 '''),
+                ),
               ),
-            ),
-          );
+            );
+          }
           expect(await process.exitCode, 1);
         });
       });