feat: Add logUpdate

Author: hyiso

lib/lint_staged.dart

@@ -23,13 +23,14 @@ Future<bool> lintStaged({
   String? workingDirectory,
   int maxArgLength = 0,
 }) async {
-  final logger = Logger('lint_staged');
+  final logger = Logger();
   try {
     final ctx = await runAll(
         allowEmpty: allowEmpty,
         diff: diff,
         diffFilter: diffFilter,
         stash: stash,
+        logger: logger,
         maxArgLength: maxArgLength,
         workingDirectory: workingDirectory);
     _printTaskOutput(ctx, logger);
@@ -60,7 +61,7 @@ Future<bool> lintStaged({
 
 void _printTaskOutput(LintStagedContext ctx, Logger logger) {
   if (ctx.output.isEmpty) return;
-  final log = ctx.errors.isNotEmpty ? logger.stderr : logger.stdout;
+  final log = ctx.errors.isNotEmpty ? logger.error : logger.success;
   for (var line in ctx.output) {
     log(line);
   }

lib/src/figures.dart

@@ -0,0 +1,4 @@
+class Figures {
+  static const success = '✔';
+  static const error = '✖';
+}

lib/src/log_update.dart

@@ -0,0 +1,75 @@
+import 'dart:io';
+
+import 'package:ansi_escapes/ansi_escapes.dart';
+import 'package:ansi_slice/ansi_slice.dart';
+import 'package:ansi_strip/ansi_strip.dart';
+import 'package:ansi_wrap/ansi_wrap.dart';
+
+int getWidth(IOSink stream) {
+  return stdout.terminalColumns;
+}
+
+String fitToTerminalHeight(IOSink stream, String text) {
+  final terminalHeight = stdout.terminalLines;
+  final lines = text.split('\n');
+
+  final toRemove = lines.length - terminalHeight;
+  if (toRemove <= 0) {
+    return text;
+  }
+
+  return sliceAnsi(
+    text,
+    start: stripAnsi(lines.sublist(0, toRemove).join('\n')).length + 1,
+  );
+}
+
+Render createLogUpdate(IOSink stream, {bool showCursor = true}) {
+  return Render(stream, showCursor);
+}
+
+final logUpdate = createLogUpdate(stdout);
+final logUpdateStderr = createLogUpdate(stderr);
+
+class Render {
+  int previousLineCount = 0;
+  int previousWidth;
+  String previousOutput = '';
+  final IOSink stream;
+  final bool showCursor;
+
+  Render(this.stream, this.showCursor) : previousWidth = getWidth(stream);
+
+  void call(String output) {
+    if (!showCursor) {
+      stream.write(ansiEscapes.cursorHide);
+    }
+    output = fitToTerminalHeight(stream, output);
+    final width = getWidth(stream);
+    if (output == previousOutput && previousWidth == width) {
+      return;
+    }
+
+    previousOutput = output;
+    previousWidth = width;
+    output = wrapAnsi(output, width, trim: false, hard: true, wordWrap: false);
+    stream.write(ansiEscapes.eraseLines(previousLineCount) + output);
+    previousLineCount = output.split('\n').length;
+  }
+
+  void clear() {
+    stream.write(ansiEscapes.eraseLines(previousLineCount));
+    previousOutput = '';
+    previousWidth = getWidth(stream);
+    previousLineCount = 0;
+  }
+
+  void done() {
+    previousOutput = '';
+    previousWidth = getWidth(stream);
+    previousLineCount = 0;
+    if (!showCursor) {
+      stream.write(ansiEscapes.cursorShow);
+    }
+  }
+}

lib/src/logger.dart

@@ -1,16 +1,35 @@
+import 'dart:async';
 import 'dart:io' as io;
 
 import 'package:ansi/ansi.dart';
+import 'package:lint_staged/src/figures.dart';
+
+import 'log_update.dart';
+
+const _kFrames = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
 
 class Logger {
-  final String name;
-  Logger(this.name);
+  int _index = 0;
+  Timer? _timer;
+  Logger();
+
+  void error(String message) {
+    io.stderr.writeln(ansi.red('${Figures.error} $message'));
+  }
 
-  void stderr(String message) {
-    io.stderr.writeln(ansi.red('$name $message'));
+  void progress(String message) {
+    _index = 0;
+    _timer?.cancel();
+    logUpdate.clear();
+    _timer = Timer.periodic(const Duration(milliseconds: 80), (timer) {
+      final frame = _kFrames[_index = ++_index % _kFrames.length];
+      logUpdate('${ansi.yellow(frame)} $message\n');
+    });
   }
 
-  void stdout(String message) {
-    io.stdout.writeln('$name $message');
+  void success(String message) {
+    logUpdate.clear();
+    _timer?.cancel();
+    io.stdout.writeln('${ansi.green(Figures.success)} $message');
   }
 }

lib/src/run.dart

@@ -14,7 +14,6 @@ import 'message.dart';
 import 'context.dart';
 import 'symbols.dart';
 
-final logger = Logger('lint_staged:run');
 final verbose = Verbose('lint_staged:run');
 
 Future<LintStagedContext> runAll({
@@ -24,6 +23,7 @@ Future<LintStagedContext> runAll({
   bool stash = true,
   String? workingDirectory,
   int maxArgLength = 0,
+  required Logger logger,
 }) async {
   final ctx = getInitialContext();
   if (!FileSystemEntity.isDirectorySync('.git') &&
@@ -105,29 +105,36 @@ Future<LintStagedContext> runAll({
     matchedFileChunks: matchedFileChunks,
     workingDirectory: workingDirectory,
   );
-  logger.stdout('Preparing lint_staged...');
+  logger.progress('Preparing lint_staged...');
   await git.prepare(ctx);
+  logger.success('Preparing lint_staged...');
   if (ctx.hasPartiallyStagedFiles) {
-    logger.stdout('Hiding unstaged changes to partially staged files...');
+    logger.progress('Hiding unstaged changes to partially staged files...');
     await git.hideUnstagedChanges(ctx);
+    logger.success('Hiding unstaged changes to partially staged files...');
   }
-  logger.stdout('Running tasks for staged files...');
+  logger.progress('Running tasks for staged files...');
   await Future.wait(tasks.map((task) => task()));
+  logger.success('Running tasks for staged files...');
   if (!applyModifationsSkipped(ctx)) {
-    logger.stdout('Applying modifications from tasks...');
+    logger.progress('Applying modifications from tasks...');
     await git.applyModifications(ctx);
+    logger.success('Applying modifications from tasks...');
   }
   if (ctx.hasPartiallyStagedFiles && !restoreUnstagedChangesSkipped(ctx)) {
-    logger.stdout('Restoring unstaged changes to partially staged files...');
+    logger.progress('Restoring unstaged changes to partially staged files...');
     await git.resotreUnstagedChanges(ctx);
+    logger.success('Restoring unstaged changes to partially staged files...');
   }
   if (restoreOriginalStateEnabled(ctx) && !restoreOriginalStateSkipped(ctx)) {
-    logger.stdout('Reverting to original state because of errors...');
+    logger.progress('Reverting to original state because of errors...');
     await git.restoreOriginState(ctx);
+    logger.success('Reverting to original state because of errors...');
   }
   if (cleanupEnabled(ctx) && !cleanupSkipped(ctx)) {
-    logger.stdout('Cleaning up temporary files...');
+    logger.progress('Cleaning up temporary files...');
     await git.cleanup(ctx);
+    logger.success('Cleaning up temporary files...');
   }
   if (ctx.errors.isNotEmpty) {
     throw createError(ctx);

pubspec.yaml

@@ -10,8 +10,13 @@ environment:
 
 dependencies:
   ansi: ^0.2.2
+  ansi_escapes: ^1.1.0
+  ansi_slice: ^0.1.1
+  ansi_strip: ^0.1.1+1
+  ansi_wrap: ^0.1.2+1
   args: ^2.3.1
   glob: ^2.0.1
+  indent: ^2.0.0
   path: ^1.8.0
   verbose: ^0.1.0
   yaml: ^3.1.1