aptos-move-analyzer

Table of Contents

• Introduction
• Features
• Changelog
• Installation
• Support

Introduction

The aptos-move-analyzer is a Visual Studio Code plugin for Aptos Move language developed by MoveBit.

Features

Here are some of the features of the aptos-move-analyzer Visual Studio Code extension. To see them, open a Move source file (a file with a .move file extension) and:

• See Move keywords and types highlighted in appropriate colors.
• As you type, Move keywords will appear as completion suggestions.
• If the opened Move source file is located within a buildable project (a Move.toml file can be found in one of its parent directories), the following advanced features will also be available:
  • compiler diagnostics
  • aptos commands line tool(you need install Aptos Client CLI locally)
  • aptos project template
  • go to definition
  • go to references
  • type on hover
  • inlay hints
  • formatter for move file
  • ...

Changelog

Changelog

Installation

Note:

1.If you already have installed move-analyzer or sui-move-analyzer, please disable them before installing aptos-move-analyzer, because it may have some conflicts.

2.You need to install Aptos CLI refer as https://aptos.web3doc.top/cli-tools/aptos-cli-tool/install-aptos-cli before install aptos-move-analyzer.

3.If you are unable to install versions 0.3 and above, for example, if you see version 0.3.0 but after installation, only version 0.2.0 is available, it may be due to an outdated version of Visual Studio Code. Versions 0.3 and above require Visual Studio Code version 1.85 or higher. You can check the current version of Visual Studio Code by navigating to "Help" and then selecting "About."

How to Install (Must Read)

The aptos-move-analyzer Visual Studio Code extension works via two components: the aptos-move-analyzer language server and the extension itself.

Starting from version v1.0.2, this plugin will automatically download the lsp-server, namely the aptos-move-analyzer binary package, when you click to install it from the vscode plugin marketplace. By default, it will be downloaded to the ~/.cargo/bin directory. If for some reason it does not download successfully, you can choose the manual download method explained next.

1. Installing the aptos-move-analyzer language server

aptos-move-analyzer language server may be installed in one of two ways:

A. Download the precompiled binaries for the aptos-move-analyzer language server(Recommended)

MacOS & Ubuntu

1.Download binary files for the corresponding platform from aptos-move-analyzer-releases-pages.

2.Rename it to aptos-move-analyzer.

3.Make sure aptos-move-analyzer can be found in your PATH environment.

After completing the above steps, restart VSCode.

B. Use Cargo

The aptos-move-analyzer language server is a Rust program, so we suggest installing it via cargo. If you haven't installed the Rust toolchain, you can install Rustup, which will install the latest stable Rust toolchain including cargo.

Execute the below command to install aptos_move_analyzer

cargo install --git https://github.com/movebit/aptos-move-analyzer --branch release/aptos-move-analyzer aptos-move-analyzer

The installation may take some time, often several minutes. After installation, the aptos-move-analyzer program is in your cargo binary directory. On macOS and Linux, this directory is usually ~/.cargo/bin. You should make sure this location is in your PATH environment variable via export PATH="$PATH:~/.cargo/bin" .

To confirm that you've installed the language server program successfully, execute aptos-move-analyzer --version on the command line. You should see the output aptos-move-analyzer version number(1.0.1). If you don't see it, check the troubleshooting section at the end.

After completing the above steps, restart VSCode.

2. Installing the aptos-move-analyzer Visual Studio Code extension

1. Open a new window in any Visual Studio Code application version 1.55.2 or greater.
2. Open the command palette (⇧⌘P on macOS, or use the menu item View > Command Palette...) and type Extensions: Install Extensions. This will open a panel named Extensions in the sidebar of your Visual Studio Code window.
3. In the search bar labeled Search Extensions in Marketplace, type aptos-move-analyzer. The aptos-move-analyzer extension should appear in the list below the search bar. Click Install.
4. Open any Aptos Move project directory(where the Move.toml is located), and open or create files that end in .move, you should see that keywords and types appear in different colors, and you can try other features.

After completing the above steps, restart VSCode.

At this point, the entire plugin is ready to use. The plugin offers a variety of settings that you can access by going to (Preferences > Settings*). Search for the aptos-move-analyzer setting.

3. Mandatory reading, regarding the use of formatting

1. Once both the language server and the aptos-move-analyzer plugin from the vscode plugin marketplace are installed, the formatting feature is not enabled by default. You will need to enable the corresponding feature in the settings(Preferences > Settings*. Search for the aptos-move-analyzer setting).

2. To format a .move file, simply open it and right-click to select 'Format Document' for a one-click formatting.

3. If you wish to study or raise an issue regarding the formatting feature, you can visit the repository at https://github.com/movebit/movefmt/tree/develop.

Troubleshooting

Please note: If you don't see the version number, you can refer to the troubleshooting section."

[1] cannot find the aptos-move-analyzer program

For Network reason

You may have the extension look at this location by using the the Visual Studio Code settings (⌘, on macOS, or use the menu item Code > Preferences > Settings). Search for the aptos-move-analyzer.proxy.addr setting, maybe you should set a proxy server like 127.0.0.1:7890.

For PATH reason

If you see an error message language server executable aptos-move-analyzer could not be found in the bottom-right of your Visual Studio Code screen when opening a Move file, it means that the aptos-move-analyzer executable could not be found in your PATH. You may try the following:

1. Confirm that invoking aptos-move-analyzer --version in a command line terminal prints out aptos-move-analyzer version number. If it doesn't, then retry the instructions in [step 1]. If it does successfully print this output, try closing and re-opening the Visual Studio Code application, as it may not have picked up the update to your PATH.
2. If you installed the aptos-move-analyzer executable to a different location that is outside of your PATH, then you may have the extension look at this location by using the the Visual Studio Code settings (⌘, on macOS, or use the menu item Code > Preferences > Settings). Search for the aptos-move-analyzer.server.path setting, and set it to the location of the aptos-move-analyzer language server you installed.
3. If you're using it in MacOS, you may meet the error Macos cannot verify if this app contains malicious software, you need to add support for aptos-move-analyzer in the system settings Program Trust.

[2] analyzer not work

A.Need Move.toml

Open a Move source file (a file with a .move file extension) and if the opened Move source file is located within a buildable project (a Move.toml file can be found in one of its parent directories), the following advanced features will be available:

• compiler diagnostics
• go to definition
• go to references
• type on hover
• autocomplete
• outline view
• generate spec
• formatting
• ...

Therefore, the Move.toml file must be found in the project directory for the plug-in's functionality to take effect.

In addition, if you have already opened the move project before, the installed plug-in will not take effect in time. You need to reopen the vscode window and open the move project code again before the plug-in is activated.

B. Need Compile Project with Move.toml

When you first open a project, there will be some dependencies (configured in Move.toml) that need to be downloaded, so you need to run aptos move compile command first to build the project. During the build process, the dependencies will be downloaded. Once all the dependencies for the project have been downloaded, aptos-move-analyzer can properly parse the dependencies and project source code.

Support

1.If you find any issues, please report a GitHub issue to the aptos-move-analyzer-issues repository to get help.

2.Welcome to the developer discussion group as well: MoveAnalyzer.