Show TypeScript bindings deprecation in help docs - #2725
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Makes TypeScript bindings deprecation visible in CLI help and published documentation.
Changes:
- Marks the TypeScript bindings subcommand as deprecated.
- Directs users to the JavaScript Stellar SDK CLI.
- Regenerates full help documentation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
cmd/soroban-cli/src/commands/contract/bindings.rs |
Adds deprecation help text and migration link. |
FULL_HELP_DOCS.md |
Publishes the updated generated help. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
fnando
force-pushed
the
deprecate-typescript-bindings-help
branch
from
September 15, 2026 22:58
0cb7f7c to
f40e503
Compare
leighmcculloch
approved these changes
Sep 15, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (1)
cmd/soroban-cli/src/commands/contract/bindings.rs:15
- This user-visible command change has no automated coverage. Please add soroban-test integration assertions for both
stellar contract bindings --helpandstellar contract bindings typescript --help, including the deprecation text and migration URL; regeneratingFULL_HELP_DOCS.mddoes not protect those CLI outputs from regression.
/// ⚠️ Deprecated, use the JavaScript Stellar SDK instead (https://github.com/stellar/js-stellar-sdk#cli). Generate a TypeScript / JavaScript package
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.
What
Follow-up to #2724. Surfaces the
stellar contract bindings typescriptdeprecation in the command's help output and the published docs. Updates the subcommand's doc comment to mark it(deprecated)and point to the JavaScript Stellar SDK CLI (https://github.com/stellar/js-stellar-sdk#cli), and regeneratesFULL_HELP_DOCS.md.Why
#2724 only printed the deprecation warning at runtime. Users checking
--helpor the published documentation still saw no indication the command is deprecated. This makes the deprecation visible in the subcommand list, instellar contract bindings typescript --help, and on the docs site.Known limitations
N/A