Skip to content

fix: ignore example by default when getting dependencies #1310

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.

Sign up for GitHub

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
matiasleyba merged 1 commit into from
Jul 17, 2025
Merged

fix: ignore example by default when getting dependencies #1310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion lib/src/cli/dart_cli.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class Dart {
try {
return await _Cmd.run(
'dart',
['pub', 'get'],
['pub', 'get', '--no-example'],
workingDirectory: cwd,
logger: logger,
);
Expand Down
2 changes: 1 addition & 1 deletion lib/src/cli/flutter_cli.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ class Flutter {
try {
return await _Cmd.run(
'flutter',
['pub', 'get'],
['pub', 'get', '--no-example'],
workingDirectory: cwd,
logger: logger,
);
Expand Down
212 changes: 212 additions & 0 deletions test/src/commands/packages/commands/get_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,5 +423,217 @@ sdk: ^3.8.0
});
}),
);

test(
'completes normally '
'and ignores example by default (non-recursive)',
withRunner((commandRunner, logger, pubUpdater, printLogs) async {
final tempDirectory = Directory.systemTemp.createTempSync();
addTearDown(() => tempDirectory.deleteSync(recursive: true));

final directoryA = Directory(path.join(tempDirectory.path, 'plugin'));

File(
path.join(directoryA.path, 'pubspec.yaml'),
)
..createSync(recursive: true)
..writeAsStringSync('''
name: plugin
version: 0.1.0

environment:
sdk: ^3.8.0
''');

File(
path.join(directoryA.path, 'example', 'pubspec.yaml'),
)
..createSync(recursive: true)
..writeAsStringSync('''
name: example
version: 0.1.0

environment:
sdk: ^3.8.0
''');

final result = await commandRunner.run([
'packages',
'get',
'${tempDirectory.path}/plugin',
]);

expect(result, equals(ExitCode.success.code));
verify(() {
logger.progress(
any(
that: contains(
'''Running "flutter pub get" in .''',
),
),
);
}).called(1);

verifyNever(() {
logger.progress(
any(
that: contains(
'''Running "flutter pub get" in example''',
),
),
);
});
}),
);

test(
'completes normally '
'and does not ignore example when is recursive',
withRunner((commandRunner, logger, pubUpdater, printLogs) async {
final tempDirectory = Directory.systemTemp.createTempSync();
addTearDown(() => tempDirectory.deleteSync(recursive: true));

final directoryA = Directory(path.join(tempDirectory.path, 'plugin'));

File(
path.join(directoryA.path, 'pubspec.yaml'),
)
..createSync(recursive: true)
..writeAsStringSync('''
name: plugin
version: 0.1.0

environment:
sdk: ^3.8.0
''');

File(
path.join(directoryA.path, 'example', 'pubspec.yaml'),
)
..createSync(recursive: true)
..writeAsStringSync('''
name: example
version: 0.1.0

environment:
sdk: ^3.8.0
''');

final result = await commandRunner.run([
'packages',
'get',
'--recursive',
'${tempDirectory.path}/plugin',
]);

expect(result, equals(ExitCode.success.code));

verify(() {
logger.progress(
any(
that: contains(
'''Running "flutter pub get" in . ''',
),
),
);
}).called(1);

verify(() {
logger.progress(
any(
that: contains(
'''Running "flutter pub get" in ./example''',
),
),
);
}).called(1);
}),
);

test(
'completes normally '
'and ignores example when using --ignore=example (recursive)',
withRunner((commandRunner, logger, pubUpdater, printLogs) async {
final tempDirectory = Directory.systemTemp.createTempSync();
addTearDown(() => tempDirectory.deleteSync(recursive: true));

final directoryA = Directory(path.join(tempDirectory.path, 'plugin'));

File(
path.join(directoryA.path, 'pubspec.yaml'),
)
..createSync(recursive: true)
..writeAsStringSync('''
name: plugin
version: 0.1.0

environment:
sdk: ^3.8.0
''');

File(
path.join(directoryA.path, 'example', 'pubspec.yaml'),
)
..createSync(recursive: true)
..writeAsStringSync('''
name: example
version: 0.1.0

environment:
sdk: ^3.8.0
''');

File(
path.join(directoryA.path, 'my_sub_package', 'pubspec.yaml'),
)
..createSync(recursive: true)
..writeAsStringSync('''
name: my_sub_package
version: 0.1.0

environment:
sdk: ^3.8.0
''');

final result = await commandRunner.run([
'packages',
'get',
'--recursive',
'--ignore=example',
'${tempDirectory.path}/plugin',
]);

expect(result, equals(ExitCode.success.code));
verify(() {
logger.progress(
any(
that: contains(
'''Running "flutter pub get" in . ''',
),
),
);
}).called(1);

verify(() {
logger.progress(
any(
that: contains(
'''Running "flutter pub get" in ./my_sub_package''',
),
),
);
}).called(1);

verifyNever(() {
logger.progress(
any(
that: contains(
'''Running "flutter pub get" in example''',
),
),
);
});
}),
);
});
}