detectExclusionsFromConfig function

Set<String> detectExclusionsFromConfig(String root)

Detects files to be excluded from API documentation generation based on analysis_options.yaml This function reads the analysis_options.yaml file at the specified root directory and extracts file exclusion patterns from the 'api_guard.exclude' section. It returns a Set of normalized file paths that match the exclusion patterns.

If the analysis_options.yaml file doesn't exist or doesn't contain exclusion patterns, an empty Set is returned

Example analysis_options.yaml:

api_guard:
  exclude:
    - "**/*.g.dart"
    - "lib/generated/**"

Implementation

Set<String> detectExclusionsFromConfig(String root) {
  final config = File('$root/analysis_options.yaml');

  if (!config.existsSync()) {
    return <String>{};
  }

  final yaml = loadYaml(config.readAsStringSync());

  final apiGuard = yaml['api_guard'];

  if (apiGuard == null) {
    return <String>{};
  }

  if (apiGuard is String) {
    return <String>{};
  }

  if (apiGuard is YamlList) {
    final exclusions = <String>{};
    for (final item in apiGuard) {
      if (item is String) {
        exclusions.addAll(
          Glob(item).listSync().map((e) => normalize(e.path)),
        );
      }
    }
    return exclusions;
  }
  return {};
}