[trace-debug] Marketplace release prep #20341
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Skipped Deployments
|
awelc
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
awelc
force-pushed
the
aw/trace-debug-release
branch
from
c76af51
to
fa274aa
Compare
awelc
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
| This functionality is provided by automatically including Move Trace Debugging | ||
| [extension](https://marketplace.visualstudio.com/items?itemName=mysten.move-trace-debuggin) | ||
| where you can find more detailed information about trace-debugging and the current level of support. |
There was a problem hiding this comment.
This sentence is confusing to me, and I'm not sure it's saying this is automatically included in the larger Move IDE VSCode extension, or included in the move-trace-debugging extension (which is/is not automatically included with the IDE?).
I think rewording/clarifying this may be helpful :)
awelc
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
| @@ -1,7 +1,9 @@ | |||
| # Move | |||
|
|
|||
| Provides language support for the Move programming language. For information about Move visit the | |||
| language [documentation](https://docs.sui.io/concepts/sui-move-concepts). | |||
| language [documentation](https://docs.sui.io/concepts/sui-move-concepts). It also provides early-stage | |||
There was a problem hiding this comment.
But this isn't actually true, right? It lets you run the tracing command, it requires another extension to do trace debugging.
There was a problem hiding this comment.
For all intents and purposes it's true. When someone installs Move extension (after the next update of course), the Move Trace Debugging extension is installed automatically so from developer's perspective it's this extension that provides it (much like syntax highlighting is provided by a different extension and yet we list this feature in this README) The debugging instructions comment in the "Features" section clarifies this by saying that "This functionality is provided by automatically including Move Trace Debugging extension" (I did not think we need this particular piece of info right in at the top of this README page)
There was a problem hiding this comment.
Okay, could we say "The dependent extension, ${fully qualified extension name}, also provides..." just to be explicit?
There was a problem hiding this comment.
We do say that later in the README where we describe how to actually trace-debug Move code:
"If the opened Move source file is located within a buildable project, and you have the sui binary installed, you can trace-debug execution of Move unit tests within this project. This functionality is provided by this (Move) extension automatically including the Move Trace Debugging extension"
Not sure why we should throw this particular piece of information at the user right at the start, particularly that we don't at all mention that syntax highlighting is provided the same way (through a separate extension), unless you think we should do it as well. That being said, if you think it's crucial, I am not that strongly opposed to adding this info at the beginning, but still wanted to cast my vote here
There was a problem hiding this comment.
I am going to land it as is but happy to change it (or stamp a change) if need be
external-crates/move/crates/move-analyzer/editors/code/README.md
Outdated
Show resolved
Hide resolved
awelc
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
awelc
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
Description
This PR contains changes required for the trace-debugger release in the Marketplace as an automatic dependency of the Move extension. We will publish the trace-debugger first and then update Move extension to pull it as its dependency.
Also added a new script to streamline Move extension publication to the VSCode marketplace