Skip to content

[native_assets_cli] Fix snake casing in JSON #2128

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 1 commit into from
Mar 26, 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
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@
"$ref": "shared_definitions.schema.json#/definitions/Asset"
}
}
},
"assets_for_linking": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "shared_definitions.schema.json#/definitions/Asset"
}
}
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,12 @@
{
"const": "dynamic"
},
{
"const": "prefer_dynamic"
},
{
"const": "prefer_static"
},
{
"const": "prefer-dynamic"
},
Expand Down
14 changes: 14 additions & 0 deletions pkgs/code_assets/test/data/build_output_macos.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,20 @@
}
]
},
"assets_for_linking": {
"package_with_linker": [
{
"architecture": "arm64",
"file": "/private/var/folders/2y/mngq9h194yzglt4kzttzfq6800klzg/T/iv6i0d/native_add/.dart_tool/native_assets_builder/native_add/c6b312c90c95d2d98ffb6760a738fb36/out/libnative_add.a",
"id": "package:native_add/src/native_add_bindings_generated.dart",
"link_mode": {
"type": "static"
},
"os": "macos",
"type": "native_code"
}
]
},
"dependencies": [
"/private/var/folders/2y/mngq9h194yzglt4kzttzfq6800klzg/T/ZnD2I3/native_add/src/native_add.c"
],
Expand Down
12 changes: 8 additions & 4 deletions pkgs/code_assets/test/schema/schema_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,14 @@ FieldsFunction _codeFields(AllTestData allTestData) {
(['assets', 0, ...field], expectRequiredFieldMissing),
if (hook == Hook.build) ...[
for (final field in requiredCodeAssetFields)
(
['assetsForLinking', 'package_with_linker', 0, ...field],
expectRequiredFieldMissing,
),
for (final assetsForLinking in [
'assetsForLinking',
'assets_for_linking',
])
(
[assetsForLinking, 'package_with_linker', 0, ...field],
expectRequiredFieldMissing,
),
],
(['assets', staticIndex, 'file'], expectRequiredFieldMissing),
(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@
"$ref": "shared_definitions.schema.json#/definitions/Asset"
}
}
},
"assets_for_linking": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "shared_definitions.schema.json#/definitions/Asset"
}
}
}
}
}
Expand Down
16 changes: 16 additions & 0 deletions pkgs/data_assets/test/data/build_output.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,22 @@
}
]
},
"assets_for_linking": {
"package_with_linker": [
{
"file": "/private/var/folders/2y/mngq9h194yzglt4kzttzfq6800klzg/T/0s5bKi/simple_link/assets/data_0.json",
"name": "assets/data_0.json",
"package": "simple_link",
"type": "data"
},
{
"file": "/private/var/folders/2y/mngq9h194yzglt4kzttzfq6800klzg/T/0s5bKi/simple_link/assets/data_1.json",
"name": "assets/data_1.json",
"package": "simple_link",
"type": "data"
}
]
},
"dependencies": [
"/private/var/folders/2y/mngq9h194yzglt4kzttzfq6800klzg/T/0s5bKi/simple_link/assets/data_2.json",
"/private/var/folders/2y/mngq9h194yzglt4kzttzfq6800klzg/T/0s5bKi/simple_link/assets/data_3.json"
Expand Down
12 changes: 8 additions & 4 deletions pkgs/data_assets/test/schema/schema_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,14 @@ List<(List<Object>, void Function(ValidationResults result))> _dataFields({
(['assets', 0, field], expectRequiredFieldMissing),
if (hook == Hook.build) ...[
for (final field in _dataAssetFields)
(
['assetsForLinking', 'package_with_linker', 0, field],
expectRequiredFieldMissing,
),
for (final assetsForLinking in [
'assetsForLinking',
'assets_for_linking',
])
(
[assetsForLinking, 'package_with_linker', 0, field],
expectRequiredFieldMissing,
),
],
],
];
5 changes: 5 additions & 0 deletions pkgs/hook/doc/schema/hook/shared_definitions.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
"BuildInput": {},
"BuildOutput": {
"$ref": "../shared/shared_definitions.schema.json#/definitions/BuildOutput",
"properties": {
"assets_for_linking": {
"$comment": "Older SDKs will only read 'assetsForLinking', so it must be emitted as well."
}
},
"unevaluatedProperties": false
},
"HookInput": {
Expand Down
11 changes: 10 additions & 1 deletion pkgs/hook/doc/schema/sdk/shared_definitions.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,16 @@
"$ref": "../shared/shared_definitions.schema.json#/definitions/BuildInput",
"unevaluatedProperties": false
},
"BuildOutput": {},
"BuildOutput": {
"properties": {
"assetsForLinking": {
"deprecated": true
},
"assets_for_linking": {
"$comment": "Older hooks will still emit 'assetsForLinking', so it must be read."
}
}
},
"HookInput": {
"properties": {
"out_file": {
Expand Down
9 changes: 9 additions & 0 deletions pkgs/hook/doc/schema/shared/shared_definitions.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@
}
}
},
"assets_for_linking": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/Asset"
}
}
},
"metadata": {
"type": "object",
"additionalProperties": true
Expand Down
12 changes: 12 additions & 0 deletions pkgs/hook/test/data/build_output.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@
}
]
},
"assets_for_linking": {
"package_with_linker": [
{
"some_key": "some_value",
"type": "some_asset_type"
},
{
"some_other_key": "some_value",
"type": "some_other_asset_type"
}
]
},
"dependencies": [
"/private/var/folders/2y/mngq9h194yzglt4kzttzfq6800klzg/T/0s5bKi/simple_link/assets/data_2.json",
"/private/var/folders/2y/mngq9h194yzglt4kzttzfq6800klzg/T/0s5bKi/simple_link/assets/data_3.json"
Expand Down
30 changes: 17 additions & 13 deletions pkgs/hook/test/schema/helpers.dart
Original file line number Diff line number Diff line change
Expand Up @@ -340,19 +340,23 @@ FieldsReturn _hookFields({
(['assets'], expectOptionalFieldMissing),
(['assets', 0], expectOptionalFieldMissing),
(['assets', 0, 'type'], expectRequiredFieldMissing),
if (hook == Hook.build) ...[
(['metadata'], expectOptionalFieldMissing),
(['assetsForLinking'], expectOptionalFieldMissing),
(
['assetsForLinking', 'package_with_linker', 0],
expectOptionalFieldMissing,
),
(['assetsForLinking'], expectOptionalFieldMissing),
(
['assetsForLinking', 'package_with_linker', 0, 'type'],
expectRequiredFieldMissing,
),
],
if (hook == Hook.build)
for (final assetsForLinking in [
'assetsForLinking',
'assets_for_linking',
]) ...[
(['metadata'], expectOptionalFieldMissing),
([assetsForLinking], expectOptionalFieldMissing),
(
[assetsForLinking, 'package_with_linker', 0],
expectOptionalFieldMissing,
),
([assetsForLinking], expectOptionalFieldMissing),
(
[assetsForLinking, 'package_with_linker', 0, 'type'],
expectRequiredFieldMissing,
),
],
],
];
}
Expand Down
9 changes: 9 additions & 0 deletions pkgs/hook/tool/generate_schemas.dart
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ void generateSharedDefinitions() {
},
},
},
'assets_for_linking': {
'type': 'object',
'additionalProperties': {
'type': 'array',
'items': {
r'$ref': 'shared_definitions.schema.json#/definitions/Asset',
},
},
},
},
};
const linkInputAssetOverride = {
Expand Down
3 changes: 3 additions & 0 deletions pkgs/hook/tool/generate_syntax.dart
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ void main(List<String> args) {
'Ios': 'IOS',
'macos': 'macOS',
'Macos': 'MacOS',
'prefer-dynamic': 'preferDynamicOld',
'prefer-static': 'preferStaticOld',
'assetsForLinking': 'assetsForLinkingOld',
},
publicSetters: [
'BuildOutput',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ class SchemaAnalyzer {
return '';
}

final parts = string.replaceAll('-', '_').split('_');
final parts = string.split('_');

String remapCapitalization(String input) =>
capitalizationOverrides[input] ?? input;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ final class LinkModePreference {
/// Provide native assets as dynamic libraries, if possible.
///
/// Otherwise, build native assets as static libraries
static const preferDynamic = LinkModePreference('prefer-dynamic');
static const preferDynamic = LinkModePreference('prefer_dynamic');

/// Provide native assets as static libraries, if possible.
///
/// Otherwise, build native assets as dynamic libraries. Preferred for AOT
/// compilation, if there are any native assets which can only be provided as
/// dynamic libraries.
static const preferStatic = LinkModePreference('prefer-static');
static const preferStatic = LinkModePreference('prefer_static');

static const values = [dynamic, static, preferDynamic, preferStatic];

Expand All @@ -50,13 +50,21 @@ final class LinkModePreference {
}

extension LinkModePreferenceSyntax on LinkModePreference {
static final _toSyntax = {
for (final item in LinkModePreference.values)
item: syntax.LinkModePreference.fromJson(item.name),
static const _toSyntax = {
LinkModePreference.dynamic: syntax.LinkModePreference.dynamic,
LinkModePreference.preferDynamic: syntax.LinkModePreference.preferDynamic,
LinkModePreference.preferStatic: syntax.LinkModePreference.preferStatic,
LinkModePreference.static: syntax.LinkModePreference.static,
};

static final _fromSyntax = {
for (var entry in _toSyntax.entries) entry.value: entry.key,
static const _fromSyntax = {
syntax.LinkModePreference.dynamic: LinkModePreference.dynamic,
syntax.LinkModePreference.preferDynamic: LinkModePreference.preferDynamic,
syntax.LinkModePreference.preferDynamicOld:
LinkModePreference.preferDynamic,
syntax.LinkModePreference.preferStatic: LinkModePreference.preferStatic,
syntax.LinkModePreference.preferStaticOld: LinkModePreference.preferStatic,
syntax.LinkModePreference.static: LinkModePreference.static,
};

syntax.LinkModePreference toSyntax() => _toSyntax[this]!;
Expand Down
10 changes: 8 additions & 2 deletions pkgs/native_assets_cli/lib/src/code_assets/syntax.g.dart
Original file line number Diff line number Diff line change
Expand Up @@ -871,14 +871,20 @@ class LinkModePreference {

static const dynamic = LinkModePreference._('dynamic');

static const preferDynamic = LinkModePreference._('prefer-dynamic');
static const preferDynamicOld = LinkModePreference._('prefer-dynamic');

static const preferStatic = LinkModePreference._('prefer-static');
static const preferStaticOld = LinkModePreference._('prefer-static');

static const preferDynamic = LinkModePreference._('prefer_dynamic');

static const preferStatic = LinkModePreference._('prefer_static');

static const static = LinkModePreference._('static');

static const List<LinkModePreference> values = [
dynamic,
preferDynamicOld,
preferStaticOld,
preferDynamic,
preferStatic,
static,
Expand Down
8 changes: 6 additions & 2 deletions pkgs/native_assets_cli/lib/src/config.dart
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,8 @@ class BuildOutput extends HookOutput {
/// specified in the key, which can decide if they are bundled or not.
Map<String, List<EncodedAsset>> get _encodedAssetsForLinking => {
for (final MapEntry(:key, :value)
in (_syntax.assetsForLinking ?? {}).entries)
in (_syntax.assetsForLinking ?? _syntax.assetsForLinkingOld ?? {})
.entries)
key: _parseAssets(value),
};

Expand Down Expand Up @@ -435,6 +436,7 @@ extension type EncodedAssetBuildOutputBuilder._(BuildOutputBuilder _output) {
syntax.Asset.fromJson(asset.toJson()),
);
_syntax.assetsForLinking = assetsForLinking;
_syntax.assetsForLinkingOld = assetsForLinking;
} else {
final assets = _syntax.assets ?? [];
assets.add(syntax.Asset.fromJson(asset.toJson()));
Expand Down Expand Up @@ -465,12 +467,14 @@ extension type EncodedAssetBuildOutputBuilder._(BuildOutputBuilder _output) {
String? linkInPackage,
}) {
if (linkInPackage != null) {
final assetsForLinking = _syntax.assetsForLinking ?? {};
final assetsForLinking =
_syntax.assetsForLinking ?? _syntax.assetsForLinkingOld ?? {};
final list = assetsForLinking[linkInPackage] ??= [];
for (final asset in assets) {
list.add(syntax.Asset.fromJson(asset.toJson()));
}
_syntax.assetsForLinking = assetsForLinking;
_syntax.assetsForLinkingOld = assetsForLinking;
} else {
final list = _syntax.assets ?? [];
for (final asset in assets) {
Expand Down
Loading