[hooks] [code_assets] Surface input.packageRoot in more places (#2733)

dcharkes · web-flow · commit 93c6972b0eb3 · 2025-10-27T09:10:04.000-03:00
diff --git a/pkgs/code_assets/CHANGELOG.md b/pkgs/code_assets/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.19.10
+
+- Document `input.packageRoot` in more places.
+
 ## 0.19.9
 
 - Document that asset file paths must be absolute.
diff --git a/pkgs/code_assets/README.md b/pkgs/code_assets/README.md
@@ -24,17 +24,20 @@ import 'package:hooks/hooks.dart';
 
 void main(List<String> args) async {
   await build(args, (input, output) async {
-    final packageName = input.packageName;
-    final assetPath = input.outputDirectory.resolve('...');
-
-    output.assets.code.add(
-      CodeAsset(
-        package: packageName,
-        name: '...',
-        linkMode: DynamicLoadingBundled(),
-        file: assetPath,
-      ),
-    );
+    if (input.config.buildCodeAssets) {
+      final packageName = input.packageName;
+      final assetPathInPackage = input.packageRoot.resolve('...');
+      final assetPathDownload = input.outputDirectoryShared.resolve('...');
+
+      output.assets.code.add(
+        CodeAsset(
+          package: packageName,
+          name: '...',
+          linkMode: DynamicLoadingBundled(),
+          file: assetPathInPackage,
+        ),
+      );
+    }
   });
 }
 ```
diff --git a/pkgs/code_assets/example/api/code_assets_snippet.dart b/pkgs/code_assets/example/api/code_assets_snippet.dart
@@ -2,23 +2,30 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+// ignore_for_file: unused_local_variable
+
+// dart format width=76
+
 // snippet-start
 import 'package:code_assets/code_assets.dart';
 import 'package:hooks/hooks.dart';
 
 void main(List<String> args) async {
   await build(args, (input, output) async {
-    final packageName = input.packageName;
-    final assetPath = input.outputDirectory.resolve('...');
+    if (input.config.buildCodeAssets) {
+      final packageName = input.packageName;
+      final assetPathInPackage = input.packageRoot.resolve('...');
+      final assetPathDownload = input.outputDirectoryShared.resolve('...');
 
-    output.assets.code.add(
-      CodeAsset(
-        package: packageName,
-        name: '...',
-        linkMode: DynamicLoadingBundled(),
-        file: assetPath,
-      ),
-    );
+      output.assets.code.add(
+        CodeAsset(
+          package: packageName,
+          name: '...',
+          linkMode: DynamicLoadingBundled(),
+          file: assetPathInPackage,
+        ),
+      );
+    }
   });
 }
 
diff --git a/pkgs/code_assets/lib/code_assets.dart b/pkgs/code_assets/lib/code_assets.dart
@@ -28,17 +28,20 @@
 ///
 /// void main(List<String> args) async {
 ///   await build(args, (input, output) async {
-///     final packageName = input.packageName;
-///     final assetPath = input.outputDirectory.resolve('...');
+///     if (input.config.buildCodeAssets) {
+///       final packageName = input.packageName;
+///       final assetPathInPackage = input.packageRoot.resolve('...');
+///       final assetPathDownload = input.outputDirectoryShared.resolve('...');
 ///
-///     output.assets.code.add(
-///       CodeAsset(
-///         package: packageName,
-///         name: '...',
-///         linkMode: DynamicLoadingBundled(),
-///         file: assetPath,
-///       ),
-///     );
+///       output.assets.code.add(
+///         CodeAsset(
+///           package: packageName,
+///           name: '...',
+///           linkMode: DynamicLoadingBundled(),
+///           file: assetPathInPackage,
+///         ),
+///       );
+///     }
 ///   });
 /// }
 /// ```
diff --git a/pkgs/code_assets/pubspec.yaml b/pkgs/code_assets/pubspec.yaml
@@ -3,7 +3,7 @@ description: >-
   This library contains the hook protocol specification for bundling native code
   with Dart packages.
 
-version: 0.19.9
+version: 0.19.10
 
 repository: https://github.com/dart-lang/native/tree/main/pkgs/code_assets
 
diff --git a/pkgs/data_assets/CHANGELOG.md b/pkgs/data_assets/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.19.5
+
+- Document `input.packageRoot` in more places.
+
 ## 0.19.4
 
 - Document that asset file paths must be absolute.
diff --git a/pkgs/data_assets/README.md b/pkgs/data_assets/README.md
@@ -18,12 +18,19 @@ import 'package:hooks/hooks.dart';
 
 void main(List<String> args) async {
   await build(args, (input, output) async {
-    final packageName = input.packageName;
-    final assetPath = input.outputDirectory.resolve('...');
-
-    output.assets.data.add(
-      DataAsset(package: packageName, name: '...', file: assetPath),
-    );
+    if (input.config.buildDataAssets) {
+      final packageName = input.packageName;
+      final assetPathInPackage = input.packageRoot.resolve('...');
+      final assetPathDownload = input.outputDirectoryShared.resolve('...');
+
+      output.assets.data.add(
+        DataAsset(
+          package: packageName,
+          name: '...',
+          file: assetPathInPackage,
+        ),
+      );
+    }
   });
 }
 ```
diff --git a/pkgs/data_assets/example/api/data_assets_snippet.dart b/pkgs/data_assets/example/api/data_assets_snippet.dart
@@ -4,18 +4,27 @@
 
 // dart format width=76
 
+// ignore_for_file: unused_local_variable
+
 // snippet-start
 import 'package:data_assets/data_assets.dart';
 import 'package:hooks/hooks.dart';
 
 void main(List<String> args) async {
   await build(args, (input, output) async {
-    final packageName = input.packageName;
-    final assetPath = input.outputDirectory.resolve('...');
+    if (input.config.buildDataAssets) {
+      final packageName = input.packageName;
+      final assetPathInPackage = input.packageRoot.resolve('...');
+      final assetPathDownload = input.outputDirectoryShared.resolve('...');
 
-    output.assets.data.add(
-      DataAsset(package: packageName, name: '...', file: assetPath),
-    );
+      output.assets.data.add(
+        DataAsset(
+          package: packageName,
+          name: '...',
+          file: assetPathInPackage,
+        ),
+      );
+    }
   });
 }
 
diff --git a/pkgs/data_assets/lib/data_assets.dart b/pkgs/data_assets/lib/data_assets.dart
@@ -19,12 +19,19 @@
 ///
 /// void main(List<String> args) async {
 ///   await build(args, (input, output) async {
-///     final packageName = input.packageName;
-///     final assetPath = input.outputDirectory.resolve('...');
+///     if (input.config.buildDataAssets) {
+///       final packageName = input.packageName;
+///       final assetPathInPackage = input.packageRoot.resolve('...');
+///       final assetPathDownload = input.outputDirectoryShared.resolve('...');
 ///
-///     output.assets.data.add(
-///       DataAsset(package: packageName, name: '...', file: assetPath),
-///     );
+///       output.assets.data.add(
+///         DataAsset(
+///           package: packageName,
+///           name: '...',
+///           file: assetPathInPackage,
+///         ),
+///       );
+///     }
 ///   });
 /// }
 /// ```
diff --git a/pkgs/data_assets/pubspec.yaml b/pkgs/data_assets/pubspec.yaml
@@ -3,7 +3,7 @@ description: >-
   This library contains the hook protocol specification for bundling data assets
   with Dart packages.
 
-version: 0.19.4
+version: 0.19.5
 
 repository: https://github.com/dart-lang/native/tree/main/pkgs/data_assets
 
diff --git a/pkgs/hooks/CHANGELOG.md b/pkgs/hooks/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.20.5
+
+- Document `input.packageRoot` in more places.
+
 ## 0.20.4
 
 - Improved documentation on debugging and added a documentation index.
diff --git a/pkgs/hooks/README.md b/pkgs/hooks/README.md
@@ -50,6 +50,33 @@ void main(List<String> args) async {
 See the full example in [package:code_assets
 example/sqlite/](../code_assets/example/sqlite/).
 
+When bundling precompiled dynamic libraries, use `package:code_assets` directly:
+
+<!-- file://./../code_assets/example/api/code_assets_snippet.dart -->
+```dart
+import 'package:code_assets/code_assets.dart';
+import 'package:hooks/hooks.dart';
+
+void main(List<String> args) async {
+  await build(args, (input, output) async {
+    if (input.config.buildCodeAssets) {
+      final packageName = input.packageName;
+      final assetPathInPackage = input.packageRoot.resolve('...');
+      final assetPathDownload = input.outputDirectoryShared.resolve('...');
+
+      output.assets.code.add(
+        CodeAsset(
+          package: packageName,
+          name: '...',
+          linkMode: DynamicLoadingBundled(),
+          file: assetPathInPackage,
+        ),
+      );
+    }
+  });
+}
+```
+
 For more information see [dart.dev/tools/hooks](https://dart.dev/tools/hooks).
 
 ## Documentation
diff --git a/pkgs/hooks/example/link/package_with_assets/hook/link.dart b/pkgs/hooks/example/link/package_with_assets/hook/link.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'dart:convert';
 import 'dart:io';
 
diff --git a/pkgs/hooks/example/link/package_with_assets/lib/package_with_assets.dart b/pkgs/hooks/example/link/package_with_assets/lib/package_with_assets.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:meta/meta.dart';
 
 //TODO: Actually use the assets, needs the AssetBundle interface for Dart. See
diff --git a/pkgs/hooks/lib/hooks.dart b/pkgs/hooks/lib/hooks.dart
@@ -15,7 +15,8 @@
 /// The second hook available in this API is the link hook  (`hook/link.dart`).
 /// The main entrypoint for link hooks is [link].
 ///
-/// Hooks can for example be used to bundle native code with a Dart package:
+/// Hooks can for example be used to bundle native source code with a Dart
+/// package:
 ///
 /// <!-- file://./../../code_assets/example/sqlite/hook/build.dart -->
 /// ```dart
@@ -42,6 +43,33 @@
 /// }
 /// ```
 ///
+/// Hooks can also be used to bundle precompiled native code with a package:
+///
+/// <!-- file://./../../code_assets/example/api/code_assets_snippet.dart -->
+/// ```dart
+/// import 'package:code_assets/code_assets.dart';
+/// import 'package:hooks/hooks.dart';
+///
+/// void main(List<String> args) async {
+///   await build(args, (input, output) async {
+///     if (input.config.buildCodeAssets) {
+///       final packageName = input.packageName;
+///       final assetPathInPackage = input.packageRoot.resolve('...');
+///       final assetPathDownload = input.outputDirectoryShared.resolve('...');
+///
+///       output.assets.code.add(
+///         CodeAsset(
+///           package: packageName,
+///           name: '...',
+///           linkMode: DynamicLoadingBundled(),
+///           file: assetPathInPackage,
+///         ),
+///       );
+///     }
+///   });
+/// }
+/// ```
+///
 /// For more information see
 /// [dart.dev/tools/hooks](https://dart.dev/tools/hooks).
 library;
diff --git a/pkgs/hooks/pubspec.yaml b/pkgs/hooks/pubspec.yaml
@@ -3,7 +3,7 @@ description: >-
   A library that contains a Dart API for the JSON-based protocol for
   `hook/build.dart` and `hook/link.dart`.
 
-version: 0.20.4
+version: 0.20.5
 
 repository: https://github.com/dart-lang/native/tree/main/pkgs/hooks
 
diff --git a/pkgs/hooks_runner/test_data/flag_enthusiast_1/lib/src/flag_enthusiast_1_base.dart b/pkgs/hooks_runner/test_data/flag_enthusiast_1/lib/src/flag_enthusiast_1_base.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:fun_with_flags/fun_with_flags.dart';
 import 'package:meta/meta.dart' show RecordUse;
 
diff --git a/pkgs/hooks_runner/test_data/flag_enthusiast_2/lib/src/flag_enthusiast_2_base.dart b/pkgs/hooks_runner/test_data/flag_enthusiast_2/lib/src/flag_enthusiast_2_base.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:fun_with_flags/fun_with_flags.dart';
 import 'package:meta/meta.dart' show RecordUse;
 
diff --git a/pkgs/hooks_runner/test_data/use_all_api/hook/link.dart b/pkgs/hooks_runner/test_data/use_all_api/hook/link.dart
@@ -18,6 +18,7 @@ void main(List<String> args) async {
     // b. hook-specific
     input.assets.code; // link only
     input.assets.data; // link only
+    // ignore: experimental_member_use
     input.recordedUsagesFile; // link only
     // c. target config
     // c.2. per asset
