Skip to content

docs: automated updates for new_feature#219

Open
jessiemongeon1 wants to merge 2 commits into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260513-164516
Open

docs: automated updates for new_feature#219
jessiemongeon1 wants to merge 2 commits into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260513-164516

Conversation

@jessiemongeon1

Copy link
Copy Markdown
Collaborator

Summary

Automated documentation updates triggered by recent release notes.

Changes

Triggered by MystenLabs/move-book#26521: [sui cli] Add pass through command sui move format for prettier-move

  • 🟡 book/before-we-begin/ide-support.md
  • 🟢 book/guides/code-quality-checklist.md

Review details

book/before-we-begin/ide-support.md

The documentation page could benefit from an update to mention the new sui move format CLI command as an alternative way to use the Move formatter directly through the Sui CLI, without needing to install the separate prettier-move npm package.

Section that needs updating: ## Other (CLI)

What is currently there:
The section only mentions the prettier-plugin-move npm package as the CLI option for formatting.

What should be added:
A mention of the sui move format command, which provides a built-in way to run the prettier-move auto-formatter directly through the Sui CLI without needing a separate npm installation.

Suggested update:

## Other (CLI)

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` - 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.

This is relevant because the new sui move format command lowers the barrier to entry for code formatting — users who already have the Sui CLI installed don't need to separately install Node.js/npm and the prettier plugin.

book/guides/code-quality-checklist.md

The documentation page already mentions the Move Formatter in the "Code Organization" section at the top, referencing it as an NPM package (@mysten/prettier-plugin-move), a CI check, and a VSCode plugin. However, it does not mention the new sui move format CLI command, which is the feature introduced by this PR.

Section that needs updating: "Code Organization"

What is currently there:

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).

What should be updated:
The paragraph should mention that the Move Formatter is now also available directly via the sui move format CLI command, in addition to the existing NPM/CI/VSCode options. For example:

Some of the issues mentioned in this guide can be fixed by using
[Move Formatter](https://www.npmjs.com/package/@mysten/prettier-plugin-move) — available directly
via 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).

This ensures developers are aware that formatting can now be invoked directly through the Sui CLI without needing to install the NPM package separately.


This PR was automatically generated by the Docs Impact Monitor. Please review the changes carefully before merging.

Each file edit was generated by Claude based on the release notes and a review of the existing documentation content.

Automated update based on: New `sui move format` CLI command added as a passthrough to the `prettier-move` auto-formatter
Automated update based on: New `sui move format` CLI command added as a passthrough to the `prettier-move` auto-formatter
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant