Skip to content

[hooks] Add documentation on running the debugger #2706

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
Merged
merged 6 commits into from
Oct 15, 2025
Merged

[hooks] Add documentation on running the debugger #2706

merged 6 commits into from
Oct 15, 2025

Conversation

dcharkes
Copy link
Collaborator

Closes: #2702

@dcharkes dcharkes requested review from goderbauer and mosuem October 14, 2025 17:57
@github-actions GitHub Actions
Copy link

Package publishing

Package Version Status Publish tag (post-merge)
package:code_assets 0.19.8 already published at pub.dev
package:data_assets 0.19.3 already published at pub.dev
package:ffi 2.1.5-wip WIP (no publish necessary)
package:hooks 0.20.4 ready to publish hooks-v0.20.4
package:hooks_runner 0.23.1 already published at pub.dev
package:native_toolchain_c 0.17.2 already published at pub.dev
package:swift2objc 0.1.0 already published at pub.dev
package:swiftgen 0.1.1 already published at pub.dev

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

@github-actions GitHub Actions
Copy link

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
hooks None 0.20.3 0.20.4 0.20.3 ✔️

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

Changelog Entry ✔️
Package Changed Files

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

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

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 symbol Leaking sources

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

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/objective_c/lib/src/ns_input_stream.dart

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

@coveralls
Copy link

coveralls commented Oct 14, 2025 •
edited
Loading

Coverage Status

coverage: 71.853%. first build
when pulling 186dd75 on hooks-debugging
into f3d890c on main.

mosuem
mosuem reviewed Oct 14, 2025
View reviewed changes
goderbauer
goderbauer approved these changes Oct 15, 2025
View reviewed changes
Copy link
Contributor

@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!

pkgs/hooks/lib/src/api/build_and_link.dart Outdated
/// Again, make sure to replace `your_package_name`, and `some_hash` with the
/// actual paths from your project. After setting this up, you can run the
/// "Debug Link Hook" configuration from the "Run and Debug" view in VS Code.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: drop this blank line?

pkgs/hooks/lib/src/api/build_and_link.dart Outdated
///
/// * `input.json`: The configuration and data passed into your link hook.
/// * `output.json`: The JSON data that your link hook produced.
/// * `stdout.txt`: Any standard output from your script.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// * `stdout.txt`: Any standard output from your script.
/// * `stdout.txt`: Any standard output from your link hook.

Let's stay with one terminology?

pkgs/hooks/lib/src/api/build_and_link.dart Outdated
/// Again, make sure to replace `your_package_name`, and `some_hash` with the
/// actual paths from your project. After setting this up, you can run the
/// "Debug Build Hook" configuration from the "Run and Debug" view in VS Code.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: drop blank line?

pkgs/hooks/lib/src/api/build_and_link.dart Outdated
Comment on lines 92 to 93
/// specific
/// to your hook's execution. The path is of the form
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: strange line breaking?

pkgs/hooks/lib/src/api/build_and_link.dart Outdated
///
/// * `input.json`: The configuration and data passed into your build hook.
/// * `output.json`: The JSON data that your build hook produced.
/// * `stdout.txt`: Any standard output from your script.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// * `stdout.txt`: Any standard output from your script.
/// * `stdout.txt`: Any standard output from your build hook.

Let's stay with one terminology?

pkgs/hooks/doc/debugging.md Outdated
build configuration.
* `output.json`: This file stores the JSON data that your build hook *produced*
as its result.
* `stdout.txt`: Captures any standard output from your script. This is where
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* `stdout.txt`: Captures any standard output from your script. This is where
* `stdout.txt`: Captures any standard output from your build hook. This is where

Let's stay with one terminology?

pkgs/hooks/doc/debugging.md Outdated
@@ -0,0 +1,86 @@
# Debugging Dart Build Hooks
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: technically, all that's said in here also applies to link hooks. Should we note that somewhere? Or is the omission on purpose because link hooks aren't launched yet? Even then, a short note that this also applies in the same way to the experimental link hooks may be useful.

@auto-submit auto-submit bot merged commit d11195c into main Oct 15, 2025
28 checks passed
@auto-submit auto-submit bot deleted the hooks-debugging branch October 15, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mosuem mosuem mosuem left review comments

@goderbauer goderbauer goderbauer approved these changes

Assignees

No one assigned

Labels

autosubmit package:hooks

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[hooks] Document how to run the debugger

4 participants

@dcharkes @coveralls @goderbauer @mosuem