Repository navigation
Conversation
The .d.ts written by --actor-interface-file was described as containing the same types as the .ts file. It leaves out the actor class, and its createActor returns the service interface. Say so, and that the file is a reference: an import resolves to the .ts next to it.
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation consistently matches the generated snapshots and addresses the reported inaccuracies.
Review effort: Balanced
Findings: None
What changed in this PR
Clarifies the actor interface declaration file’s contents and intended reference-only usage; generated output remains unchanged.
Changes:
- Documents omitted actor class and
createActorreturn type. - Corrects the stray apostrophe in “LLMs’ contexts.”
- Explains TypeScript module resolution behavior.
| File | Description |
|---|---|
src/core/generate/index.ts |
Corrects interfaceFile API documentation. |
src/cli/icp-bindgen.ts |
Updates CLI help and module documentation. |
docs/src/content/docs/structure.md |
Details declarations and intended usage. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #158.
The
<service-name>.d.tsfrom--actor-interface-filewas described as containing "the same types" as<service-name>.ts. It leaves out the actor class and declarescreateActorto return<service-name>Interface. This corrects the description in the three places that make the claim; the generated output does not change.--actor-interface-file) and theicp-bindgenmodule docs<service-name>.tsfile"<service-name>.tsfile without the<service-name>class: itscreateActorreturns the<service-name>Interfacetype"output.actor.interfaceFilestructure.md,<service-name>.d.ts.ts; states that it is a reference and not imported, since an import of./<service-name>resolves to the.tsnext to itThe CLI help snapshot (
tests/snapshots/cli/help.snapshot) moves with the help text. Checked against theexampleandhello_worldsnapshots, and withtsc --traceResolutionfor the import resolution.🤖 Generated with Claude Code