FEA-2048: Ignore nested subpackages

.github/workflows/checks.yaml

@@ -4,6 +4,16 @@ on:
   pull_request:
 
 jobs:
+  analyze:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dart-lang/setup-dart@v1
+        with:
+          sdk: 2.18.7
+      - run: dart pub get
+      - run: dart run dart_dev analyze
+
   format:
     runs-on: ubuntu-latest
     steps:
@@ -12,7 +22,7 @@ jobs:
         with:
           sdk: 2.18.7
       - run: dart pub get
-      - run: dart run dart_dev format
+      - run: dart run dart_dev format --check
 
   dependency-validator:
     runs-on: ubuntu-latest

.github/workflows/tests.yaml

@@ -49,7 +49,12 @@ jobs:
 
     strategy:
       matrix:
-        repo: ["Workiva/over_react", "rrousselGit/provider", "dart-lang/args"]
+        repo: [
+          "Workiva/over_react",
+          "Workiva/w_module",
+          "rrousselGit/provider",
+          "dart-lang/args",
+        ]
 
     steps:
       # Setup scip-dart

analysis_options.yaml

@@ -0,0 +1,7 @@
+include: package:workiva_analysis_options/v2.yaml
+
+analyzer:
+  strong-mode:
+    implicit-casts: false
+  exclude:
+    - snapshots/**

bin/scip_dart.dart

@@ -28,7 +28,6 @@ Future<void> main(List<String> args) async {
         ))
       .parse(args);
 
-
   Flags.instance.init(result);
 
   if ((result['path'] as List<String>?)?.isNotEmpty == true) {
@@ -40,7 +39,7 @@ Future<void> main(List<String> args) async {
   }
 
   final packageRoot =
-      result.rest.length > 0 ? result.rest.first : Directory.current.path;
+      result.rest.isNotEmpty ? result.rest.first : Directory.current.path;
 
   final packageConfig = await findPackageConfig(Directory(packageRoot));
   if (packageConfig == null) {

lib/src/flags.dart

@@ -8,8 +8,8 @@ class Flags {
   bool _performance = false;
 
   void init(ArgResults results) {
-    _verbose = results['verbose'] ?? false;
-    _performance = results['performance'] ?? false;
+    _verbose = results['verbose'] as bool? ?? false;
+    _performance = results['performance'] as bool? ?? false;
   }
 
   static Flags get instance => _instance;

lib/src/indexer.dart

@@ -1,3 +1,5 @@
+import 'dart:io';
+
 import 'package:analyzer/dart/analysis/analysis_context_collection.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:path/path.dart' as p;
@@ -7,6 +9,7 @@ import 'package:scip_dart/src/flags.dart';
 
 import 'package:scip_dart/src/gen/scip.pb.dart';
 import 'package:scip_dart/src/scip_visitor.dart';
+import 'package:scip_dart/src/utils.dart';
 
 Future<Index> indexPackage(
   String root,
@@ -15,35 +18,55 @@ Future<Index> indexPackage(
 ) async {
   final dirPath = p.normalize(p.absolute(root));
 
+  final rootHasPubspecFile = await File(
+    p.join(dirPath, 'pubspec.yaml'),
+  ).exists();
+  if (!rootHasPubspecFile) {
+    stderr.writeln(
+      'Provided path does not contain a pubspec.yaml file. '
+      'Unable to index',
+    );
+    exit(1);
+  }
+
   final metadata = Metadata(
-      projectRoot: 'file:/' + dirPath,
-      textDocumentEncoding: TextEncoding.UTF8,
-      toolInfo: ToolInfo(
-        name: 'scip-dart',
-        version: '0.0.1',
-        arguments: [],
-      ));
+    projectRoot: 'file:/' + dirPath,
+    textDocumentEncoding: TextEncoding.UTF8,
+    toolInfo: ToolInfo(
+      name: 'scip-dart',
+      version: '0.0.1',
+      arguments: [],
+    ),
+  );
 
   final allPackageRoots = packageConfig.packages
       .map((package) => p.normalize(package.packageUriRoot.toFilePath()))
       .toList();
 
+  final nestedPackages = (await pubspecPathsFor(root))
+      .map((path) => p.dirname(path))
+      .where((path) => path != root)
+      .toList();
+
+  if (Flags.instance.verbose) print('Ignoring subdirectories: $nestedPackages');
 
   final collection = AnalysisContextCollection(
-    includedPaths: [
-      ...allPackageRoots,
-      dirPath,
-    ],
-  );
+      includedPaths: [
+        ...allPackageRoots,
+        dirPath,
+      ],
+      // only index dart files of the current dart package, to index nested
+      // packages, scip indexing can simply be re-run for that nested package
+      excludedPaths: nestedPackages);
 
   if (Flags.instance.performance) print('Analyzing Source');
   final st = Stopwatch()..start();
 
   final context = collection.contextFor(dirPath);
   final resolvedUnitFutures = context.contextRoot
-    .analyzedFiles()
-    .where((file) => p.extension(file) == '.dart')
-    .map(context.currentSession.getResolvedUnit);
+      .analyzedFiles()
+      .where((file) => p.extension(file) == '.dart')
+      .map(context.currentSession.getResolvedUnit);
 
   final resolvedUnits = await Future.wait(resolvedUnitFutures);
 

lib/src/scip_visitor.dart

@@ -29,7 +29,6 @@ class ScipVisitor extends GeneralizingAstVisitor {
     Pubspec pubspec,
   ) : _symbolGenerator = SymbolGenerator(
           packageConfig,
-          _projectRoot,
           pubspec,
         ) {
     final fileSymbol = _symbolGenerator.fileSymbolFor(_relativePath);

lib/src/symbol.dart

@@ -9,7 +9,6 @@ import 'package:scip_dart/src/utils.dart';
 /// Each sourcefile should use its own instance of `SymbolGenerator`
 class SymbolGenerator {
   final PackageConfig _packageConfig;
-  final String _projectRoot;
   final Pubspec _pubspec;
 
   int _localElementIndex = 0;
@@ -23,7 +22,6 @@ class SymbolGenerator {
 
   SymbolGenerator(
     this._packageConfig,
-    this._projectRoot,
     this._pubspec,
   );
 

lib/src/utils.dart

@@ -1,8 +1,20 @@
 import 'dart:io';
 
 import 'package:analyzer/source/line_info.dart';
+import 'package:path/path.dart' as p;
+
 import 'package:scip_dart/src/flags.dart';
 
+/// Returns a list of all the pubspec.yaml paths under a directory.
+/// Will recurse into child folders, will not follow links.
+Future<List<String>> pubspecPathsFor(String rootDirectory) async {
+  return Directory(rootDirectory)
+      .list(recursive: true, followLinks: false)
+      .where((file) => p.basename(file.path) == 'pubspec.yaml')
+      .map((file) => file.path)
+      .toList();
+}
+
 enum DisplayLevel {
   info,
   warn,