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 published plugin is platform-independent by utilizing a WASM-ified version of the Move parser at tree-sitter-move.wasm. The WASM file is generated from the sibling tree-sitter grammar when the package is published. You can generate it locally 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

Requires nodejs 18+ installed.

Usage (Global, CLI)

For CLI usage, you can install the plugin globally by running the following command:

npm i -g prettier @mysten/prettier-plugin-move

Then there will be a registered executable prettier-move which works exactly like a regular prettier one, except that it automatically inserts the path to the plugin as an argument.

prettier-move -c sources/example.move # to check
prettier-move -w sources/example.move # to write

This command is identical to the following:

prettier --plugin /path/to/local/npm/node_modules/@mysten/prettier-plugin-move/out/index.js -c sources/example.move # to check
prettier --plugin /path/to/local/npm/node_modules/@mysten/prettier-plugin-move/out/index.js -w sources/example.move # to write

Installation (Per-Project)

If you decide to use the plugin per-project, you can install it in the project's directory. This way, the plugin will be available via prettier call in the project's directory.

# install as a dev-dependency
npm i -D prettier @mysten/prettier-plugin-move

Add the .prettierrc or a similar configuration file (see all supported formats):

{
	"printWidth": 100,
	"tabWidth": 4,
	"useModuleLabel": true,
	"autoGroupImports": "module",
	"plugins": ["@mysten/prettier-plugin-move"]
}

Then you can run prettier either via adding a script to package.json:

{
	"scripts": {
		"prettier": "prettier --write ."
	}
}

npm run prettier -w sources/example.move

Or, if you have prettier installed globally, you can run it directly:

prettier --write sources/example.move

VSCode integration

There is a bundled Move Formatter extension for VSCode. It will detect prettier configuration for the workspace and use the plugin automatically.

Alternatively, if you follow the per-project installation, regular Pretter extension should work as well.

Known Integrations

• Neovim: see this commit for configuration

Contribute

See CONTRIBUTING.