[native_assets_cli] Curate public classes (#2245)

This PR tries the curate the classes which are in the public API of `native_assets_cli.dart` and adds some documentation to them.

* `(Build|Link)(Input|Output)` refer to the hooks the are the input or output of.
* `Hook(Input|Output)` refer to the subclasses
* `(Build|Link|Hook)Config` refer to the input they are the config of.
* `XXXBuilder` refer to the class they build.
* `Builder|Linker` refer to the hooks they should be used in.
* `EncodedAsset` refers to protocol extensions for encoding/decoding
* `PackageMetadata|PackageUserDefines|PackageUserDefinesSource` refer to the classes where they are used.
* `ProtocolExtension` documents it's the specification for an extension of the base protocol.
* `AssetRouting|ToAppBundle|ToBuildHooks|ToLinkHook` refer to each other in the hook output.

Deprecated classes have been removed:

* `Metadata|Dependencies` these were no longer used since the `XXXBuilder` pattern.

Classes only used in `package:native_assets_builder` have been moved there:

* `Target`.

The Dart docs can be inspected by `pkgs/native_assets_cli$ dart doc .`.

TODOs:

* This PR does not yet curate extension types, extensions, and top level functions.
* This PR does not yet curate the `code_assets.dart` and `data_assets.dart` libraries.

Context:

* Work before splitting up the package: #999

Author: dcharkes

.gitignore

@@ -74,6 +74,7 @@ gradlew.bat
 
 # Directory created by dartdoc.
 doc/api/
+**/doc/api/
 
 # Avoid committing generated Javascript files:
 *.dart.js

pkgs/native_assets_builder/lib/native_assets_builder.dart

@@ -11,4 +11,5 @@ export 'src/build_runner/build_runner.dart'
 export 'src/model/build_result.dart' show BuildResult;
 export 'src/model/kernel_assets.dart';
 export 'src/model/link_result.dart' show LinkResult;
+export 'src/model/target.dart';
 export 'src/package_layout/package_layout.dart' show PackageLayout;

pkgs/native_assets_builder/lib/src/build_runner/build_runner.dart

@@ -22,8 +22,6 @@ import '../package_layout/package_layout.dart';
 import '../utils/run_process.dart';
 import 'build_planner.dart';
 
-typedef DependencyMetadata = Map<String, Metadata>;
-
 typedef InputCreator = HookInputBuilder Function();
 
 typedef BuildInputCreator = BuildInputBuilder Function();

pkgs/native_assets_builder/lib/src/model/kernel_assets.dart

@@ -14,9 +14,8 @@
 /// Dart SDK.
 library;
 
-import 'package:native_assets_cli/native_assets_cli.dart';
-
 import '../utils/yaml.dart';
+import 'target.dart';
 
 class KernelAssets {
   final List<KernelAsset> _assets;

pkgs/native_assets_cli/lib/src/target.dart renamed to pkgs/native_assets_builder/lib/src/model/target.dart

@@ -5,8 +5,7 @@
 import 'dart:ffi' show Abi;
 import 'dart:io';
 
-import 'code_assets/architecture.dart';
-import 'code_assets/os.dart';
+import 'package:native_assets_cli/code_assets.dart';
 
 final class Target implements Comparable<Target> {
   final Abi abi;
@@ -114,29 +113,30 @@ final class Target implements Comparable<Target> {
 
   Architecture get architecture => Architecture.fromAbi(abi);
 
-  OS get os => {
-    Abi.androidArm: OS.android,
-    Abi.androidArm64: OS.android,
-    Abi.androidIA32: OS.android,
-    Abi.androidX64: OS.android,
-    Abi.androidRiscv64: OS.android,
-    Abi.fuchsiaArm64: OS.fuchsia,
-    Abi.fuchsiaX64: OS.fuchsia,
-    Abi.iosArm: OS.iOS,
-    Abi.iosArm64: OS.iOS,
-    Abi.iosX64: OS.iOS,
-    Abi.linuxArm: OS.linux,
-    Abi.linuxArm64: OS.linux,
-    Abi.linuxIA32: OS.linux,
-    Abi.linuxRiscv32: OS.linux,
-    Abi.linuxRiscv64: OS.linux,
-    Abi.linuxX64: OS.linux,
-    Abi.macosArm64: OS.macOS,
-    Abi.macosX64: OS.macOS,
-    Abi.windowsArm64: OS.windows,
-    Abi.windowsIA32: OS.windows,
-    Abi.windowsX64: OS.windows,
-  }[abi]!;
+  OS get os =>
+      {
+        Abi.androidArm: OS.android,
+        Abi.androidArm64: OS.android,
+        Abi.androidIA32: OS.android,
+        Abi.androidX64: OS.android,
+        Abi.androidRiscv64: OS.android,
+        Abi.fuchsiaArm64: OS.fuchsia,
+        Abi.fuchsiaX64: OS.fuchsia,
+        Abi.iosArm: OS.iOS,
+        Abi.iosArm64: OS.iOS,
+        Abi.iosX64: OS.iOS,
+        Abi.linuxArm: OS.linux,
+        Abi.linuxArm64: OS.linux,
+        Abi.linuxIA32: OS.linux,
+        Abi.linuxRiscv32: OS.linux,
+        Abi.linuxRiscv64: OS.linux,
+        Abi.linuxX64: OS.linux,
+        Abi.macosArm64: OS.macOS,
+        Abi.macosX64: OS.macOS,
+        Abi.windowsArm64: OS.windows,
+        Abi.windowsIA32: OS.windows,
+        Abi.windowsX64: OS.windows,
+      }[abi]!;
 
   @override
   String toString() => dartVMToString();
@@ -153,15 +153,16 @@ final class Target implements Comparable<Target> {
   /// A list of supported target [Target]s from this host [os].
   List<Target> supportedTargetTargets({
     Map<OS, List<OS>> osCrossCompilation = OS.osCrossCompilationDefault,
-  }) => Target.values
-      .where(
-        (target) =>
-            // Only valid cross compilation.
-            osCrossCompilation[os]!.contains(target.os) &&
-            // And no deprecated architectures.
-            target != Target.iOSArm,
-      )
-      .sorted;
+  }) =>
+      Target.values
+          .where(
+            (target) =>
+                // Only valid cross compilation.
+                osCrossCompilation[os]!.contains(target.os) &&
+                // And no deprecated architectures.
+                target != Target.iOSArm,
+          )
+          .sorted;
 }
 
 /// Common methods for manipulating iterables of [Target]s.

pkgs/native_assets_builder/test/build_runner/concurrency_shared_test.dart

@@ -4,9 +4,9 @@
 
 import 'dart:async';
 
+import 'package:native_assets_builder/src/model/target.dart';
 import 'package:native_assets_builder/src/utils/run_process.dart'
     show RunProcessResult;
-import 'package:native_assets_cli/native_assets_cli.dart';
 import 'package:test/test.dart';
 
 import '../helpers.dart';

pkgs/native_assets_builder/test/build_runner/concurrency_shared_test_helper.dart

@@ -7,7 +7,6 @@ import 'package:logging/logging.dart';
 import 'package:native_assets_builder/native_assets_builder.dart';
 import 'package:native_assets_cli/code_assets.dart';
 import 'package:native_assets_cli/data_assets.dart';
-import 'package:native_assets_cli/native_assets_cli.dart';
 
 import '../helpers.dart';
 

pkgs/native_assets_builder/test/build_runner/fail_on_os_sdk_version_test.dart

@@ -3,8 +3,8 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:logging/logging.dart';
+import 'package:native_assets_builder/src/model/target.dart';
 import 'package:native_assets_cli/code_assets.dart';
-import 'package:native_assets_cli/native_assets_cli.dart';
 import 'package:test/test.dart';
 
 import '../helpers.dart';

pkgs/native_assets_builder/test/build_runner/helpers.dart

@@ -10,7 +10,6 @@ import 'package:logging/logging.dart';
 import 'package:native_assets_builder/native_assets_builder.dart';
 import 'package:native_assets_cli/code_assets.dart';
 import 'package:native_assets_cli/data_assets.dart';
-import 'package:native_assets_cli/native_assets_cli.dart';
 import 'package:test/test.dart';
 
 import '../helpers.dart';

pkgs/native_assets_builder/test/model/kernel_assets_test.dart

@@ -5,7 +5,7 @@
 // ignore_for_file: undefined_hidden_name
 
 import 'package:native_assets_builder/src/model/kernel_assets.dart';
-import 'package:native_assets_cli/native_assets_cli.dart';
+import 'package:native_assets_builder/src/model/target.dart';
 import 'package:test/test.dart';
 
 void main() {

pkgs/native_assets_cli/test/model/target_test.dart renamed to pkgs/native_assets_builder/test/model/target_test.dart

@@ -5,8 +5,8 @@
 import 'dart:ffi';
 import 'dart:io';
 
+import 'package:native_assets_builder/src/model/target.dart';
 import 'package:native_assets_cli/code_assets.dart';
-import 'package:native_assets_cli/native_assets_cli.dart';
 import 'package:test/test.dart';
 
 void main() {

pkgs/native_assets_cli/lib/native_assets_cli.dart

@@ -15,33 +15,31 @@ export 'src/config.dart'
         AssetRouting,
         BuildConfig,
         BuildConfigBuilder,
+        BuildConfigBuilderSetup,
         BuildInput,
+        BuildInputBuilder,
+        BuildOutput,
         BuildOutputBuilder,
         EncodedAssetBuildOutputBuilder,
         EncodedAssetLinkOutputBuilder,
         HookConfig,
         HookConfigBuilder,
         HookInput,
+        HookInputBuilder,
+        HookOutput,
+        HookOutputBuilder,
+        LinkConfig,
+        LinkConfigBuilder,
         LinkInput,
+        LinkInputBuilder,
+        LinkOutput,
         LinkOutputBuilder,
         PackageMetadata,
         ToAppBundle,
         ToBuildHooks,
         ToLinkHook;
-export 'src/config.dart'
-    show
-        BuildConfigBuilderSetup,
-        BuildInputBuilder,
-        BuildOutput,
-        HookInputBuilder,
-        HookOutput,
-        LinkInputBuilder,
-        LinkOutput;
 export 'src/encoded_asset.dart' show EncodedAsset;
 export 'src/extension.dart';
-export 'src/metadata.dart' show Metadata;
-export 'src/model/dependencies.dart';
-export 'src/target.dart' show Target;
 export 'src/test.dart';
 export 'src/user_defines.dart'
     show PackageUserDefines, PackageUserDefinesSource;

pkgs/native_assets_cli/lib/src/api/builder.dart

@@ -7,7 +7,7 @@ import 'package:logging/logging.dart';
 import '../config.dart';
 import 'linker.dart';
 
-/// A builder to be run during a build hook.
+/// A builder to be run inside `hook/build.dart`.
 ///
 /// [Builder]s should be used to build native code, download assets, and
 /// transform assets. A build hook is only rerun when its declared

pkgs/native_assets_cli/lib/src/api/linker.dart

@@ -7,7 +7,7 @@ import 'package:logging/logging.dart';
 import '../config.dart';
 import 'builder.dart';
 
-/// A linker to be run during a link hook.
+/// A builder to be run inside `hook/link.dart`.
 ///
 /// [Linker]s should be used to shrink or omit assets based on tree-shaking
 /// information. [Linker]s have access to tree-shaking information in some build