Skip to content

Commit a4ae175

Browse files
authored
[package_config] Update language version and reformat (#2040)
Reformat at language version 3.7 to enable the new style. Remove some ignore comments that were missed. Reflow a split string to avoid long lines and double quote strings containing escaped single quotes.
1 parent a2af144 commit a4ae175

17 files changed

+1516
-864
lines changed

.github/workflows/package_config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ jobs:
5454
fail-fast: false
5555
matrix:
5656
os: [ubuntu-latest, windows-latest]
57-
sdk: [3.4, dev]
57+
sdk: [3.7, dev]
5858
steps:
5959
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
6060
- uses: dart-lang/setup-dart@e51d8e571e22473a2ddebf0ef8a2123f0ab2c02c

pkgs/package_config/lib/package_config.dart

+48-25
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,11 @@ export 'package_config_types.dart';
4141
/// The returned package configuration is a *best effort* attempt to create
4242
/// a valid configuration from the invalid configuration file.
4343
/// If no [onError] is provided, errors are thrown immediately.
44-
Future<PackageConfig> loadPackageConfig(File file,
45-
{bool preferNewest = true, void Function(Object error)? onError}) =>
46-
readAnyConfigFile(file, preferNewest, onError ?? throwError);
44+
Future<PackageConfig> loadPackageConfig(
45+
File file, {
46+
bool preferNewest = true,
47+
void Function(Object error)? onError,
48+
}) => readAnyConfigFile(file, preferNewest, onError ?? throwError);
4749

4850
/// Reads a specific package configuration URI.
4951
///
@@ -86,11 +88,12 @@ Future<PackageConfig> loadPackageConfig(File file,
8688
/// The returned package configuration is a *best effort* attempt to create
8789
/// a valid configuration from the invalid configuration file.
8890
/// If no [onError] is provided, errors are thrown immediately.
89-
Future<PackageConfig> loadPackageConfigUri(Uri file,
90-
{Future<Uint8List?> Function(Uri uri)? loader,
91-
bool preferNewest = true,
92-
void Function(Object error)? onError}) =>
93-
readAnyConfigFileUri(file, loader, onError ?? throwError, preferNewest);
91+
Future<PackageConfig> loadPackageConfigUri(
92+
Uri file, {
93+
Future<Uint8List?> Function(Uri uri)? loader,
94+
bool preferNewest = true,
95+
void Function(Object error)? onError,
96+
}) => readAnyConfigFileUri(file, loader, onError ?? throwError, preferNewest);
9497

9598
/// Finds a package configuration relative to [directory].
9699
///
@@ -115,16 +118,25 @@ Future<PackageConfig> loadPackageConfigUri(Uri file,
115118
/// any lower-version configuration files are ignored in the search.
116119
///
117120
/// Returns `null` if no configuration file is found.
118-
Future<PackageConfig?> findPackageConfig(Directory directory,
119-
{bool recurse = true,
120-
void Function(Object error)? onError,
121-
int minVersion = 1}) {
121+
Future<PackageConfig?> findPackageConfig(
122+
Directory directory, {
123+
bool recurse = true,
124+
void Function(Object error)? onError,
125+
int minVersion = 1,
126+
}) {
122127
if (minVersion > PackageConfig.maxVersion) {
123-
throw ArgumentError.value(minVersion, 'minVersion',
124-
'Maximum known version is ${PackageConfig.maxVersion}');
128+
throw ArgumentError.value(
129+
minVersion,
130+
'minVersion',
131+
'Maximum known version is ${PackageConfig.maxVersion}',
132+
);
125133
}
126134
return discover.findPackageConfig(
127-
directory, minVersion, recurse, onError ?? throwError);
135+
directory,
136+
minVersion,
137+
recurse,
138+
onError ?? throwError,
139+
);
128140
}
129141

130142
/// Finds a package configuration relative to [location].
@@ -170,17 +182,27 @@ Future<PackageConfig?> findPackageConfig(Directory directory,
170182
/// any lower-version configuration files are ignored in the search.
171183
///
172184
/// Returns `null` if no configuration file is found.
173-
Future<PackageConfig?> findPackageConfigUri(Uri location,
174-
{bool recurse = true,
175-
int minVersion = 1,
176-
Future<Uint8List?> Function(Uri uri)? loader,
177-
void Function(Object error)? onError}) {
185+
Future<PackageConfig?> findPackageConfigUri(
186+
Uri location, {
187+
bool recurse = true,
188+
int minVersion = 1,
189+
Future<Uint8List?> Function(Uri uri)? loader,
190+
void Function(Object error)? onError,
191+
}) {
178192
if (minVersion > PackageConfig.maxVersion) {
179-
throw ArgumentError.value(minVersion, 'minVersion',
180-
'Maximum known version is ${PackageConfig.maxVersion}');
193+
throw ArgumentError.value(
194+
minVersion,
195+
'minVersion',
196+
'Maximum known version is ${PackageConfig.maxVersion}',
197+
);
181198
}
182199
return discover.findPackageConfigUri(
183-
location, minVersion, loader, onError ?? throwError, recurse);
200+
location,
201+
minVersion,
202+
loader,
203+
onError ?? throwError,
204+
recurse,
205+
);
184206
}
185207

186208
/// Writes a package configuration to the provided directory.
@@ -195,5 +217,6 @@ Future<PackageConfig?> findPackageConfigUri(Uri location,
195217
/// A comment is generated if `[PackageConfig.extraData]` contains a
196218
/// `"generator"` entry.
197219
Future<void> savePackageConfig(
198-
PackageConfig configuration, Directory directory) =>
199-
writePackageConfigJsonFile(configuration, directory);
220+
PackageConfig configuration,
221+
Directory directory,
222+
) => writePackageConfigJsonFile(configuration, directory);

pkgs/package_config/lib/src/discovery.dart

+37-19
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,24 @@ final Uri parentPath = Uri(path: '..');
3636
/// If [minVersion] is greater than 1, `.packages` files are ignored.
3737
/// If [minVersion] is greater than the version read from the
3838
/// `package_config.json` file, it too is ignored.
39-
Future<PackageConfig?> findPackageConfig(Directory baseDirectory,
40-
int minVersion, bool recursive, void Function(Object error) onError) async {
39+
Future<PackageConfig?> findPackageConfig(
40+
Directory baseDirectory,
41+
int minVersion,
42+
bool recursive,
43+
void Function(Object error) onError,
44+
) async {
4145
var directory = baseDirectory;
4246
if (!directory.isAbsolute) directory = directory.absolute;
4347
if (!await directory.exists()) {
4448
return null;
4549
}
4650
do {
4751
// Check for $cwd/.packages
48-
var packageConfig =
49-
await findPackageConfigInDirectory(directory, minVersion, onError);
52+
var packageConfig = await findPackageConfigInDirectory(
53+
directory,
54+
minVersion,
55+
onError,
56+
);
5057
if (packageConfig != null) return packageConfig;
5158
if (!recursive) break;
5259
// Check in parent directories.
@@ -59,23 +66,30 @@ Future<PackageConfig?> findPackageConfig(Directory baseDirectory,
5966

6067
/// Similar to [findPackageConfig] but based on a URI.
6168
Future<PackageConfig?> findPackageConfigUri(
62-
Uri location,
63-
int minVersion,
64-
Future<Uint8List?> Function(Uri uri)? loader,
65-
void Function(Object error) onError,
66-
bool recursive) async {
69+
Uri location,
70+
int minVersion,
71+
Future<Uint8List?> Function(Uri uri)? loader,
72+
void Function(Object error) onError,
73+
bool recursive,
74+
) async {
6775
if (location.isScheme('package')) {
68-
onError(PackageConfigArgumentError(
69-
location, 'location', 'Must not be a package: URI'));
76+
onError(
77+
PackageConfigArgumentError(
78+
location,
79+
'location',
80+
'Must not be a package: URI',
81+
),
82+
);
7083
return null;
7184
}
7285
if (loader == null) {
7386
if (location.isScheme('file')) {
7487
return findPackageConfig(
75-
Directory.fromUri(location.resolveUri(currentPath)),
76-
minVersion,
77-
recursive,
78-
onError);
88+
Directory.fromUri(location.resolveUri(currentPath)),
89+
minVersion,
90+
recursive,
91+
onError,
92+
);
7993
}
8094
loader = defaultLoader;
8195
}
@@ -116,8 +130,11 @@ Future<PackageConfig?> findPackageConfigUri(
116130
/// If [minVersion] is greater than 1, `.packages` files are ignored.
117131
/// If [minVersion] is greater than the version read from the
118132
/// `package_config.json` file, it too is ignored.
119-
Future<PackageConfig?> findPackageConfigInDirectory(Directory directory,
120-
int minVersion, void Function(Object error) onError) async {
133+
Future<PackageConfig?> findPackageConfigInDirectory(
134+
Directory directory,
135+
int minVersion,
136+
void Function(Object error) onError,
137+
) async {
121138
var packageConfigFile = await checkForPackageConfigJsonFile(directory);
122139
if (packageConfigFile != null) {
123140
var config = await readPackageConfigJsonFile(packageConfigFile, onError);
@@ -135,8 +152,9 @@ Future<PackageConfig?> findPackageConfigInDirectory(Directory directory,
135152

136153
Future<File?> checkForPackageConfigJsonFile(Directory directory) async {
137154
assert(directory.isAbsolute);
138-
var file =
139-
File(pathJoin(directory.path, '.dart_tool', 'package_config.json'));
155+
var file = File(
156+
pathJoin(directory.path, '.dart_tool', 'package_config.json'),
157+
);
140158
if (await file.exists()) return file;
141159
return null;
142160
}

pkgs/package_config/lib/src/errors.dart

+11-6
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,25 @@ abstract class PackageConfigError {
1313
class PackageConfigArgumentError extends ArgumentError
1414
implements PackageConfigError {
1515
PackageConfigArgumentError(
16-
Object? super.value, String super.name, String super.message)
17-
: super.value();
16+
Object? super.value,
17+
String super.name,
18+
String super.message,
19+
) : super.value();
1820

1921
PackageConfigArgumentError.from(ArgumentError error)
20-
: super.value(error.invalidValue, error.name, error.message);
22+
: super.value(error.invalidValue, error.name, error.message);
2123
}
2224

2325
class PackageConfigFormatException extends FormatException
2426
implements PackageConfigError {
25-
PackageConfigFormatException(super.message, Object? super.source,
26-
[super.offset]);
27+
PackageConfigFormatException(
28+
super.message,
29+
Object? super.source, [
30+
super.offset,
31+
]);
2732

2833
PackageConfigFormatException.from(FormatException exception)
29-
: super(exception.message, exception.source, exception.offset);
34+
: super(exception.message, exception.source, exception.offset);
3035
}
3136

3237
/// The default `onError` handler.

0 commit comments

Comments
 (0)