Merge pull request #13 from bawahakim/feat-allow-excluded-files

feat: exclude files pattern

Author: hyiso

README.md

@@ -152,6 +152,19 @@ Parentheses are reserved in case this package adds support for Bash extended
 globbing in the future. For the time being, using them will throw an error
 unless they're escaped.
 
+### Exclude pattern: `!`
+
+For any files you wish to exclude, use the same glob pattern but prepend it with `!`
+
+```
+lint_staged:
+  'lib/**.dart': your-cmd
+  '!lib/**.g.dart': your-cmd
+```
+
+This would include all .dart files, but exclude .g.dart files.
+
+
 ## What commands are supported?
 
 Supported are any executables installed locally or globally via `pub` as well as any executable from your \$PATH.

lib/src/group.dart

@@ -14,23 +14,33 @@ Map<String, Group> groupFilesByConfig(
     {required Map<String, List<String>> config, required List<String> files}) {
   final fileSet = files.toSet();
   final groups = <String, Group>{};
-  for (var entry in config.entries) {
+
+  // Separate config into inclusion and exclusion patterns
+  final includeConfig = config.entries.where((e) => !e.key.startsWith('!'));
+  final excludeConfig = config.entries.where((e) => e.key.startsWith('!'));
+
+  // First, include files based on inclusion patterns
+  for (var entry in includeConfig) {
     final glob = Glob(entry.key);
-    final files = <String>[];
-    for (var file in fileSet) {
-      if (glob.matches(file)) {
-        files.add(file);
-      }
-    }
+    final matchedFiles = fileSet.where((file) => glob.matches(file)).toList();
 
-    /// Files should only match a single entry
-    for (var file in files) {
-      fileSet.remove(file);
+    if (matchedFiles.isNotEmpty) {
+      _verbose('$glob matched files: $matchedFiles');
+      groups[entry.key] = Group(scripts: entry.value, files: matchedFiles);
     }
-    if (files.isNotEmpty) {
-      _verbose('$glob matched files: $files');
-      groups[entry.key] = Group(scripts: entry.value, files: files);
+  }
+
+  // Next, exclude files based on exclusion patterns
+  for (var entry in excludeConfig) {
+    final glob = Glob(entry.key.substring(1)); // Remove the '!' prefix
+    final excludedFiles = fileSet.where((file) => glob.matches(file)).toSet();
+
+    // Remove excluded files from each group
+    for (var group in groups.values) {
+      _verbose('$glob excluded files: $excludedFiles');
+      group.files.removeWhere((file) => excludedFiles.contains(file));
     }
   }
+
   return groups;
 }

test/integration/__fixtures__/config.dart

@@ -2,6 +2,11 @@ const kConfigFormatFix = '''lint_staged:
   'lib/**.dart': dart format --fix
 ''';
 
+const kConfigFormatFixWithIgnore = '''lint_staged:
+  'lib/**.dart': dart format --fix
+  '!lib/**.g.dart': dart format --fix
+''';
+
 const kConfigFormatExit = '''lint_staged:
   'lib/**.dart': dart format --set-exit-if-changed
 ''';

test/integration/basic_functionality_test.dart

@@ -198,5 +198,29 @@ void main() {
       expect(await project.git.lastCommit, contains('test'));
       expect(await project.fs.read('lib/main.dart'), equals(kFormattedDart));
     });
+
+    test('ignores files given in pubspec.yaml', () async {
+      final project = IntegrationProject();
+      print('dir: ${project.path}');
+      await project.setup();
+
+      await project.fs.write('pubspec.yaml', kConfigFormatFixWithIgnore);
+
+      // Stage multi unformatted files
+      await project.fs.write('lib/main.dart', kUnFormattedDart);
+      await project.git.run(['add', 'lib/main.dart']);
+
+      await project.fs.write('lib/foo.g.dart', kUnFormattedDart);
+      await project.git.run(['add', 'lib/foo.g.dart']);
+
+      // Run lint_staged to automatically format the file and commit formatted files
+      await project.gitCommit();
+
+      // main.dart should be formatted, while foo.g.dart should not
+      expect(await project.git.commitCount, equals(2));
+      expect(await project.git.lastCommit, contains('test'));
+      expect(await project.fs.read('lib/main.dart'), equals(kFormattedDart));
+      expect(await project.fs.read('lib/foo.g.dart'), equals(kUnFormattedDart));
+    });
   });
 }

test/integration/utils.dart

@@ -17,6 +17,7 @@ class IntegrationProject {
   Future<void> setup({bool initialCommit = true}) async {
     /// Git init
     await Process.run('git', ['init', path]);
+    await fs.write('.gitattributes', '*.dart text eol=lf');
 
     /// Git config
     await config();
@@ -35,7 +36,7 @@ class IntegrationProject {
 
   Future<void> _initialCommit() async {
     await fs.append('README.md', '# Test\n');
-    await git.run(['add', 'README.md']);
+    await git.run(['add', 'README.md', '.gitattributes']);
     await git.run(['commit', '-m initial commit']);
   }