Add option to group locally imported packages

README.md

@@ -104,6 +104,7 @@ import_sorter:
   comments: false # Optional, defaults to true
   ignored_files: # Optional, defaults to []
     - \/lib\/*
+  group_local_packages: false # Optional, default to false
 ```
 
 If you need another example check the [example app's import_sorter configuration](https://github.com/fluttercommunity/import_sorter/blob/master/example/example_app/pubspec.yaml#L76).

bin/main.dart

@@ -46,7 +46,9 @@ void main(List<String> args) {
 
   var emojis = false;
   var noComments = false;
+  var groupLocalPackages = false;
   final ignored_files = [];
+  final localPackages = [];
 
   // Reading from config in pubspec.yaml safely
   if (!argResults.contains('--ignore-config')) {
@@ -57,6 +59,20 @@ void main(List<String> args) {
       if (config.containsKey('ignored_files')) {
         ignored_files.addAll(config['ignored_files']);
       }
+      if (config.containsKey('group_local_packages')) {
+        groupLocalPackages = config['group_local_packages'];
+      }
+    }
+  }
+
+  // Find packages which are locally imported
+  if (groupLocalPackages && pubspecYaml.containsKey('dependencies')) {
+    final dependencies = pubspecYaml['dependencies'];
+    for (var packageName in dependencies.keys) {
+      final package = dependencies[packageName];
+      if (package is YamlMap && package.containsKey('path')) {
+        localPackages.add(packageName);
+      }
     }
   }
 
@@ -95,11 +111,12 @@ void main(List<String> args) {
       continue;
     }
 
-    final sortedFile = sort.sortImports(
-        file.readAsLinesSync(), packageName, emojis, exitOnChange, noComments);
+    final sortedFile = sort.sortImports(file.readAsLinesSync(), packageName,
+        emojis, exitOnChange, noComments, localPackages.cast<String>());
     if (!sortedFile.updated) {
       continue;
     }
+
     dartFiles[filePath]?.writeAsStringSync(sortedFile.sortedFile);
     sortedFiles.add(filePath);
   }

lib/sort.dart

@@ -10,13 +10,16 @@ ImportSortData sortImports(
   String package_name,
   bool emojis,
   bool exitIfChanged,
-  bool noComments, {
+  bool noComments,
+  List<String> localPackages, {
   String? filePath,
 }) {
   String dartImportComment(bool emojis) =>
       '//${emojis ? ' 🎯 ' : ' '}Dart imports:';
   String flutterImportComment(bool emojis) =>
       '//${emojis ? ' 🐦 ' : ' '}Flutter imports:';
+  String localPackageImportComment(bool emojis) =>
+      '//${emojis ? ' 🏠 ' : ' '}Local package imports:';
   String packageImportComment(bool emojis) =>
       '//${emojis ? ' 📦 ' : ' '}Package imports:';
   String projectImportComment(bool emojis) =>
@@ -27,13 +30,15 @@ ImportSortData sortImports(
 
   final dartImports = <String>[];
   final flutterImports = <String>[];
+  final localPackageImports = <String>[];
   final packageImports = <String>[];
   final projectRelativeImports = <String>[];
   final projectImports = <String>[];
 
   bool noImports() =>
       dartImports.isEmpty &&
       flutterImports.isEmpty &&
+      localPackageImports.isEmpty &&
       packageImports.isEmpty &&
       projectImports.isEmpty &&
       projectRelativeImports.isEmpty;
@@ -55,6 +60,8 @@ ImportSortData sortImports(
         dartImports.add(lines[i]);
       } else if (lines[i].contains('package:flutter/')) {
         flutterImports.add(lines[i]);
+      } else if (localPackages.any((package) => lines[i].contains('package:$package/'))) {
+        localPackageImports.add(lines[i]);
       } else if (lines[i].contains('package:$package_name/')) {
         projectImports.add(lines[i]);
       } else if (lines[i].contains('package:')) {
@@ -65,10 +72,12 @@ ImportSortData sortImports(
     } else if (i != lines.length - 1 &&
         (lines[i] == dartImportComment(false) ||
             lines[i] == flutterImportComment(false) ||
+            lines[i] == localPackageImportComment(false) ||
             lines[i] == packageImportComment(false) ||
             lines[i] == projectImportComment(false) ||
             lines[i] == dartImportComment(true) ||
             lines[i] == flutterImportComment(true) ||
+            lines[i] == localPackageImportComment(true) ||
             lines[i] == packageImportComment(true) ||
             lines[i] == projectImportComment(true) ||
             lines[i] == '// 📱 Flutter imports:') &&
@@ -124,9 +133,20 @@ ImportSortData sortImports(
     packageImports.sort();
     sortedLines.addAll(packageImports);
   }
+  if (localPackageImports.isNotEmpty) {
+    if (dartImports.isNotEmpty ||
+        flutterImports.isNotEmpty ||
+        packageImports.isNotEmpty) {
+      sortedLines.add('');
+    }
+    if (!noComments) sortedLines.add(localPackageImportComment(emojis));
+    localPackageImports.sort();
+    sortedLines.addAll(localPackageImports);
+  }
   if (projectImports.isNotEmpty || projectRelativeImports.isNotEmpty) {
     if (dartImports.isNotEmpty ||
         flutterImports.isNotEmpty ||
+        localPackageImports.isNotEmpty ||
         packageImports.isNotEmpty) {
       sortedLines.add('');
     }

test/sort_test.dart

@@ -4,7 +4,7 @@ import 'package:test/test.dart';
 // 🌎 Project imports:
 import 'package:import_sorter/sort.dart';
 
-void switcher(bool emojis, bool noComments) {
+void switcher(bool emojis, bool noComments, List<String> localPackages) {
   const packageName = 'import_sorter_test';
 
   // Imports:
@@ -24,6 +24,10 @@ import 'package:flutter_gen/gen_l10n/translations.dart';
 import 'package:intl/intl.dart';
 import 'package:mdi/mdi.dart';
 import 'package:provider/provider.dart';
+''';
+  const localImports = '''
+import 'package:shared_preferences/shared_preferences.dart';
+import 'package:url_launcher/url_launcher.dart';
 ''';
   const projectImports = '''
 import 'package:import_sorter_test/anotherFile2.dart';
@@ -49,11 +53,16 @@ void main(List<String> args) async {
       noComments ? '' : '// ${emojis ? '🎯 ' : ''}Dart imports:\n';
   final flutterImportComment =
       noComments ? '' : '// ${emojis ? '🐦 ' : ''}Flutter imports:\n';
+  final localPackageImportComment = (noComments || localPackages.isEmpty)
+      ? ''
+      : '//${emojis ? ' 🏠 ' : ' '}Local package imports:\n';
   final packageImportComment =
       noComments ? '' : '// ${emojis ? '📦 ' : ''}Package imports:\n';
   final projectImportComment =
       noComments ? '' : '// ${emojis ? '🌎 ' : ''}Project imports:\n';
 
+  final localPackageImportSplit = localPackages.isEmpty ? '' : '\n';
+
   test(
     'No imports and no code',
     () {
@@ -64,6 +73,7 @@ void main(List<String> args) async {
           emojis,
           false,
           noComments,
+          localPackages,
         ).sortedFile,
         '\n',
       );
@@ -79,6 +89,7 @@ void main(List<String> args) async {
           emojis,
           false,
           noComments,
+          localPackages,
         ).sortedFile,
         'enum HomeEvent { showInfo, showDiscover, showProfile }\n\n',
       );
@@ -89,14 +100,15 @@ void main(List<String> args) async {
     () {
       expect(
         sortImports(
-          '$projectImports\n$packageImports\n$dartImports\n$flutterImports\n'
+          '$projectImports\n$localImports\n$packageImports\n$dartImports\n$flutterImports\n'
               .split('\n'),
           packageName,
           emojis,
           false,
           noComments,
+          localPackages,
         ).sortedFile,
-        '$dartImportComment$dartImports\n$flutterImportComment$flutterImports\n$packageImportComment$packageImports\n$projectImportComment$projectImports\n',
+        '$dartImportComment$dartImports\n$flutterImportComment$flutterImports\n$packageImportComment$packageImports$localPackageImportSplit$localPackageImportComment$localImports\n$projectImportComment$projectImports\n',
       );
     },
   );
@@ -110,6 +122,7 @@ void main(List<String> args) async {
             emojis,
             false,
             noComments,
+            localPackages,
           ).sortedFile,
           '$sampleProgram\n');
     },
@@ -124,6 +137,7 @@ void main(List<String> args) async {
           emojis,
           false,
           noComments,
+          localPackages,
         ).sortedFile,
         '$dartImportComment$dartImports\n$sampleProgram\n',
       );
@@ -139,6 +153,7 @@ void main(List<String> args) async {
           emojis,
           false,
           noComments,
+          localPackages,
         ).sortedFile,
         '$flutterImportComment$flutterImports\n$sampleProgram\n',
       );
@@ -154,6 +169,7 @@ void main(List<String> args) async {
           emojis,
           false,
           noComments,
+          localPackages,
         ).sortedFile,
         '$packageImportComment$packageImports\n$sampleProgram\n',
       );
@@ -169,6 +185,7 @@ void main(List<String> args) async {
           emojis,
           false,
           noComments,
+          localPackages,
         ).sortedFile,
         '$projectImportComment$projectImports\n$sampleProgram\n',
       );
@@ -179,14 +196,15 @@ void main(List<String> args) async {
     () {
       expect(
         sortImports(
-          '$projectImports\n$packageImports\n$dartImports\n$flutterImports\n$sampleProgram'
+          '$projectImports\n$localImports\n$packageImports\n$dartImports\n$flutterImports\n$sampleProgram'
               .split('\n'),
           packageName,
           emojis,
           false,
           noComments,
+          localPackages,
         ).sortedFile,
-        '$dartImportComment$dartImports\n$flutterImportComment$flutterImports\n$packageImportComment$packageImports\n$projectImportComment$projectImports\n$sampleProgram\n',
+        '$dartImportComment$dartImports\n$flutterImportComment$flutterImports\n$packageImportComment$packageImports$localPackageImportSplit$localPackageImportComment$localImports\n$projectImportComment$projectImports\n$sampleProgram\n',
       );
     },
   );
@@ -195,34 +213,43 @@ void main(List<String> args) async {
     () {
       expect(
         sortImports(
-          'library import_sorter;\n$projectImports\n$packageImports\n$dartImports\n$flutterImports\n$sampleProgram'
+          'library import_sorter;\n$projectImports\n$localImports\n$packageImports\n$dartImports\n$flutterImports\n$sampleProgram'
               .split('\n'),
           packageName,
           emojis,
           false,
           noComments,
+          localPackages,
         ).sortedFile,
-        'library import_sorter;\n\n$dartImportComment$dartImports\n$flutterImportComment$flutterImports\n$packageImportComment$packageImports\n$projectImportComment$projectImports\n$sampleProgram\n',
+        'library import_sorter;\n\n$dartImportComment$dartImports\n$flutterImportComment$flutterImports\n$packageImportComment$packageImports$localPackageImportSplit$localPackageImportComment$localImports\n$projectImportComment$projectImports\n$sampleProgram\n',
       );
     },
   );
 }
 
 void main() {
-  group(
-    'No Emojis and Comments',
-    () => switcher(false, false),
-  );
-  group(
-    'Emojis and Comments',
-    () => switcher(true, false),
-  );
-  group(
-    'No Emojis and No Comments',
-    () => switcher(false, true),
-  );
-  group(
-    'Emojis and No Comments',
-    () => switcher(true, true),
-  );
+  List<bool> onOff = [true, false];
+
+  for (var emoji in onOff) {
+    for (var comment in onOff) {
+      for (var localPackages in onOff) {
+        String msg = '${emoji ? '' : 'No '}Emojis, ${comment ? '' : 'No '}'
+            'Comments, ${localPackages ? '' : 'No '}Local Packages';
+
+        group(
+          msg,
+          () => switcher(
+            emoji,
+            comment,
+            localPackages
+                ? [
+                    'shared_preferences',
+                    'url_launcher',
+                  ]
+                : [],
+          ),
+        );
+      }
+    }
+  }
 }