diff --git a/book/before-we-begin/ide-support.md b/book/before-we-begin/ide-support.md index b1a55ac2..b7b24582 100644 --- a/book/before-we-begin/ide-support.md +++ b/book/before-we-begin/ide-support.md @@ -57,3 +57,6 @@ Some of the tools listed above have CLI-supported versions. - [prettier-plugin-move](https://www.npmjs.com/package/@mysten/prettier-plugin-move) contains the TypeScript package for the Prettier@v3 plugin as well as the binary to run it in a terminal +- `sui move format` is a built-in CLI command that provides a passthrough to the `prettier-move` + auto-formatter, allowing you to format Move code directly from the Sui CLI without additional + tool installation. \ No newline at end of file diff --git a/book/guides/code-quality-checklist.md b/book/guides/code-quality-checklist.md index 75656d51..49f22394 100644 --- a/book/guides/code-quality-checklist.md +++ b/book/guides/code-quality-checklist.md @@ -12,9 +12,11 @@ recommendations as possible to your code. ## Code Organization Some of the issues mentioned in this guide can be fixed by using -[Move Formatter](https://www.npmjs.com/package/@mysten/prettier-plugin-move) either as a CLI tool, -or [as a CI check](https://github.com/marketplace/actions/move-formatter), or -[as a plugin for VSCode (Cursor)](https://marketplace.visualstudio.com/items?itemName=mysten.prettier-move). +[Move Formatter](https://www.npmjs.com/package/@mysten/prettier-plugin-move), available directly +through the `sui move format` CLI command, as a standalone +[CLI tool](https://www.npmjs.com/package/@mysten/prettier-plugin-move), +as [a CI check](https://github.com/marketplace/actions/move-formatter), or +as [a plugin for VSCode (Cursor)](https://marketplace.visualstudio.com/items?itemName=mysten.prettier-move). ## Package Manifest @@ -593,4 +595,4 @@ Being friendly and helping reviewers understand the code! // Note: can underflow if a value is smaller than 10. // TODO: add an `assert!` here let value = external_call(value, ctx); -``` +``` \ No newline at end of file