feat(deps)!: Change support of DEBUG=true to VERBOSE=true by using verbose

Author: hyiso

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-DEBUG=true dart bin/lint_staged.dart
+VERBOSE=true dart bin/lint_staged.dart

lib/lint_staged.dart

@@ -1,3 +1,5 @@
+import 'package:verbose/verbose.dart';
+
 import 'src/context.dart';
 import 'src/exception.dart';
 import 'src/logger.dart';
@@ -34,17 +36,18 @@ Future<bool> lintStaged({
     return true;
     // ignore: empty_catches
   } catch (e) {
+    final verbose = Verbose('lint_staged');
     if (e is LintStagedException && e.ctx.errors.isNotEmpty) {
       if (e.ctx.errors.contains(kConfigNotFoundError)) {
-        logger.debug(kNoConfigurationMsg);
+        verbose(kNoConfigurationMsg);
       } else if (e.ctx.errors.contains(kApplyEmptyCommitError)) {
-        logger.debug(kPreventedEmptyCommitMsg);
+        verbose(kPreventedEmptyCommitMsg);
       } else if (e.ctx.errors.contains(kGitError) &&
           !e.ctx.errors.contains(kGetBackupStashError)) {
-        logger.debug(kGitErrorMsg);
+        verbose(kGitErrorMsg);
         if (e.ctx.shouldBackup) {
           // No sense to show this if the backup stash itself is missing.
-          logger.debug(kRestoreStashExampleMsg);
+          verbose(kRestoreStashExampleMsg);
         }
       }
 

lib/src/git.dart

@@ -1,9 +1,9 @@
 import 'dart:io';
 
-import 'logger.dart';
 import 'package:path/path.dart';
+import 'package:verbose/verbose.dart';
 
-final logger = Logger('lint_staged:execGit');
+final verbose = Verbose('lint_staged:execGit');
 
 ///
 /// Get git diff arguments
@@ -45,7 +45,7 @@ Future<String> execGit(
   String? workingDirectory,
 }) async {
   final gitArgs = [...kNoSubmoduleRecurse, ...args];
-  logger.debug('git ${gitArgs.join(' ')}');
+  verbose('git ${gitArgs.join(' ')}');
   final result =
       await Process.run('git', gitArgs, workingDirectory: workingDirectory);
   if (result.exitCode != 0) {

lib/src/git_workflow.dart

@@ -1,17 +1,17 @@
 import 'dart:math';
-import 'package:lint_staged/src/logger.dart';
-import 'package:lint_staged/src/symbols.dart';
 import 'package:path/path.dart';
+import 'package:verbose/verbose.dart';
 
+import 'context.dart';
 import 'file.dart';
 import 'git.dart';
-import 'context.dart';
+import 'symbols.dart';
 
 /// In git status machine output, renames are presented as `to`NUL`from`
 /// When diffing, both need to be taken into account, but in some cases on the `to`.
 final _renameRegex = RegExp(r'\x00');
 
-final logger = Logger('lint_staged:GitWorkflow');
+final verbose = Verbose('lint_staged:GitWorkflow');
 
 ///
 /// From list of files, split renames and flatten into two files `to`NUL`from`.
@@ -120,20 +120,20 @@ class GitWorkflow {
   /// Get a list of unstaged deleted files
   ///
   Future<List<String>> getDeletedFiles() async {
-    logger.debug('Getting deleted files...');
+    verbose('Getting deleted files...');
     final lsFiles = await execGit(['ls-files', '--deleted'],
         workingDirectory: workingDirectory);
     final files =
         lsFiles.split('\n').where((line) => line.trim().isNotEmpty).toList();
-    logger.debug('Found deleted files: $files');
+    verbose('Found deleted files: $files');
     return files;
   }
 
   ///
   /// Save meta information about ongoing git merge
   ///
   Future<void> backupMergeStatus() async {
-    logger.debug('Backing up merge state...');
+    verbose('Backing up merge state...');
     await Future.wait([
       readFile(mergeHeadFilename, workingDirectory: workingDirectory)
           .then((value) => mergeHeadContent = value),
@@ -142,14 +142,14 @@ class GitWorkflow {
       readFile(mergeMsgFilename, workingDirectory: workingDirectory)
           .then((value) => mergeModeContent = value)
     ]);
-    logger.debug('Done backing up merge state!');
+    verbose('Done backing up merge state!');
   }
 
   ///
   /// Restore meta information about ongoing git merge
   ///
   Future<void> restoreMergeStatus(LintStagedContext ctx) async {
-    logger.debug('Restoring merge state...');
+    verbose('Restoring merge state...');
     try {
       await Future.wait([
         if (mergeHeadContent != null)
@@ -162,10 +162,10 @@ class GitWorkflow {
           writeFile(mergeMsgFilename, mergeMsgContent!,
               workingDirectory: workingDirectory),
       ]);
-      logger.debug('Done restoring merge state!');
+      verbose('Done restoring merge state!');
     } catch (e) {
-      logger.debug('Failed restoring merge state with error:');
-      logger.debug(e.toString());
+      verbose('Failed restoring merge state with error:');
+      verbose(e.toString());
       handleError(
           Exception('Merge state could not be restored due to an error!'),
           ctx,
@@ -179,7 +179,7 @@ class GitWorkflow {
   /// both the "from" and "to" filenames, where "from" is no longer on disk.
   ///
   Future<List<String>> getPartiallyStagedFiles() async {
-    logger.debug('Getting partially staged files...');
+    verbose('Getting partially staged files...');
     final status =
         await execGit(['status', '-z'], workingDirectory: workingDirectory);
     if (status.isEmpty) {
@@ -215,7 +215,7 @@ class GitWorkflow {
 
         /// Filter empty string
         .toList();
-    logger.debug('Found partially staged files: $partiallyStaged');
+    verbose('Found partially staged files: $partiallyStaged');
     return partiallyStaged;
   }
 
@@ -224,7 +224,7 @@ class GitWorkflow {
   ///
   Future<void> prepare(LintStagedContext ctx) async {
     try {
-      logger.debug('Backing up original state...');
+      verbose('Backing up original state...');
       partiallyStagedFiles = await getPartiallyStagedFiles();
       if (partiallyStagedFiles.isNotEmpty) {
         ctx.hasPartiallyStagedFiles = true;
@@ -263,7 +263,7 @@ class GitWorkflow {
       await execGit(['stash', 'store', '--quiet', '--message', kStash, hash],
           workingDirectory: workingDirectory);
 
-      logger.debug('Done backing up original state!');
+      verbose('Done backing up original state!');
     } catch (e) {
       handleError(e, ctx);
     }
@@ -291,7 +291,7 @@ class GitWorkflow {
   /// In case of a merge-conflict retry with 3-way merge.
   ///
   Future<void> applyModifications(LintStagedContext ctx) async {
-    logger.debug('Adding task modifications to index...');
+    verbose('Adding task modifications to index...');
 
     /// `matchedFileChunks` includes staged files that lint_staged originally detected and matched against a task.
     /// Add only these files so any 3rd-party edits to other files won't be included in the commit.
@@ -301,7 +301,7 @@ class GitWorkflow {
       await execGit(['add', '--', ...files],
           workingDirectory: workingDirectory);
     }
-    logger.debug('Done adding task modifications to index!');
+    verbose('Done adding task modifications to index!');
 
     final stagedFilesAfterAdd = await execGit(
         getDiffArgs(diff: diff, diffFilter: diffFilter),
@@ -318,23 +318,22 @@ class GitWorkflow {
   /// 3-way merge usually fixes this, and in case it doesn't we should just give up and throw.
   ///
   Future<void> resotreUnstagedChanges(LintStagedContext ctx) async {
-    logger.debug('Restoring unstaged changes...');
+    verbose('Restoring unstaged changes...');
     final unstagedPatch = getHiddenFilepath(kPatchUnstaged);
     try {
       await execGit(['apply', ...kGitApplyArgs, unstagedPatch],
           workingDirectory: workingDirectory);
     } catch (applyError) {
-      logger.debug('Error while restoring changes:');
-      logger.debug(applyError.toString());
-      logger.debug('Retrying with 3-way merge');
+      verbose('Error while restoring changes:');
+      verbose(applyError.toString());
+      verbose('Retrying with 3-way merge');
       try {
         // Retry with a 3-way merge if normal apply fails
         await execGit(['apply', ...kGitApplyArgs, '--3way', unstagedPatch],
             workingDirectory: workingDirectory);
       } catch (threeWayApplyError) {
-        logger
-            .debug('Error while restoring unstaged changes using 3-way merge:');
-        logger.debug(threeWayApplyError.toString());
+        verbose('Error while restoring unstaged changes using 3-way merge:');
+        verbose(threeWayApplyError.toString());
         handleError(
             Exception(
                 'Unstaged changes could not be restored due to a merge conflict!'),
@@ -349,7 +348,7 @@ class GitWorkflow {
   ///
   Future<void> restoreOriginState(LintStagedContext ctx) async {
     try {
-      logger.debug('Restoring original state...');
+      verbose('Restoring original state...');
       await execGit(['reset', '--hard', 'HEAD'],
           workingDirectory: workingDirectory);
       await execGit(
@@ -367,7 +366,7 @@ class GitWorkflow {
       await removeFile(getHiddenFilepath(kPatchUnstaged),
           workingDirectory: workingDirectory);
 
-      logger.debug('Done restoring original state!');
+      verbose('Done restoring original state!');
     } catch (error) {
       handleError(error, ctx, kRestoreOriginalStateError);
     }
@@ -378,10 +377,10 @@ class GitWorkflow {
   ///
   Future<void> cleanup(LintStagedContext ctx) async {
     try {
-      logger.debug('Dropping backup stash...');
+      verbose('Dropping backup stash...');
       await execGit(['stash', 'drop', '--quiet', await getBackupStash(ctx)],
           workingDirectory: workingDirectory);
-      logger.debug('Done dropping backup stash!');
+      verbose('Done dropping backup stash!');
     } catch (error) {
       handleError(error, ctx);
     }

lib/src/lint_runner.dart

@@ -1,11 +1,12 @@
 import 'dart:collection';
 import 'dart:io';
 
+import 'package:verbose/verbose.dart';
+
 import 'context.dart';
-import 'logger.dart';
 import 'symbols.dart';
 
-final logger = Logger('lint_staged:LintRunner');
+final verbose = Verbose('lint_staged:LintRunner');
 
 ///
 /// `dart fix` for single file is supportted in Dart SDK 2.18
@@ -54,13 +55,13 @@ class LintRunner {
         } else {
           cmds.add(path);
         }
-        logger.debug(cmds.join(' '));
+        verbose(cmds.join(' '));
         final result = await Process.run(cmds.removeAt(0), cmds,
             workingDirectory: workingDirectory);
         if (result.exitCode != 0) {
           ctx.errors.add(kTaskError);
-          logger.debug(result.stdout);
-          logger.debug(result.stderr);
+          verbose(result.stdout);
+          verbose(result.stderr);
         }
       }
     }));

lib/src/logger.dart

@@ -4,8 +4,7 @@ import 'package:ansi/ansi.dart';
 
 class Logger {
   final String name;
-  final bool isDebug;
-  Logger(this.name) : isDebug = io.Platform.environment['DEBUG'] == 'true';
+  Logger(this.name);
 
   void stderr(String message) {
     io.stderr.writeln(ansi.red('$name $message'));
@@ -14,10 +13,4 @@ class Logger {
   void stdout(String message) {
     io.stdout.writeln('$name $message');
   }
-
-  void debug(String message) {
-    if (isDebug) {
-      io.stdout.writeln('$name $message');
-    }
-  }
 }

lib/src/run.dart

@@ -1,19 +1,21 @@
 import 'dart:io';
 
 import 'package:glob/glob.dart';
+import 'package:lint_staged/src/logger.dart';
+import 'package:verbose/verbose.dart';
 
 import 'chunk.dart';
 import 'config.dart';
 import 'exception.dart';
 import 'git.dart';
 import 'git_workflow.dart';
 import 'lint_runner.dart';
-import 'logger.dart';
 import 'message.dart';
 import 'context.dart';
 import 'symbols.dart';
 
 final logger = Logger('lint_staged:run');
+final verbose = Verbose('lint_staged:run');
 
 Future<LintStagedContext> runAll({
   bool allowEmpty = false,
@@ -42,7 +44,7 @@ Future<LintStagedContext> runAll({
   /// and when using the default list of staged files by default
   ctx.shouldBackup = hasInitialCommit && stash;
   if (!ctx.shouldBackup) {
-    logger.debug(skippingBackupMsg(hasInitialCommit, diff));
+    verbose(skippingBackupMsg(hasInitialCommit, diff));
   }
   final stagedFiles = await getStagedFiles(
     diff: diff,
@@ -58,7 +60,7 @@ Future<LintStagedContext> runAll({
     ctx.output.add(kNoStagedFilesMsg);
     return ctx;
   }
-  logger.debug('Loaded list of staged files int git:\n$stagedFiles');
+  verbose('Loaded list of staged files int git:\n$stagedFiles');
 
   final foundConfigs = await loadConifg(workingDirectory: workingDirectory);
   if (foundConfigs == null) {
@@ -69,14 +71,14 @@ Future<LintStagedContext> runAll({
     ctx.errors.add(kConfigEmptyError);
     return ctx;
   }
-  logger.debug('Found configs: $foundConfigs');
+  verbose('Found configs: $foundConfigs');
   final matchedFiles = <String>{};
   final tasks = <Future Function()>[];
   for (var pattern in foundConfigs.keys) {
     final glob = Glob(pattern);
     final scopedFiles = <String>{};
     for (var file in stagedFiles) {
-      logger.debug('$file matches $pattern is ${glob.matches(file)}');
+      verbose('$file matches $pattern is ${glob.matches(file)}');
       if (glob.matches(file)) {
         scopedFiles.add(file);
         matchedFiles.add(file);
@@ -91,10 +93,10 @@ Future<LintStagedContext> runAll({
         workingDirectory: workingDirectory);
     tasks.add(runner.run);
   }
-  logger.debug('matched files: $matchedFiles');
+  verbose('matched files: $matchedFiles');
   final matchedFileChunks =
       chunkFiles(matchedFiles.toList(), maxArgLength: maxArgLength);
-  logger.debug('matched file chunks: $matchedFileChunks');
+  verbose('matched file chunks: $matchedFileChunks');
   final git = GitWorkflow(
     allowEmpty: allowEmpty,
     gitConfigDir: await getGitConfigDir(),

pubspec.yaml

@@ -13,13 +13,14 @@ dependencies:
   args: ^2.3.1
   glob: ^2.0.1
   path: ^1.8.0
+  verbose: ^0.1.0
   yaml: ^3.1.1
 
 dev_dependencies:
   commitlint_cli: ^0.3.0
-  husky: ^0.1.4
+  husky: ^0.1.6
   lints: ^2.0.0
   test: ^1.16.0
 
 lint_staged:
-  'lib/**.dart': dart fix --apply && dart format --fix
+  '**.dart': dart fix --apply && dart format --fix