[native_assets_cli] Add Builder and Linker interfaces and docs (#…

…1174)

This PR adds an opinionated `Builder` and `Linker` interface with documentation on what builders and linkers should be used for.

Closes: #995

(Also, flips all versions back to WIP, now that the link hooks have landed in both Dart and Flutter.)

pkgs/native_assets_builder/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.1-wip
+
+- Nothing yet.
+
 ## 0.7.0
 
 - Add support for `hook/link.dart` including dry runs.

pkgs/native_assets_builder/pubspec.yaml

@@ -1,10 +1,10 @@
 name: native_assets_builder
 description: >-
   This package is the backend that invokes build hooks.
-version: 0.7.0
+version: 0.7.1-wip
 repository: https://github.com/dart-lang/native/tree/main/pkgs/native_assets_builder
 
-# publish_to: none
+publish_to: none
 
 environment:
   sdk: '>=3.3.0 <4.0.0'
@@ -13,9 +13,9 @@ dependencies:
   collection: ^1.18.0
   graphs: ^2.3.1
   logging: ^1.2.0
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../native_assets_cli/
   package_config: ^2.1.0
   yaml: ^3.1.2
   yaml_edit: ^2.1.0

pkgs/native_assets_builder/test_data/add_asset_link/hook/build.dart

@@ -22,8 +22,8 @@ void main(List<String> arguments) async {
       dartBuildFiles: ['hook/build.dart'],
       linkModePreference: LinkModePreference.dynamic,
     ).run(
-      buildConfig: config,
-      buildOutput: output,
+      config: config,
+      output: output,
       logger: logger,
       linkInPackage: 'add_asset_link',
     );

pkgs/native_assets_builder/test_data/add_asset_link/pubspec.yaml

@@ -10,12 +10,12 @@ environment:
 dependencies:
   logging: ^1.1.1
   meta: ^1.12.0
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #   path: ../../../native_assets_cli/
-  native_toolchain_c: ^0.4.2
-  # native_toolchain_c:
-  #   path: ../../../native_toolchain_c/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
+  # native_toolchain_c: ^0.4.2
+  native_toolchain_c:
+    path: ../../../native_toolchain_c/
 
 dev_dependencies:
   lints: ^3.0.0

pkgs/native_assets_builder/test_data/complex_link/pubspec.yaml

@@ -12,9 +12,9 @@ dependencies:
   complex_link_helper:
     path: ../complex_link_helper/
   logging: ^1.1.1
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #   path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
 
 dev_dependencies:
   lints: ^3.0.0

pkgs/native_assets_builder/test_data/complex_link_helper/pubspec.yaml

@@ -10,9 +10,9 @@ environment:
 dependencies:
   cli_config: ^0.2.0
   logging: ^1.1.1
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #   path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
 
 dev_dependencies:
   lints: ^3.0.0

pkgs/native_assets_builder/test_data/cyclic_package_1/pubspec.yaml

@@ -10,9 +10,9 @@ environment:
 dependencies:
   cyclic_package_2:
     path: ../cyclic_package_2
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
   yaml: ^3.1.1
   yaml_edit: ^2.1.0
 

pkgs/native_assets_builder/test_data/cyclic_package_2/pubspec.yaml

@@ -10,9 +10,9 @@ environment:
 dependencies:
   cyclic_package_1:
     path: ../cyclic_package_1
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
   yaml: ^3.1.1
   yaml_edit: ^2.1.0
 

pkgs/native_assets_builder/test_data/drop_dylib_link/hook/build.dart

@@ -24,8 +24,8 @@ void main(List<String> arguments) async {
       dartBuildFiles: ['hook/build.dart'],
       linkModePreference: LinkModePreference.dynamic,
     ).run(
-      buildConfig: config,
-      buildOutput: output,
+      config: config,
+      output: output,
       logger: logger,
       linkInPackage: packageName,
     );
@@ -39,8 +39,8 @@ void main(List<String> arguments) async {
       dartBuildFiles: ['hook/build.dart'],
       linkModePreference: LinkModePreference.dynamic,
     ).run(
-      buildConfig: config,
-      buildOutput: output,
+      config: config,
+      output: output,
       logger: logger,
       linkInPackage: packageName,
     );

pkgs/native_assets_builder/test_data/drop_dylib_link/pubspec.yaml

@@ -10,12 +10,12 @@ environment:
 dependencies:
   logging: ^1.1.1
   meta: ^1.12.0
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #   path: ../../../native_assets_cli/
-  native_toolchain_c: ^0.4.2
-  # native_toolchain_c:
-  #   path: ../../../native_toolchain_c/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
+  # native_toolchain_c: ^0.4.2
+  native_toolchain_c:
+    path: ../../../native_toolchain_c/
 
 dev_dependencies:
   lints: ^3.0.0

pkgs/native_assets_builder/test_data/native_add/hook/build.dart

@@ -19,8 +19,8 @@ void main(List<String> arguments) async {
       dartBuildFiles: ['hook/build.dart'],
     );
     await cbuilder.run(
-      buildConfig: config,
-      buildOutput: output,
+      config: config,
+      output: output,
       logger: Logger('')
         ..level = Level.ALL
         ..onRecord.listen((record) {

pkgs/native_assets_builder/test_data/native_add/pubspec.yaml

@@ -9,12 +9,12 @@ environment:
 
 dependencies:
   logging: ^1.1.1
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
-  native_toolchain_c: ^0.4.2
-  # native_toolchain_c:
-  #   path: ../../../native_toolchain_c/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
+  # native_toolchain_c: ^0.4.2
+  native_toolchain_c:
+    path: ../../../native_toolchain_c/
 
 dev_dependencies:
   ffigen: ^8.0.2

pkgs/native_assets_builder/test_data/native_add_add_source/hook/build.dart

@@ -20,8 +20,8 @@ void main(List<String> arguments) async {
       dartBuildFiles: ['hook/build.dart'],
     );
     await cbuilder.run(
-      buildConfig: config,
-      buildOutput: output,
+      config: config,
+      output: output,
       logger: Logger('')
         ..level = Level.ALL
         ..onRecord.listen((record) {

pkgs/native_assets_builder/test_data/native_add_add_source/pubspec.yaml

@@ -9,12 +9,12 @@ environment:
 
 dependencies:
   logging: ^1.1.1
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
-  native_toolchain_c: ^0.4.2
-  # native_toolchain_c:
-  #   path: ../../../native_toolchain_c/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
+  # native_toolchain_c: ^0.4.2
+  native_toolchain_c:
+    path: ../../../native_toolchain_c/
 
 dev_dependencies:
   ffigen: ^8.0.2

pkgs/native_assets_builder/test_data/native_subtract/hook/build.dart

@@ -19,8 +19,8 @@ void main(List<String> arguments) async {
       dartBuildFiles: ['hook/build.dart'],
     );
     await cbuilder.run(
-      buildConfig: config,
-      buildOutput: output,
+      config: config,
+      output: output,
       logger: Logger('')
         ..level = Level.ALL
         ..onRecord.listen((record) {

pkgs/native_assets_builder/test_data/native_subtract/pubspec.yaml

@@ -9,12 +9,12 @@ environment:
 
 dependencies:
   logging: ^1.1.1
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
-  native_toolchain_c: ^0.4.2
-  # native_toolchain_c:
-  #   path: ../../../native_toolchain_c/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
+  # native_toolchain_c: ^0.4.2
+  native_toolchain_c:
+    path: ../../../native_toolchain_c/
 
 dev_dependencies:
   ffigen: ^8.0.2

pkgs/native_assets_builder/test_data/no_asset_for_link/pubspec.yaml

@@ -10,9 +10,9 @@ environment:
 dependencies:
   logging: ^1.1.1
   meta: ^1.12.0
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #   path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
 
 dev_dependencies:
   lints: ^3.0.0

pkgs/native_assets_builder/test_data/package_reading_metadata/pubspec.yaml

@@ -8,9 +8,9 @@ environment:
   sdk: '>=3.3.0 <4.0.0'
 
 dependencies:
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
   package_with_metadata:
     path: ../package_with_metadata/
   yaml: ^3.1.1

pkgs/native_assets_builder/test_data/package_with_metadata/pubspec.yaml

@@ -8,9 +8,9 @@ environment:
   sdk: '>=3.3.0 <4.0.0'
 
 dependencies:
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
   yaml: ^3.1.1
   yaml_edit: ^2.1.0
 

pkgs/native_assets_builder/test_data/simple_link/pubspec.yaml

@@ -10,9 +10,9 @@ environment:
 dependencies:
   cli_config: ^0.2.0
   logging: ^1.1.1
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #   path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
 
 dev_dependencies:
   lints: ^3.0.0

pkgs/native_assets_builder/test_data/wrong_build_output/pubspec.yaml

@@ -8,9 +8,9 @@ environment:
   sdk: '>=3.3.0 <4.0.0'
 
 dependencies:
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
   yaml: ^3.1.1
   yaml_edit: ^2.1.0
 

pkgs/native_assets_builder/test_data/wrong_build_output_2/pubspec.yaml

@@ -8,9 +8,9 @@ environment:
   sdk: '>=3.3.0 <4.0.0'
 
 dependencies:
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
   yaml: ^3.1.1
   yaml_edit: ^2.1.0
 

pkgs/native_assets_builder/test_data/wrong_build_output_3/pubspec.yaml

@@ -8,9 +8,9 @@ environment:
   sdk: '>=3.3.0 <4.0.0'
 
 dependencies:
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
   yaml: ^3.1.1
   yaml_edit: ^2.1.0
 

pkgs/native_assets_builder/test_data/wrong_namespace_asset/pubspec.yaml

@@ -8,9 +8,9 @@ environment:
   sdk: '>=3.3.0 <4.0.0'
 
 dependencies:
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #  path: ../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../native_assets_cli/
   yaml: ^3.1.1
   yaml_edit: ^2.1.0
 

pkgs/native_assets_cli/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.6.1-wip
+
+- Introduce `Builder` and `Linker` interface.
+
 ## 0.6.0
 
 - Add support for `hook/link.dart`.

pkgs/native_assets_cli/example/build/local_asset/pubspec.yaml

@@ -10,9 +10,9 @@ environment:
 
 dependencies:
   logging: ^1.1.1
-  native_assets_cli: ^0.6.0
-  # native_assets_cli:
-  #   path: ../../../../native_assets_cli/
+  # native_assets_cli: ^0.6.0
+  native_assets_cli:
+    path: ../../../../native_assets_cli/
 
 dev_dependencies:
   ffigen: ^8.0.2

pkgs/native_assets_cli/example/build/native_add_library/hook/build.dart

@@ -18,8 +18,8 @@ void main(List<String> args) async {
       dartBuildFiles: ['hook/build.dart'],
     );
     await cbuilder.run(
-      buildConfig: config,
-      buildOutput: output,
+      config: config,
+      output: output,
       logger: Logger('')
         ..level = Level.ALL
         ..onRecord.listen((record) => print(record.message)),