Skip to content

[native_assets_cli] Curate public toplevel functions #2249

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 2 commits into from
Apr 28, 2025
Merged

Conversation

dcharkes
Copy link
Collaborator

This PR tries the curate the toplevel functions which are in the public API of what will be package:hooks, package:code_assets and package:data_assets.

The validate functions for the base protocol are moved into a ProtocolBase class. (These need to be public because package:native_assets_builder uses them. And these need to be in package:native_assets_cli because the test methods use them.)

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

TODOs:

  • This PR does not yet curate extension types, and extensions.

Context:

Copy link

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
native_assets_builder Breaking 0.17.0 0.18.0-wip 0.18.0 ✔️
native_assets_cli Breaking 0.17.0 0.18.0-wip 0.18.0 ✔️
API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbols
License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// 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.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/jni/lib/src/third_party/generated_bindings.dart
pkgs/objective_c/lib/src/ns_input_stream.dart

1 similar comment
Copy link

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
native_assets_builder Breaking 0.17.0 0.18.0-wip 0.18.0 ✔️
native_assets_cli Breaking 0.17.0 0.18.0-wip 0.18.0 ✔️
API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbols
License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// 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.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/jni/lib/src/third_party/generated_bindings.dart
pkgs/objective_c/lib/src/ns_input_stream.dart

Copy link

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment on lines 17 to 18
/// This class currently contains the logic of the protocol which is similar to
/// the protocol extensions: validation rules.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: it's not super clear what "similar" means here? Is this logic that is shared by all/most protocol extensions?

Base automatically changed from dartdocs-2 to main April 28, 2025 08:28
@auto-submit auto-submit bot merged commit 33999d8 into main Apr 28, 2025
31 checks passed
@auto-submit auto-submit bot deleted the dartdoc-3 branch April 28, 2025 08:38
@coveralls
Copy link

Coverage Status

coverage: 77.838% (-0.02%) from 77.858%
when pulling f10643a on dartdoc-3
into d29f1f4 on main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants