Prettier Move Plugin

This is a Move language plugin for the Prettier code formatter. It uses a Move parser built on top of the tree-sitter parser generator and maintained by Tim Zakian.

The plugin is platform-independent by utilizing a WASM-ified version of the Move parser included in this repository at (./tree-sitter-move.wasm). You can re-generate the WASM-ified version of the parser by running the scripts/treesitter-wasm-gen.sh script (prerequisites for this are listed in the script itself). You should be careful when doing so, as certain changes to the parser may break the plugin (e.g., if parse tree node types are modified).

Prerequisites

Currently, in order to use the plugin, you need to install npm command (brew install npm on a Mac). You can use the plugin to format Move files (.move extension) both on the command line and using Prettier's VSCode extension. When the plugin is complete, we will make it available directly from Move's VSCode extension.

Installation

Currently, you need to install plugin from sources (when the plugin is complete, we will submit it to the NPM package registry for direct download).

Clone Sui repository into $SUI directory:

git clone https://github.com/MystenLabs/sui.git "$SUI"

Go to "$SUI"/external-crates/move/crates/move-analyzer/prettier-plugin and run the following command:

npm run build

Usage

Go to the root directory of the Move package whose files you'd like to format (i.e., the directory containing the Move.toml manifest file for this package) and run the following command:

npm install [email protected] "$SUI"/external-crates/move/crates/move-analyzer/prettier-plugin

This will install both the prettier formatter and the plugin in the ./node_modules directory.

Command-line Usage

You can format Move files in the package where you completed the installation step by running the following command:

./node_modules/.bin/prettier --plugin=prettier-plugin-move "$PATH_TO_MOVE_FILE"

VSCode integration

In order to use the plugin in VSCode you first need to install Prettier's VSCode extension.

Then, in the root directory of the package where you completed the installation step you need to place the .prettierrc file containing the following configuration:

{
"plugins": [
    "prettier-plugin-move"
  ]
}

After completing these steps, if you open the root directory of the package where you completed the installation step and choose any of the Move source files in this package, you will be able to format them by choosing Format Code command from VSCode's command palette.

Here is the plugin at work in VSCode:

Contribute

If you decide to contribute to this project, please choose the scope of your contribution (e.g., implement formatting for structs) and file an issue in the Sui repository describing the work you plan to do, and wait for a response from a core team member so that we can avoid duplication of efforts.

Please make sure that the code you add is well documented and that you add relevant tests - please use existing code as guidance.