ui_commenter 0.1.1 copy "ui_commenter: ^0.1.1" to clipboard
ui_commenter: ^0.1.1 copied to clipboard

Published 3 months ago
SDKFlutter
PlatformAndroidiOSLinuxmacOSwebWindows
→

Metadata

Debug-only Flutter tool: tap any widget in the running app, comment on it, and copy a ready-to-paste prompt (source location, type, key, ancestry) for a coding agent.

More...

0.1.1 #

  • Overlay layout — the edit button now sits below the pick-widget button on the draggable FAB stack.
  • macOS & Windows support — desktop is now a supported target. The capture pipeline was already platform-agnostic; this hardens path handling so SelectedWidget.relativeLocation (and the File: prompt line) normalizes Windows backslash creation paths to forward slashes, matching the existing local-file heuristic. The example app gains macos/ and windows/ runners (verified building and running on macOS), and new tests cover Windows paths.
  • Widget inspector — a read-only, debug-only detail view for the selected widget, opened from a new inspect button on the comment sheet's identity frame:
    • a CustomPainter box diagram showing the widget nested in its parent with per-side padding and the widget's own w/h;
    • a geometry block (size, global offset, incoming constraints, parent offset, flex, render-object type);
    • a default-aware diagnostic-property table (debugFillProperties output with a default badge), plus copy-location / copy-properties shortcuts.
    • Reads fresh data lazily from the live Element on tap (threaded per-WidgetComment), degrading to identity-only for defunct/zero-size widgets; no public API change and no impact on the capture/copy pipeline.

0.1.0 #

  • Initial release.
  • Public API: UiCommenter, UiCommenterConfig, WidgetComment, SelectedWidget.
  • Debug-only gate (enabled && kDebugMode) that returns the child untouched and is tree-shaken out of release/profile builds.
  • Capture pipeline:
    • geometric hit test that selects the deepest project-local widget — including Text/Icon leaves whose hitTestSelf is false;
    • creation-location resolution via WidgetInspectorService with a tolerant JSON parser and a package-aware local-file heuristic (config.localPathPredicate override for monorepos/melos);
    • default prompt formatter (single + multi-widget forms) replaceable via config.promptBuilder.
  • Overlay UI: draggable toggle FAB with comment-count badge and re-open mini-FAB, selection highlight, and a controlled comment sheet with prev/next navigation, per-comment trash, Clear All, and Copy Prompt.
  • Theming: the tool UI follows the host app's light/dark theme by default; config.brightness forces the tool's brightness independently of the app (the host subtree keeps its own theme).
  • Example app and unit/widget test coverage for formatting, path classification, hit testing, and overlay list/navigation behavior.

← Metadata

0
likes
160
points
9
downloads

Documentation

API reference

Publisher

unverified uploader

Weekly Downloads

Metadata

Debug-only Flutter tool: tap any widget in the running app, comment on it, and copy a ready-to-paste prompt (source location, type, key, ancestry) for a coding agent.

Repository (GitHub)
View/report issues

Topics

#debugging #devtools #widget-inspector #developer-tools

License

MIT (license)

Dependencies

flutter

More

Packages that depend on ui_commenter

Back