feature: added support for dry runs

oppahansi · Dec 23, 2023 · d67eb8f · d67eb8f
1 parent 100fb7a
commit d67eb8f
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 2 deletions.
diff --git a/bin/better_imports.exe b/bin/better_imports.exe
diff --git a/lib/src/arg_parser.dart b/lib/src/arg_parser.dart
@@ -38,6 +38,11 @@ final argParser = ArgParser()
     defaultsTo: false,
     negatable: false,
   )
+  ..addFlag(
+    Constants.dryRunFlag,
+    defaultsTo: false,
+    negatable: false,
+  )
   ..addOption(
     Constants.cfgPathOption,
     mandatory: false,

diff --git a/lib/src/cfg.dart b/lib/src/cfg.dart
@@ -21,6 +21,7 @@ class Cfg {
   late bool silent;
   late bool trace;
   late bool relative;
+  late bool dryRun;
   late List<String> folders;
   late List<String> files;
   late List<String> ignoreFiles;
@@ -48,6 +49,7 @@ class Cfg {
     silent = false;
     trace = false;
     relative = false;
+    dryRun = false;
 
     folders = <String>[
       "lib",
@@ -90,6 +92,7 @@ class Cfg {
     _setSilent();
     _setTrace();
     _setRelative();
+    _setDryRun();
 
     _setFolders();
 
@@ -251,6 +254,19 @@ class Cfg {
     }
   }
 
+  void _setDryRun() {
+    log.fine("┠─ Setting dry run..");
+
+    if (_biYamlSection != null &&
+        _biYamlSection![Constants.dryRunKey] != null) {
+      dryRun = _biYamlSection![Constants.dryRunKey];
+    }
+
+    if (_argResults.wasParsed(Constants.dryRunFlag)) {
+      dryRun = _argResults[Constants.dryRunFlag];
+    }
+  }
+
   void _setFolders() {
     log.fine("┠─ Setting folders..");
 

diff --git a/lib/src/constants.dart b/lib/src/constants.dart
@@ -17,6 +17,8 @@ class Constants {
 
   static const betterImports = "better_imports";
 
+  static const dryRunKey = "dry_run";
+
   static const helpFlag = "help";
   static const helpFlagAbbr = "h";
 
@@ -33,6 +35,8 @@ class Constants {
 
   static const traceFlag = "trace";
 
+  static const dryRunFlag = "dry-run";
+
   static const foldersOption = "folders";
 
   static const filesOption = "files";
@@ -77,7 +81,8 @@ class Constants {
   --silent          -s                                Disables results output in console.
   --relative                                          Converts all project package imports to relative project imports.
   --no-comments                                       Removes comments from import types / sections. 
-  --trace 
+  --trace                                             Prints extended logs to console.
+  --dry-run                                           Prints the result of the sort without writing it to the file.
 
   OPTIONS
 

diff --git a/lib/src/import_sorter.dart b/lib/src/import_sorter.dart
@@ -45,7 +45,7 @@ class Sorter {
     for (var path in _collectorResult.filteredPaths) {
       var sortedResult = _sortFile(path);
 
-      if (sortedResult.changed) {
+      if (sortedResult.changed && !_cfg.dryRun) {
         sortedResult.file.writeAsStringSync(sortedResult.formattedContent);
       }
 

diff --git a/lib/src/sort_cmd.dart b/lib/src/sort_cmd.dart
@@ -69,5 +69,9 @@ class SortCmd {
         "$success Sorted $sortedCount out of ${sorted.length} files in ${stopwatch.elapsed.inMilliseconds} ms\n");
 
     log.fine("Printed results.");
+
+    if (cfg.dryRun) {
+      log.info("Dry run. No files were changed.");
+    }
   }
 }
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -48,6 +48,9 @@ better_imports:
   # Flag to use to log everything happening to console
   trace: false
 
+  # Flag to use to run a dry run without changing files
+  dry_run: false
+
   # Folder names used for collecting dart files
   folders:
     - lib

diff --git a/test/cfg_test.dart b/test/cfg_test.dart
@@ -22,6 +22,7 @@ void main() {
       expect(cfg.silent, false);
       expect(cfg.relative, false);
       expect(cfg.trace, false);
+      expect(cfg.dryRun, false);
       expect(cfg.folders, [
         "lib",
         "bin",
@@ -66,6 +67,7 @@ void main() {
         "-s",
         "--relative",
         "--trace",
+        "--dry-run",
         "--project-name",
         "argsProjectName",
         "--folders",
@@ -88,6 +90,7 @@ void main() {
       expect(cfg.silent, true);
       expect(cfg.relative, true);
       expect(cfg.trace, true);
+      expect(cfg.dryRun, true);
       expect(cfg.folders, [
         "lib/cmds",
         "lib/collectors",