Skip to content
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.

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

Add VSCode extension documentation #20385

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open

Add VSCode extension documentation #20385

wants to merge 23 commits into from

Conversation

tedks
Copy link

@tedks tedks commented Nov 22, 2024

Description

  • Guides:
    • Mentioning all of these on the sui-install page, as a new section called "Install Sui developer tools"
    • Updating the dev-cheat-sheet
  • References:
    • Documentation of all the Move LSP features and how to use them
    • Documentation of all the debugger features and how to use them

Test plan

How did you test the new or updated feature?

  • Manual inspection of docs

Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • Indexer:
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK:
  • REST API:

Copy link

vercel bot commented Nov 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 22, 2024 5:42pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Nov 22, 2024 5:42pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Nov 22, 2024 5:42pm
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Nov 22, 2024 5:42pm

@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 03:18 — with GitHub Actions Inactive
@github-actions github-actions bot added the Type: Documentation Improvements or additions to documentation label Nov 22, 2024
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:04 — with GitHub Actions Inactive
Copy link
Contributor

@ronny-mysten ronny-mysten left a comment

Choose a reason for hiding this comment

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

Looks good! The docs/sidebars/references.js file needs to be updated to include the new pages, as well. Puts the pages on left nav.

docs/content/references/cli/cheatsheet.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/debugger.mdx Show resolved Hide resolved
docs/content/references/ide/debugger.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/debugger.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:11 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:12 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:12 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:13 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:14 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:14 — with GitHub Actions Inactive
Co-authored-by: ronny-mysten <[email protected]>
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:15 — with GitHub Actions Inactive
Co-authored-by: ronny-mysten <[email protected]>
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:32 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:33 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:34 — with GitHub Actions Inactive
Co-authored-by: ronny-mysten <[email protected]>
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:38 — with GitHub Actions Inactive
```bash
cargo install --git https://github.com/MystenLabs/sui.git sui-move-lsp
```
By default, the Move extension expects to find the `move-analyzer` binary in `~/.sui/bin`. You can either copy the binary here, or configure the extension to use a different path.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to worry about specifying the location for windows users? I'm guessing not since the only way they can install it is with choco I'm guessing?


![Stepping through code execution](./images/debugger_running.png)

Move Trace Debugger supports standard debugging features like step over, step into, step out, continue, and stop. You can step through normal code, and also Move macros.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we have a disclaimer here (or maybe we have a more general one elsewhere) that e.g., macros are supported, but are a known pain point that we are working on improving still.

Copy link
Contributor

@ronny-mysten ronny-mysten left a comment

Choose a reason for hiding this comment

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

Approving to carry forward after addressing any other comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants