Skip to content

Commit 3e9c6fd

Browse files
Merge pull request #183 from mosuem/ignore-nested-packages
Ignore nested packages in surrounding package (#173)
2 parents d6ff26e + 1600be7 commit 3e9c6fd

5 files changed

Lines changed: 299 additions & 13 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Unreleased
22
<!-- Add unreleased changes here -->
3+
- Ignore nested packages when validating surrounding packages (#173).
34

45
- Parse files with the language version the package declares instead of the
56
newest one the analyzer knows about, which may be unreleased and reject

‎lib/src/dependency_validator.dart‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -107,16 +107,31 @@ Future<bool> checkPackage({required String root}) async {
107107
'${bulletItems(devDeps)}\n',
108108
);
109109

110+
final nestedPackages = listNestedPackages(root);
111+
final nestedPackageGlobs = [
112+
for (final nested in nestedPackages)
113+
makeGlob('${p.normalize(nested.path)}/**'),
114+
for (final subpackage in pubspec.workspace ?? [])
115+
makeGlob('${p.normalize('$root/$subpackage')}/**'),
116+
];
117+
logger.fine(
118+
'nested package globs:\n'
119+
'${bulletItems(nestedPackageGlobs.map((g) => g.pattern))}\n',
120+
);
121+
110122
final publicDirs = ['$root/bin/', '$root/lib/'];
111123
logger.fine("Excluding: $excludes");
112124
final publicDartFiles = [
113-
for (final dir in publicDirs) ...listDartFilesIn(dir, excludes),
125+
for (final dir in publicDirs)
126+
...listDartFilesIn(dir, [...excludes, ...nestedPackageGlobs]),
114127
];
115128
final publicScssFiles = [
116-
for (final dir in publicDirs) ...listScssFilesIn(dir, excludes),
129+
for (final dir in publicDirs)
130+
...listScssFilesIn(dir, [...excludes, ...nestedPackageGlobs]),
117131
];
118132
final publicLessFiles = [
119-
for (final dir in publicDirs) ...listLessFilesIn(dir, excludes),
133+
for (final dir in publicDirs)
134+
...listLessFilesIn(dir, [...excludes, ...nestedPackageGlobs]),
120135
];
121136

122137
logger
@@ -160,27 +175,20 @@ Future<bool> checkPackage({required String root}) async {
160175

161176
final publicDirGlobs = [for (final dir in publicDirs) makeGlob('$dir**')];
162177

163-
final subpackageGlobs = [
164-
for (final subpackage in pubspec.workspace ?? [])
165-
makeGlob('$root/$subpackage**'),
166-
];
167-
168-
logger.fine('subpackage globs: $subpackageGlobs');
169-
170178
final nonPublicDartFiles = listDartFilesIn('$root/', [
171179
...excludes,
172180
...publicDirGlobs,
173-
...subpackageGlobs,
181+
...nestedPackageGlobs,
174182
]);
175183
final nonPublicScssFiles = listScssFilesIn('$root/', [
176184
...excludes,
177185
...publicDirGlobs,
178-
...subpackageGlobs,
186+
...nestedPackageGlobs,
179187
]);
180188
final nonPublicLessFiles = listLessFilesIn('$root/', [
181189
...excludes,
182190
...publicDirGlobs,
183-
...subpackageGlobs,
191+
...nestedPackageGlobs,
184192
]);
185193

186194
logger

‎lib/src/utils.dart‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,27 @@ Iterable<File> listFilesWithExtensionIn(
9494
.where((file) => excludes.every((glob) => !glob.matches(file.path)));
9595
}
9696

97+
/// Returns an iterable of all directories containing a `pubspec.yaml` file
98+
/// within [dirPath], excluding [dirPath] itself.
99+
///
100+
/// This also excludes directories inside hidden directories, like `.dart_tool/`.
101+
Iterable<Directory> listNestedPackages(String dirPath) {
102+
final rootDir = Directory(dirPath);
103+
if (!rootDir.existsSync()) return [];
104+
105+
final rootCanonicalPath = p.canonicalize(rootDir.path);
106+
107+
return rootDir
108+
.listSync(recursive: true)
109+
.whereType<File>()
110+
.where(
111+
(file) => !p.split(file.path).any((d) => d != '.' && d.startsWith('.')),
112+
)
113+
.where((file) => p.basename(file.path) == 'pubspec.yaml')
114+
.map((file) => file.parent)
115+
.where((dir) => p.canonicalize(dir.path) != rootCanonicalPath);
116+
}
117+
97118
/// Logs the given [message] at [level] and lists all of the given [dependencies].
98119
void log(Level level, String message, Iterable<String> dependencies) {
99120
final sortedDependencies = dependencies.toList()..sort();

‎test/nested_packages_test.dart‎

Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
1+
import 'dart:convert';
2+
import 'package:dependency_validator/src/dependency_validator.dart';
3+
import 'package:pub_semver/pub_semver.dart';
4+
import 'package:pubspec_parse/pubspec_parse.dart';
5+
import 'package:test/test.dart';
6+
import 'package:test_descriptor/test_descriptor.dart' as d;
7+
8+
import 'pubspec_to_json.dart';
9+
import 'utils.dart';
10+
11+
void main() => group('Nested packages', () {
12+
initLogs();
13+
14+
test('ignores dependencies used only in nested packages', () async {
15+
final rootPubspec = Pubspec(
16+
'code_assets',
17+
environment: requireDart36,
18+
dependencies: {
19+
'http': HostedDependency(version: VersionConstraint.any),
20+
},
21+
);
22+
23+
final nestedPubspec = Pubspec(
24+
'host_name',
25+
environment: requireDart36,
26+
devDependencies: {
27+
'ffigen': HostedDependency(version: VersionConstraint.any),
28+
},
29+
);
30+
31+
final dir = d.dir('code_assets', [
32+
d.file('pubspec.yaml', jsonEncode(rootPubspec.toJson())),
33+
d.dir('lib', [
34+
d.file('code_assets.dart', 'import "package:http/http.dart";'),
35+
]),
36+
d.dir('example', [
37+
d.dir('host_name', [
38+
d.file('pubspec.yaml', jsonEncode(nestedPubspec.toJson())),
39+
d.dir('tool', [
40+
d.file('ffigen.dart', 'import "package:ffigen/ffigen.dart";'),
41+
]),
42+
d.dir('lib', [
43+
d.file(
44+
'host_name.dart', 'import "package:archive/archive.dart";'),
45+
]),
46+
]),
47+
]),
48+
]);
49+
50+
await dir.create();
51+
final result = await checkPackage(root: '${d.sandbox}/code_assets');
52+
expect(result, isTrue);
53+
});
54+
55+
test(
56+
'fails when root package itself has undeclared dependencies outside nested packages',
57+
() async {
58+
final rootPubspec = Pubspec(
59+
'code_assets',
60+
environment: requireDart36,
61+
dependencies: {},
62+
);
63+
64+
final nestedPubspec = Pubspec(
65+
'host_name',
66+
environment: requireDart36,
67+
devDependencies: {
68+
'ffigen': HostedDependency(version: VersionConstraint.any),
69+
},
70+
);
71+
72+
final dir = d.dir('code_assets_with_issue', [
73+
d.file('pubspec.yaml', jsonEncode(rootPubspec.toJson())),
74+
d.dir('tool', [
75+
// Undeclared dependency in root package's own tool dir
76+
d.file('root_tool.dart', 'import "package:meta/meta.dart";'),
77+
]),
78+
d.dir('example', [
79+
d.dir('host_name', [
80+
d.file('pubspec.yaml', jsonEncode(nestedPubspec.toJson())),
81+
d.dir('tool', [
82+
d.file('ffigen.dart', 'import "package:ffigen/ffigen.dart";'),
83+
]),
84+
]),
85+
]),
86+
]);
87+
88+
await dir.create();
89+
final result =
90+
await checkPackage(root: '${d.sandbox}/code_assets_with_issue');
91+
expect(result, isFalse);
92+
});
93+
94+
test('ignores deeply nested packages', () async {
95+
final rootPubspec = Pubspec(
96+
'root_pkg',
97+
environment: requireDart36,
98+
);
99+
100+
final deeplyNestedPubspec = Pubspec(
101+
'deep_pkg',
102+
environment: requireDart36,
103+
);
104+
105+
final dir = d.dir('root_pkg', [
106+
d.file('pubspec.yaml', jsonEncode(rootPubspec.toJson())),
107+
d.dir('example', [
108+
d.dir('nested', [
109+
d.dir('deep', [
110+
d.file(
111+
'pubspec.yaml', jsonEncode(deeplyNestedPubspec.toJson())),
112+
d.dir('lib', [
113+
d.file('deep.dart', 'import "package:meta/meta.dart";'),
114+
]),
115+
]),
116+
]),
117+
]),
118+
]);
119+
120+
await dir.create();
121+
final result = await checkPackage(root: '${d.sandbox}/root_pkg');
122+
expect(result, isTrue);
123+
});
124+
125+
test('ignores SCSS and Less files in nested packages', () async {
126+
final rootPubspec = Pubspec(
127+
'web_pkg',
128+
environment: requireDart36,
129+
);
130+
131+
final nestedPubspec = Pubspec(
132+
'nested_web_pkg',
133+
environment: requireDart36,
134+
);
135+
136+
final dir = d.dir('web_pkg', [
137+
d.file('pubspec.yaml', jsonEncode(rootPubspec.toJson())),
138+
d.dir('example', [
139+
d.dir('nested_web', [
140+
d.file('pubspec.yaml', jsonEncode(nestedPubspec.toJson())),
141+
d.dir('web', [
142+
d.file(
143+
'style.scss', '@import "package:foo_styles/style.scss";'),
144+
d.file(
145+
'style.less', '@import "packages/bar_styles/style.less";'),
146+
]),
147+
]),
148+
]),
149+
]);
150+
151+
await dir.create();
152+
final result = await checkPackage(root: '${d.sandbox}/web_pkg');
153+
expect(result, isTrue);
154+
});
155+
156+
test('works with workspace subpackages that contain nested packages',
157+
() async {
158+
final workspacePubspec = Pubspec(
159+
'workspace_root',
160+
environment: requireDart36,
161+
workspace: ['pkgs/code_assets'],
162+
);
163+
164+
final subpackagePubspec = Pubspec(
165+
'code_assets',
166+
environment: requireDart36,
167+
resolution: 'workspace',
168+
dependencies: {
169+
'http': HostedDependency(version: VersionConstraint.any),
170+
},
171+
);
172+
173+
final nestedPubspec = Pubspec(
174+
'host_name',
175+
environment: requireDart36,
176+
dependencies: {
177+
'ffigen': HostedDependency(version: VersionConstraint.any),
178+
},
179+
);
180+
181+
final dir = d.dir('workspace', [
182+
d.file('pubspec.yaml', jsonEncode(workspacePubspec.toJson())),
183+
d.dir('pkgs', [
184+
d.dir('code_assets', [
185+
d.file('pubspec.yaml', jsonEncode(subpackagePubspec.toJson())),
186+
d.dir('lib', [
187+
d.file('code_assets.dart', 'import "package:http/http.dart";'),
188+
]),
189+
d.dir('example', [
190+
d.dir('host_name', [
191+
d.file('pubspec.yaml', jsonEncode(nestedPubspec.toJson())),
192+
d.dir('tool', [
193+
d.file(
194+
'ffigen.dart', 'import "package:ffigen/ffigen.dart";'),
195+
]),
196+
]),
197+
]),
198+
]),
199+
]),
200+
]);
201+
202+
await dir.create();
203+
final result = await checkPackage(root: '${d.sandbox}/workspace');
204+
expect(result, isTrue);
205+
});
206+
});

‎test/utils_test.dart‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// limitations under the License.
1414

1515
@TestOn('vm')
16+
import 'package:path/path.dart' as p;
1617
import 'package:pub_semver/pub_semver.dart';
1718
import 'package:test/test.dart';
1819
import 'package:test_descriptor/test_descriptor.dart' as d;
@@ -449,4 +450,53 @@ include: package:pedantic/analysis_options.1.8.0.yaml
449450
});
450451
});
451452
});
453+
454+
group('listNestedPackages', () {
455+
test('returns empty when no directory exists', () {
456+
expect(listNestedPackages('${d.sandbox}/non_existent'), isEmpty);
457+
});
458+
459+
test('returns empty when only root pubspec exists', () async {
460+
await d.dir('pkg', [
461+
d.file('pubspec.yaml', 'name: pkg'),
462+
d.dir('lib', [d.file('pkg.dart', 'void main() {}')]),
463+
]).create();
464+
465+
expect(listNestedPackages('${d.sandbox}/pkg'), isEmpty);
466+
});
467+
468+
test('discovers nested packages in subdirectories', () async {
469+
await d.dir('complex_pkg', [
470+
d.file('pubspec.yaml', 'name: complex_pkg'),
471+
d.dir('lib', [d.file('main.dart', 'void main() {}')]),
472+
d.dir('example', [
473+
d.dir('host_name', [
474+
d.file('pubspec.yaml', 'name: host_name'),
475+
d.dir('tool', [d.file('ffigen.dart', 'void main() {}')]),
476+
]),
477+
]),
478+
d.dir('pkgs', [
479+
d.dir('nested_sub', [
480+
d.file('pubspec.yaml', 'name: nested_sub'),
481+
d.dir('lib', [d.file('nested.dart', 'void main() {}')]),
482+
]),
483+
]),
484+
d.dir('.dart_tool', [
485+
d.dir('hidden_sub', [
486+
d.file('pubspec.yaml', 'name: hidden_sub'),
487+
]),
488+
]),
489+
]).create();
490+
491+
final nested = listNestedPackages('${d.sandbox}/complex_pkg')
492+
.map((dir) => p.relative(dir.path, from: '${d.sandbox}/complex_pkg'))
493+
.toList()
494+
..sort();
495+
496+
expect(nested, [
497+
p.join('example', 'host_name'),
498+
p.join('pkgs', 'nested_sub'),
499+
]);
500+
});
501+
});
452502
}

0 commit comments

Comments
 (0)