Skip to content

Adding package:listen #898

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Adding package:listen #898

wants to merge 1 commit into from

Conversation

kevmoo
Copy link
Member

@kevmoo kevmoo commented Jun 24, 2025 •
edited
Loading

@github-actions GitHub Actions
Copy link

Package publishing

Package Version Status Publish tag (post-merge)
package:args 2.7.0 already published at pub.dev
package:async 2.13.1-wip WIP (no publish necessary)
package:characters 1.4.1 ready to publish characters-v1.4.1
package:collection 1.20.0-wip WIP (no publish necessary)
package:convert 3.1.3-wip WIP (no publish necessary)
package:crypto 3.0.7-wip WIP (no publish necessary)
package:fixnum 1.2.0-wip WIP (no publish necessary)
package:lints 6.0.1-wip WIP (no publish necessary)
package:listen 1.0.0-beta.0 already published at pub.dev
package:logging 1.3.1-wip WIP (no publish necessary)
package:os_detect 2.0.4-wip WIP (no publish necessary)
package:path 1.9.2-wip WIP (no publish necessary)
package:platform 3.1.7-wip WIP (no publish necessary)
package:typed_data 1.4.1-wip WIP (no publish necessary)

Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.

@github-actions GitHub Actions
Copy link

PR Health

Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

Coverage ✔️
File Coverage
pkgs/listen/lib/listen.dart 💚 73 %

This check for test coverage is informational (issues shown here will not fail the PR).

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
pkgs/listen/lib/listen.dart
pkgs/listen/test/listen_test.dart
pkgs/listen/test/test_listenable.dart

All source files should start with a license header.

This check can be disabled by tagging the PR with skip-license-check.

lrhn
lrhn approved these changes Jun 25, 2025
View reviewed changes
pkgs/listen/lib/listen.dart
/// notifications whenever any of a list of other [Listenable]s trigger their
/// notifications.
abstract class Listenable {
/// Abstract const constructor. This constructor enables subclasses to provide
Copy link
Member

Choose a reason for hiding this comment

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

It's not abstract. Just "Const constructor".

pkgs/listen/lib/listen.dart
/// const constructors so that they can be used in const expressions.
const Listenable();

/// Return a [Listenable] that triggers when any of the given [Listenable]s
Copy link
Member

Choose a reason for hiding this comment

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

"Return" -> "Creates"

pkgs/listen/lib/listen.dart
///
/// Once the factory is called, items must not be added or removed from the
/// iterable.
/// Doing so will lead to memory leaks or exceptions.
Copy link
Member

Choose a reason for hiding this comment

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

(That's a bad API. If the class plans to iterate the argument more than once, it should copy it, or request a List. Allowing an Iterable means you can get a lazily computed collection, and if you iterate it more than once, that's going to be even more expensive than just copying to a list once and for all.)

pkgs/listen/lib/listen.dart
/// iterable.
/// Doing so will lead to memory leaks or exceptions.
///
/// The iterable may contain nulls; they are ignored.
Copy link
Member

Choose a reason for hiding this comment

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

Really not great API to allowing null if you don't use it. (A left-over from NNBD conversion?)

pkgs/listen/lib/listen.dart
///
/// See also:
///
/// * [AnimatedBuilder], a widget that uses a builder callback to rebuild
Copy link
Member

Choose a reason for hiding this comment

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

Is that class in scope? Same for ValueListenableBuilder.

Copy link
Member Author

Choose a reason for hiding this comment

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

Nope! This is a draft PR. These will need to be cleaned up!

pkgs/listen/lib/listen.dart
factory Listenable.merge(Iterable<Listenable?> listenables) =
_MergingListenable;

/// Register a closure to be called when the object notifies its listeners.
Copy link
Member

Choose a reason for hiding this comment

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

"Registers", and "Removes" below. Check using third person present tense everywhere.

@kevmoo kevmoo changed the title First prototype of pkg:listen Adding package:listen Jun 26, 2025
@kevmoo kevmoo mentioned this pull request Jun 26, 2025
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lrhn lrhn lrhn approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kevmoo @lrhn