lib/src/validator/gitignore.dart

// Copyright (c) 2021, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

// @dart=2.10

import 'dart:async';
import 'dart:io';

import 'package:path/path.dart' as p;

import '../entrypoint.dart';
import '../git.dart' as git;
import '../ignore.dart';
import '../io.dart';
import '../utils.dart';
import '../validator.dart';

/// A validator that validates that no checked in files are ignored by a
/// .gitignore. These would be considered part of the package by previous
/// versions of pub.
class GitignoreValidator extends Validator {
  GitignoreValidator(Entrypoint entrypoint) : super(entrypoint);

  @override
  Future<void> validate() async {
    if (entrypoint.root.inGitRepo) {
      final checkedIntoGit = git.runSync([
        'ls-files',
        '--cached',
        '--exclude-standard',
        '--recurse-submodules'
      ], workingDir: entrypoint.root.dir);
      String resolve(String path) {
        if (Platform.isWindows) {
          return p.joinAll([entrypoint.root.dir, ...p.posix.split(path)]);
        }
        return p.join(entrypoint.root.dir, path);
      }

      final unignoredByGitignore = Ignore.listFiles(
        listDir: (dir) {
          var contents = Directory(resolve(dir)).listSync();
          return contents.map((entity) => p.posix.joinAll(
              p.split(p.relative(entity.path, from: entrypoint.root.dir))));
        },
        ignoreForDir: (dir) {
          final gitIgnore = resolve('$dir/.gitignore');
          final rules = [
            if (fileExists(gitIgnore)) readTextFile(gitIgnore),
          ];
          return rules.isEmpty ? null : Ignore(rules);
        },
        isDir: (dir) => dirExists(resolve(dir)),
      ).toSet();

      final ignoredFilesCheckedIn = checkedIntoGit
          .where((file) => !unignoredByGitignore.contains(file))
          .toList();

      if (ignoredFilesCheckedIn.isNotEmpty) {
        warnings.add('''
${ignoredFilesCheckedIn.length} checked in ${pluralize('file', ignoredFilesCheckedIn.length)} ${ignoredFilesCheckedIn.length == 1 ? 'is' : 'are'} ignored by a `.gitignore`.
Previous versions of Pub would include those in the published package.

Consider adjusting your `.gitignore` files to not ignore those files, and if you do not wish to
publish these files use `.pubignore`. See also dart.dev/go/pubignore

Files that are checked in while gitignored:

${ignoredFilesCheckedIn.take(10).join('\n')}
${ignoredFilesCheckedIn.length > 10 ? '...' : ''}
''');
      }
    }
  }
}