Skip to content

Handle custom hosted dependency #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Feb 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion packages/custom_lint/lib/src/workspace.dart
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,22 @@ String _buildDependencyConstraint(

switch (sharedConstraint) {
case HostedDependency():
return ' ${sharedConstraint.getDisplayString()}';
final hosted = sharedConstraint.hosted;
if (hosted == null) {
return ' ${sharedConstraint.getDisplayString()}';
}
final result = StringBuffer();
result.writeln();
result.writeln(' hosted:');
if (hosted.declaredName != null) {
result.writeln(' name: ${hosted.declaredName}');
}
if (hosted.url != null) {
result.writeln(' url: ${hosted.url}');
}
result.write(' version: ${sharedConstraint.getDisplayString()}');
return result.toString();

case PathDependency():
// Use appropriate path separators across platforms
final path = posix.prettyUri(sharedConstraint.path);
Expand Down
102 changes: 101 additions & 1 deletion packages/custom_lint/test/src/workspace_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,18 @@ extension on Dependency {
final that = this;
if (that is HostedDependency) {
if (that.hosted != null) {
String? safeName;
try {
safeName = that.hosted!.name;

// `that.hosted!.name` could throw an error if `_nameOfPackage` is null in the getter.
// We need to safely handle this scenario because we can't guarantee that the value is not null.
// ignore: avoid_catching_errors
} on Error catch (_) {}

return {
'hosted': {
'name': that.hosted!.name,
if (safeName != null) 'name': safeName,
'url': that.hosted!.url.toString(),
},
'version': that.version.toString(),
Expand Down Expand Up @@ -2174,6 +2183,97 @@ dependencies:
plugin1: ">=1.5.0 <2.0.0"
''');
});
group(
'Support hosted project with custom source',
() {
test(
'If a dependency comes from a custom hosted source, the generated pubspec.yaml should contain the hosted source',
() async {
final workingDir = await createSimpleWorkspace([
Pubspec(
'plugin1',
dependencies: {
'custom_lint_builder': HostedDependency(),
},
),
Pubspec(
'a',
devDependencies: {
'plugin1': HostedDependency(
hosted: HostedDetails(
'plugin1',
Uri.parse('https://custom.com'),
),
version: Version(1, 0, 0),
),
},
),
]);

final workspace = await fromContextRootsFromPaths(
['a'],
workingDirectory: workingDir,
);

expect(workspace.computePubspec(), '''
name: custom_lint_client
description: A client for custom_lint
version: 0.0.1
publish_to: 'none'

dependencies:
plugin1:
hosted:
name: plugin1
url: https://custom.com
version: "1.0.0"
''');
});
test(
'Hosted withouth name should still work',
() async {
final workingDir = await createSimpleWorkspace([
Pubspec(
'plugin1',
dependencies: {
'custom_lint_builder': HostedDependency(),
},
),
Pubspec(
'a',
devDependencies: {
'plugin1': HostedDependency(
hosted: HostedDetails(
null,
Uri.parse('https://custom.com'),
),
version: Version(1, 0, 0),
),
},
),
]);

final workspace = await fromContextRootsFromPaths(
['a'],
workingDirectory: workingDir,
);

expect(workspace.computePubspec(), '''
name: custom_lint_client
description: A client for custom_lint
version: 0.0.1
publish_to: 'none'

dependencies:
plugin1:
hosted:
url: https://custom.com
version: "1.0.0"
''');
},
);
},
);
});

group(CustomLintWorkspace.fromPaths, () {
Expand Down