MystenLabs / sui

Sui, a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the Move programming language
https://sui.io
Apache License 2.0
6.28k stars 11.22k forks source link

Improve documentation for the prettier-move plugin #20406

Open Sceat opened 6 days ago

Sceat commented 6 days ago

Description

This PR explains how to use the prettier-move plugin through npm for a package.json workflow, along with CLI usage for direct formatting

npm run prettier

# or
npx --yes prettier@3.3.2 --plugin "$SUI/external-crates/move/tooling/prettier-move/out/index.js" --write "path/to/move/folder/**/*.move"

Test plan

Manually testet

vercel[bot] commented 6 days ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 23, 2024 5:59am
3 Skipped Deployments | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **multisig-toolkit** | ⬜️ Skipped ([Inspect](https://vercel.com/mysten-labs/multisig-toolkit/CGz45tCgjxHo2UrzrGovbAqgEVab)) | | | Nov 23, 2024 5:59am | | **sui-kiosk** | ⬜️ Skipped ([Inspect](https://vercel.com/mysten-labs/sui-kiosk/FSvYLLiip63XCx55jpiM13LkjWdB)) | | | Nov 23, 2024 5:59am | | **sui-typescript-docs** | ⬜️ Skipped ([Inspect](https://vercel.com/mysten-labs/sui-typescript-docs/E6ehvqFqNxbRz6btrrnGf2n9EHUM)) | | | Nov 23, 2024 5:59am |
github-actions[bot] commented 6 days ago

⚠️ 🦋 Changesets Warning: This PR has changes to public npm packages, but does not contain a changeset. You can create a changeset easily by running pnpm changeset in the root of the Sui repo, and following the prompts. If your change does not need a changeset (e.g. a documentation-only change), you can ignore this message. This warning will be removed when a changeset is added to this pull request.

Learn more about Changesets.