FuelLabs/sway

`forc fmt` should format manifest fields with rules similar to Cargo style guide

Open

#687 opened on Jan 22, 2022

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Rust (61,702 stars) (5,421 forks)batch import
enhancementforcformattergood first issue

Description

Currently, the manifest formatter simply orders all fields alphabetically. This should be changed to order them in a similar way to the Cargo style guide. This ordering should also be documented in The Sway Book.

https://github.com/rust-dev-tools/fmt-rfcs/blob/215291ef72823ae3a6adfad9b26334bed6707a13/guide/cargo.md

Contributor guide

Tech stack
rust
Domain
developer experiencetoolingdocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programmingFamiliarity with Sway project
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the current manifest formatting logic in the `forc fmt` source code, likely in the `forc` crate. Compare with the Cargo manifest style guide linked in the issue. Implement the ordering rules as per the guide. Update the documentation in The Sway Book to reflect the new ordering. If ambiguity arises, ask maintainer in a comment for clarification.