Add rustfmt rules to the project. (FuelLabs#575)

* Rebase master * Added `rustfmt` into needs * Removed default fields in from the `rustfmt` * Removed `force_multiline_blocks` modification * Remove `combine_control_expr` * Updated `CONTRIBUTING.md` with nightly `rustfmt`
dedyshkaPexto · Sep 7, 2022 · 142fc32 · 142fc32
1 parent 5ad0dfd
commit 142fc32
Show file tree

Hide file tree

Showing 144 changed files with 4,502 additions and 1,810 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,6 +19,20 @@ env:
   REGISTRY: ghcr.io
 
 jobs:
+  rustfmt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install latest nightly
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          override: true
+          components: rustfmt
+
+      - name: Rustfmt check
+        run: cargo +nightly fmt --all -- --check
+
   lint-toml-files:
     runs-on: ubuntu-latest
     steps:
@@ -71,12 +85,11 @@ jobs:
     needs:
       - lint-toml-files
       - prevent-openssl
+      - rustfmt
     runs-on: ubuntu-latest
     strategy:
       matrix:
         include:
-          - command: fmt
-            args: --all --verbose -- --check
           - command: clippy
             args: --all-targets --all-features
           - command: make

diff --git a/.rustfmt.toml b/.rustfmt.toml
@@ -0,0 +1,8 @@
+max_width = 90 # changed
+normalize_comments = true # changed
+imports_layout = "Vertical" # changed
+imports_granularity = "Crate" # changed
+trailing_semicolon = false # changed
+edition = "2021" # changed
+use_try_shorthand = true # changed
+use_field_init_shorthand = true # changed
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,7 +10,9 @@ We use an RFC process to maintain our code standards. They currently live in the
 
 ## Building and setting up a development workspace
 
-Fuel Core is mostly written in Rust, but includes components written in C++ (RocksDB). We are currently using the latest Rust stable toolchain.
+Fuel Core is mostly written in Rust, but includes components written in C++ (RocksDB).
+We are currently using the latest Rust stable toolchain to build the project.
+But for `rustfmt`, we use Rust nightly toolchain because it provides more code style features(you can check [`rustfmt.toml`](.rustfmt.toml)).
 
 ### Prerequisites
 
@@ -34,11 +36,12 @@ cd fuel-core
 
 `rustup` is the official toolchain manager for Rust.
 
-We use some additional components such as `rustfmt` and `clippy`, to install those:
+We use some additional components such as `clippy` and `rustfmt`(nightly), to install those:
 
 ```sh
-rustup component add rustfmt
 rustup component add clippy
+rustup toolchain install nightly
+rustup component add rustfmt --toolchain nightly
 ```
 
 ### Building and testing
@@ -56,14 +59,15 @@ This command will run `cargo build` and also dump the latest schema into `/asset
 Linting is done using rustfmt and clippy, which are each separate commands:
 
 ```sh
-cargo fmt --all --check
+cargo +nightly fmt --all --check
 ```
 
 ```sh
 cargo clippy --all-targets
 ```
 
-The test suite follows the Rust cargo standards. The GraphQL service will be instantiated by Tower and will emulate a server/client structure.
+The test suite follows the Rust cargo standards. The GraphQL service will be instantiated by 
+Tower and will emulate a server/client structure.
 
 Testing is simply done using Cargo:
 

diff --git a/fuel-block-importer/src/service.rs b/fuel-block-importer/src/service.rs
@@ -1,8 +1,14 @@
 use crate::Config;
-use fuel_core_interfaces::block_importer::{ImportBlockBroadcast, ImportBlockMpsc};
+use fuel_core_interfaces::block_importer::{
+    ImportBlockBroadcast,
+    ImportBlockMpsc,
+};
 use parking_lot::Mutex;
 use tokio::{
-    sync::{broadcast, mpsc},
+    sync::{
+        broadcast,
+        mpsc,
+    },
     task::JoinHandle,
 };
 

diff --git a/fuel-block-producer/src/service.rs b/fuel-block-producer/src/service.rs
@@ -1,7 +1,13 @@
 use crate::Config;
-use fuel_core_interfaces::{block_producer::BlockProducerMpsc, txpool};
+use fuel_core_interfaces::{
+    block_producer::BlockProducerMpsc,
+    txpool,
+};
 use parking_lot::Mutex;
-use tokio::{sync::mpsc, task::JoinHandle};
+use tokio::{
+    sync::mpsc,
+    task::JoinHandle,
+};
 
 pub struct Service {
     join: Mutex<Option<JoinHandle<()>>>,

diff --git a/fuel-client/build.rs b/fuel-client/build.rs
@@ -1,8 +1,16 @@
-use schemafy_lib::{Expander, Schema};
-use std::env;
-use std::fs::{self, File};
-use std::io::prelude::*;
-use std::path::PathBuf;
+use schemafy_lib::{
+    Expander,
+    Schema,
+};
+use std::{
+    env,
+    fs::{
+        self,
+        File,
+    },
+    io::prelude::*,
+    path::PathBuf,
+};
 
 fn main() {
     println!("cargo:rerun-if-changed=./assets/debugAdapterProtocol.json");
@@ -13,7 +21,8 @@ fn main() {
         .expect("Failed to fetch JSON schema");
 
     let json = fs::read_to_string(&path).expect("Failed to parse JSON from schema");
-    let schema: Schema = serde_json::from_str(&json).expect("Failed to parse Schema from JSON");
+    let schema: Schema =
+        serde_json::from_str(&json).expect("Failed to parse Schema from JSON");
     let root_name = schema.title.clone().unwrap_or_else(|| "Root".to_owned());
 
     let path = path.into_os_string();

diff --git a/fuel-client/src/client.rs b/fuel-client/src/client.rs
@@ -1,28 +1,71 @@
 use crate::client::schema::contract::ContractBalanceQueryArgs;
 use anyhow::Context;
-use cynic::{http::SurfExt, Id, MutationBuilder, Operation, QueryBuilder};
+use cynic::{
+    http::SurfExt,
+    Id,
+    MutationBuilder,
+    Operation,
+    QueryBuilder,
+};
 use fuel_vm::prelude::*;
 use itertools::Itertools;
 use schema::{
     balance::BalanceArgs,
     block::BlockByIdArgs,
-    coin::{Coin, CoinByIdArgs, SpendQueryElementInput},
-    contract::{Contract, ContractByIdArgs},
-    tx::{TxArg, TxIdArgs},
-    Bytes, ContinueTx, ContinueTxArgs, ConversionError, HexString, IdArg, MemoryArgs, RegisterArgs,
-    RunResult, SetBreakpoint, SetBreakpointArgs, SetSingleStepping, SetSingleSteppingArgs, StartTx,
-    StartTxArgs, TransactionId, U64,
+    coin::{
+        Coin,
+        CoinByIdArgs,
+        SpendQueryElementInput,
+    },
+    contract::{
+        Contract,
+        ContractByIdArgs,
+    },
+    tx::{
+        TxArg,
+        TxIdArgs,
+    },
+    Bytes,
+    ContinueTx,
+    ContinueTxArgs,
+    ConversionError,
+    HexString,
+    IdArg,
+    MemoryArgs,
+    RegisterArgs,
+    RunResult,
+    SetBreakpoint,
+    SetBreakpointArgs,
+    SetSingleStepping,
+    SetSingleSteppingArgs,
+    StartTx,
+    StartTxArgs,
+    TransactionId,
+    U64,
 };
 use std::{
     convert::TryInto,
-    io::{self, ErrorKind},
+    io::{
+        self,
+        ErrorKind,
+    },
     net,
-    str::{self, FromStr},
+    str::{
+        self,
+        FromStr,
+    },
+};
+use types::{
+    TransactionResponse,
+    TransactionStatus,
 };
-use types::{TransactionResponse, TransactionStatus};
 
 use crate::client::schema::tx::DryRunArg;
-pub use schema::{PageDirection, PaginatedResult, PaginationRequest};
+pub use schema::{
+    PageDirection,
+    PaginatedResult,
+    PaginationRequest,
+};
 
 use self::schema::block::ProduceBlockArgs;
 
@@ -175,7 +218,12 @@ impl FuelClient {
         Ok(self.query(query).await?.register.0 as Word)
     }
 
-    pub async fn memory(&self, id: &str, start: usize, size: usize) -> io::Result<Vec<u8>> {
+    pub async fn memory(
+        &self,
+        id: &str,
+        start: usize,
+        size: usize,
+    ) -> io::Result<Vec<u8>> {
         let query = schema::Memory::build(&MemoryArgs {
             id: id.into(),
             start: start.into(),
@@ -209,7 +257,11 @@ impl FuelClient {
         Ok(())
     }
 
-    pub async fn set_single_stepping(&self, session_id: &str, enable: bool) -> io::Result<()> {
+    pub async fn set_single_stepping(
+        &self,
+        session_id: &str,
+        enable: bool,
+    ) -> io::Result<()> {
         let operation = SetSingleStepping::build(SetSingleSteppingArgs {
             id: Id::new(session_id),
             enable,
@@ -218,7 +270,11 @@ impl FuelClient {
         Ok(())
     }
 
-    pub async fn start_tx(&self, session_id: &str, tx: &Transaction) -> io::Result<RunResult> {
+    pub async fn start_tx(
+        &self,
+        session_id: &str,
+        tx: &Transaction,
+    ) -> io::Result<RunResult> {
         let operation = StartTx::build(StartTxArgs {
             id: Id::new(session_id),
             tx: serde_json::to_string(tx).expect("Couldn't serialize tx to json"),
@@ -314,7 +370,8 @@ impl FuelClient {
     }
 
     pub async fn block(&self, id: &str) -> io::Result<Option<schema::block::Block>> {
-        let query = schema::block::BlockByIdQuery::build(&BlockByIdArgs { id: id.parse()? });
+        let query =
+            schema::block::BlockByIdQuery::build(&BlockByIdArgs { id: id.parse()? });
 
         let block = self.query(query).await?.block;
 
@@ -389,22 +446,28 @@ impl FuelClient {
     }
 
     pub async fn contract(&self, id: &str) -> io::Result<Option<Contract>> {
-        let query =
-            schema::contract::ContractByIdQuery::build(ContractByIdArgs { id: id.parse()? });
+        let query = schema::contract::ContractByIdQuery::build(ContractByIdArgs {
+            id: id.parse()?,
+        });
         let contract = self.query(query).await?.contract;
         Ok(contract)
     }
 
-    pub async fn contract_balance(&self, id: &str, asset: Option<&str>) -> io::Result<u64> {
+    pub async fn contract_balance(
+        &self,
+        id: &str,
+        asset: Option<&str>,
+    ) -> io::Result<u64> {
         let asset_id: schema::AssetId = match asset {
             Some(asset) => asset.parse()?,
             None => schema::AssetId::default(),
         };
 
-        let query = schema::contract::ContractBalanceQuery::build(ContractBalanceQueryArgs {
-            id: id.parse()?,
-            asset: asset_id,
-        });
+        let query =
+            schema::contract::ContractBalanceQuery::build(ContractBalanceQueryArgs {
+                id: id.parse()?,
+                asset: asset_id,
+            });
 
         let balance = self.query(query).await.unwrap().contract_balance.amount;
         Ok(balance.into())
@@ -440,7 +503,9 @@ impl FuelClient {
         request: PaginationRequest<String>,
     ) -> io::Result<PaginatedResult<schema::contract::ContractBalance, String>> {
         let contract_id: schema::ContractId = contract.parse()?;
-        let query = schema::contract::ContractBalancesQuery::build(&(contract_id, request).into());
+        let query = schema::contract::ContractBalancesQuery::build(
+            &(contract_id, request).into(),
+        );
 
         let balances = self.query(query).await?.contract_balances.into();
 
@@ -452,7 +517,8 @@ impl FuelClient {
         owner: Option<&str>,
         request: PaginationRequest<String>,
     ) -> io::Result<PaginatedResult<schema::message::Message, String>> {
-        let owner: Option<schema::Address> = owner.map(|owner| owner.parse()).transpose()?;
+        let owner: Option<schema::Address> =
+            owner.map(|owner| owner.parse()).transpose()?;
         let query = schema::message::OwnedMessageQuery::build(&(owner, request).into());
 
         let messages = self.query(query).await?.messages.into();

diff --git a/fuel-client/src/client/schema.rs b/fuel-client/src/client/schema.rs
@@ -5,10 +5,15 @@ pub mod schema {
 }
 
 use hex::FromHexError;
-use std::array::TryFromSliceError;
-use std::fmt::{self, Debug};
-use std::io::ErrorKind;
-use std::num::TryFromIntError;
+use std::{
+    array::TryFromSliceError,
+    fmt::{
+        self,
+        Debug,
+    },
+    io::ErrorKind,
+    num::TryFromIntError,
+};
 use thiserror::Error;
 
 pub use primitives::*;

diff --git a/fuel-client/src/client/schema/balance.rs b/fuel-client/src/client/schema/balance.rs
@@ -1,5 +1,15 @@
-use crate::client::schema::{schema, Address, AssetId, PageInfo, U64};
-use crate::client::{PageDirection, PaginatedResult, PaginationRequest};
+use crate::client::{
+    schema::{
+        schema,
+        Address,
+        AssetId,
+        PageInfo,
+        U64,
+    },
+    PageDirection,
+    PaginatedResult,
+    PaginationRequest,
+};
 
 #[derive(cynic::FragmentArguments, Debug)]
 pub struct BalanceArgs {