Add rustfmt configuration (#4354)

Author: acheroncrypto

.github/workflows/reusable-tests.yaml

@@ -54,7 +54,7 @@ jobs:
           path: ${{ env.CARGO_CACHE_PATH }}
           key: cargo-${{ runner.os }}-cargo-build-${{ hashFiles('**/Cargo.lock') }}
       - run: cargo build
-      - run: cargo fmt -- --check
+      - run: rustup component add --toolchain nightly-x86_64-unknown-linux-gnu rustfmt && cargo +nightly fmt -- --check
       - run: cargo clippy --all-targets -- -D warnings
       # FIXME: Enable `idl-build`
       - run: cargo test --workspace --exclude avm --features allow-missing-optionals,anchor-debug,derive,event-cpi,init-if-needed,lazy-account

avm/src/lib.rs

@@ -1,15 +1,18 @@
-use anyhow::{anyhow, bail, Context, Error, Result};
-use cargo_toml::Manifest;
-use chrono::{TimeZone, Utc};
-use reqwest::header::USER_AGENT;
-use reqwest::StatusCode;
-use semver::{Prerelease, Version};
-use serde::{de, Deserialize};
-use std::fs;
-use std::io::{BufRead, Write};
-use std::path::PathBuf;
-use std::process::{Command, Stdio};
-use std::sync::LazyLock;
+use {
+    anyhow::{anyhow, bail, Context, Error, Result},
+    cargo_toml::Manifest,
+    chrono::{TimeZone, Utc},
+    reqwest::{header::USER_AGENT, StatusCode},
+    semver::{Prerelease, Version},
+    serde::{de, Deserialize},
+    std::{
+        fs,
+        io::{BufRead, Write},
+        path::PathBuf,
+        process::{Command, Stdio},
+        sync::LazyLock,
+    },
+};
 
 /// Checked at most once per hour.
 const UPDATE_CHECK_INTERVAL_SECS: i64 = 60 * 60;
@@ -165,7 +168,8 @@ pub fn ensure_paths() {
                     if !linked {
                         if let Err(e) = fs::copy(&target, &anchor_in_cargo) {
                             eprintln!(
-                                "Failed to place `anchor` in {}: {}.\nAdd {} to your PATH or create a symlink manually.",
+                                "Failed to place `anchor` in {}: {}.\nAdd {} to your PATH or \
+                                 create a symlink manually.",
                                 cargo_bin.display(),
                                 e,
                                 bin_dir.display()
@@ -800,8 +804,8 @@ pub fn check_avm_version_and_warn() {
         UpdateCacheState::Success(ts, latest) if now - ts < UPDATE_CHECK_INTERVAL_SECS => {
             if latest > current {
                 eprintln!(
-                    "A new version of avm is available: {latest} (you have {current}). \
-                     Run `avm self-update` to upgrade."
+                    "A new version of avm is available: {latest} (you have {current}). Run `avm \
+                     self-update` to upgrade."
                 );
             }
         }
@@ -816,8 +820,8 @@ pub fn check_avm_version_and_warn() {
                 write_update_cache_success(&latest);
                 if latest > current {
                     eprintln!(
-                        "A new version of avm is available: {latest} (you have {current}). \
-                             Run `avm self-update` to upgrade."
+                        "A new version of avm is available: {latest} (you have {current}). Run \
+                         `avm self-update` to upgrade."
                     );
                 }
             }
@@ -879,11 +883,11 @@ pub fn self_update(include_pre_release: bool, bleeding_edge: bool) -> Result<()>
 
 #[cfg(test)]
 mod tests {
-    use crate::*;
-    use semver::Version;
-    use std::fs;
-    use std::io::Write;
-    use std::path::Path;
+    use {
+        crate::*,
+        semver::Version,
+        std::{fs, io::Write, path::Path},
+    };
 
     #[test]
     fn test_ensure_paths() {

avm/src/main.rs

@@ -1,8 +1,10 @@
-use anyhow::{anyhow, Error, Result};
-use avm::InstallTarget;
-use clap::{CommandFactory, Parser, Subcommand};
-use semver::Version;
-use std::ffi::OsStr;
+use {
+    anyhow::{anyhow, Error, Result},
+    avm::InstallTarget,
+    clap::{CommandFactory, Parser, Subcommand},
+    semver::Version,
+    std::ffi::OsStr,
+};
 
 #[derive(Parser)]
 #[clap(name = "avm", about = "Anchor version manager", version)]
@@ -216,8 +218,7 @@ fn main() -> Result<()> {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use avm::InstallTarget;
+    use {super::*, avm::InstallTarget};
 
     // --- is_pre_release ---
 

cli/src/account.rs

@@ -1,13 +1,12 @@
-use anyhow::{anyhow, Result};
-use clap::Parser;
-use solana_commitment_config::CommitmentConfig;
-use solana_pubkey::Pubkey;
-use solana_rpc_client::rpc_client::RpcClient;
-use std::fs::File;
-use std::io::Write;
-use std::path::PathBuf;
-
-use crate::config::{Config, ConfigOverride};
+use {
+    crate::config::{Config, ConfigOverride},
+    anyhow::{anyhow, Result},
+    clap::Parser,
+    solana_commitment_config::CommitmentConfig,
+    solana_pubkey::Pubkey,
+    solana_rpc_client::rpc_client::RpcClient,
+    std::{fs::File, io::Write, path::PathBuf},
+};
 
 #[derive(Debug, Parser)]
 pub struct ShowAccountCommand {

cli/src/bin/main.rs

@@ -1,6 +1,4 @@
-use anchor_cli::Opts;
-use anyhow::Result;
-use clap::Parser;
+use {anchor_cli::Opts, anyhow::Result, clap::Parser};
 
 fn main() -> Result<()> {
     anchor_cli::entry(Opts::parse())

cli/src/checks.rs

@@ -1,11 +1,11 @@
-use std::{fs, path::Path};
-
-use anyhow::{anyhow, Result};
-use semver::{Version, VersionReq};
-
-use crate::{
-    config::{Config, Manifest, PackageManager, WithPath},
-    VERSION,
+use {
+    crate::{
+        config::{Config, Manifest, PackageManager, WithPath},
+        VERSION,
+    },
+    anyhow::{anyhow, Result},
+    semver::{Version, VersionReq},
+    std::{fs, path::Path},
 };
 
 /// Check whether `overflow-checks` codegen option is enabled.
@@ -18,10 +18,8 @@ pub fn check_overflow(cargo_toml_path: impl AsRef<Path>) -> Result<bool> {
         .as_ref()
         .and_then(|profile| profile.overflow_checks)
         .ok_or(anyhow!(
-            "`overflow-checks` is not enabled. To enable, add:\n\n\
-    [profile.release]\n\
-    overflow-checks = true\n\n\
-    in workspace root Cargo.toml",
+            "`overflow-checks` is not enabled. To enable, \
+             add:\n\n[profile.release]\noverflow-checks = true\n\nin workspace root Cargo.toml",
         ))
 }
 
@@ -48,11 +46,8 @@ pub fn check_anchor_version(cfg: &WithPath<Config>) -> Result<()> {
     if let Some(ver) = mismatched_lang_version {
         eprintln!(
             "WARNING: `anchor-lang` version({ver}) and the current CLI version({cli_version}) \
-                 don't match.\n\n\t\
-                 This can lead to unwanted behavior. To use the same CLI version, add:\n\n\t\
-                 [toolchain]\n\t\
-                 anchor_version = \"{ver}\"\n\n\t\
-                 to Anchor.toml\n"
+             don't match.\n\n\tThis can lead to unwanted behavior. To use the same CLI version, \
+             add:\n\n\t[toolchain]\n\tanchor_version = \"{ver}\"\n\n\tto Anchor.toml\n"
         );
     }
 
@@ -78,10 +73,9 @@ pub fn check_anchor_version(cfg: &WithPath<Config>) -> Result<()> {
         };
 
         eprintln!(
-            "WARNING: `@anchor-lang/core` version({ver}) and the current CLI version\
-                ({cli_version}) don't match.\n\n\t\
-                This can lead to unwanted behavior. To fix, upgrade the package by running:\n\n\t\
-                {update_cmd} @anchor-lang/core@{cli_version}\n"
+            "WARNING: `@anchor-lang/core` version({ver}) and the current CLI \
+             version({cli_version}) don't match.\n\n\tThis can lead to unwanted behavior. To fix, \
+             upgrade the package by running:\n\n\t{update_cmd} @anchor-lang/core@{cli_version}\n"
         );
     }
 
@@ -135,11 +129,10 @@ pub fn check_deps(cfg: &WithPath<Config>) -> Result<()> {
         })
         .for_each(|man| {
             eprintln!(
-                "WARNING: Adding `solana-program` as a separate dependency might cause conflicts.\n\
-                To solve, remove the `solana-program` dependency and use the exported crate from \
-                `anchor-lang`.\n\
-                `use solana_program` becomes `use anchor_lang::solana_program`.\n\
-                Program name: `{}`\n",
+                "WARNING: Adding `solana-program` as a separate dependency might cause \
+                 conflicts.\nTo solve, remove the `solana-program` dependency and use the \
+                 exported crate from `anchor-lang`.\n`use solana_program` becomes `use \
+                 anchor_lang::solana_program`.\nProgram name: `{}`\n",
                 man.package().name()
             )
         });
@@ -187,12 +180,10 @@ in `{manifest_path:?}`."#
         .filter(|(_, dep)| dep.req_features().contains(&"idl-build".into()))
         .for_each(|(name, _)| {
             eprintln!(
-                "WARNING: `idl-build` feature of crate `{name}` is enabled by default. \
-                    This is not the intended usage.\n\n\t\
-                    To solve, do not enable the `idl-build` feature and include crates that have \
-                    `idl-build` feature in the `idl-build` feature list:\n\n\t\
-                    [features]\n\t\
-                    idl-build = [\"{name}/idl-build\", ...]\n"
+                "WARNING: `idl-build` feature of crate `{name}` is enabled by default. This is \
+                 not the intended usage.\n\n\tTo solve, do not enable the `idl-build` feature and \
+                 include crates that have `idl-build` feature in the `idl-build` feature \
+                 list:\n\n\t[features]\n\tidl-build = [\"{name}/idl-build\", ...]\n"
             )
         });
 
@@ -205,11 +196,10 @@ in `{manifest_path:?}`."#
         .unwrap_or_default()
         .then(|| {
             eprintln!(
-                "WARNING: `idl-build` feature of `anchor-spl` is not enabled. \
-                This is likely to result in cryptic compile errors.\n\n\t\
-                To solve, add `anchor-spl/idl-build` to the `idl-build` feature list:\n\n\t\
-                [features]\n\t\
-                idl-build = [\"anchor-spl/idl-build\", ...]\n"
+                "WARNING: `idl-build` feature of `anchor-spl` is not enabled. This is likely to \
+                 result in cryptic compile errors.\n\n\tTo solve, add `anchor-spl/idl-build` to \
+                 the `idl-build` feature list:\n\n\t[features]\n\tidl-build = \
+                 [\"anchor-spl/idl-build\", ...]\n"
             )
         });
 

cli/src/config.rs

@@ -1,32 +1,37 @@
-use crate::{get_keypair, is_hidden, keys_sync, DEFAULT_RPC_PORT};
-use anchor_client::Cluster;
-use anchor_lang_idl::types::Idl;
-use anyhow::{anyhow, bail, Context, Error, Result};
-use clap::{Parser, ValueEnum};
-use dirs::home_dir;
-use heck::ToSnakeCase;
-use reqwest::Url;
-use serde::de::{self, MapAccess, Visitor};
-use serde::ser::SerializeMap;
-use serde::{Deserialize, Deserializer, Serialize, Serializer};
-use solana_cli_config::{Config as SolanaConfig, CONFIG_FILE};
-use solana_clock::Slot;
-use solana_commitment_config::CommitmentLevel;
-use solana_keypair::Keypair;
-use solana_pubkey::Pubkey;
-use solana_signer::Signer;
-use std::collections::{BTreeMap, HashMap};
-use std::convert::TryFrom;
-use std::fs::{self, File};
-use std::io::prelude::*;
-use std::marker::PhantomData;
-use std::ops::Deref;
-use std::path::Path;
-use std::path::PathBuf;
-use std::process::Command;
-use std::str::FromStr;
-use std::{fmt, io};
-use walkdir::WalkDir;
+use {
+    crate::{get_keypair, is_hidden, keys_sync, DEFAULT_RPC_PORT},
+    anchor_client::Cluster,
+    anchor_lang_idl::types::Idl,
+    anyhow::{anyhow, bail, Context, Error, Result},
+    clap::{Parser, ValueEnum},
+    dirs::home_dir,
+    heck::ToSnakeCase,
+    reqwest::Url,
+    serde::{
+        de::{self, MapAccess, Visitor},
+        ser::SerializeMap,
+        Deserialize, Deserializer, Serialize, Serializer,
+    },
+    solana_cli_config::{Config as SolanaConfig, CONFIG_FILE},
+    solana_clock::Slot,
+    solana_commitment_config::CommitmentLevel,
+    solana_keypair::Keypair,
+    solana_pubkey::Pubkey,
+    solana_signer::Signer,
+    std::{
+        collections::{BTreeMap, HashMap},
+        convert::TryFrom,
+        fmt,
+        fs::{self, File},
+        io::{self, prelude::*},
+        marker::PhantomData,
+        ops::Deref,
+        path::{Path, PathBuf},
+        process::Command,
+        str::FromStr,
+    },
+    walkdir::WalkDir,
+};
 
 pub const SURFPOOL_HOST: &str = "127.0.0.1";
 /// Wrapper around CommitmentLevel to support case-insensitive parsing
@@ -1034,7 +1039,8 @@ fn canonicalize_filepath_from_origin(
     let result = fs::canonicalize(&file_path)
         .with_context(|| {
             format!(
-                "Error reading (possibly relative) path: {}. If relative, this is the path that was used as the current path: {}",
+                "Error reading (possibly relative) path: {}. If relative, this is the path that \
+                 was used as the current path: {}",
                 &file_path.as_ref().display(),
                 &origin.as_ref().display()
             )

cli/src/keygen.rs

@@ -1,21 +1,21 @@
-use std::{
-    fs,
-    io::{self, Write},
-    path::Path,
+use {
+    crate::{config::ConfigOverride, get_keypair, KeygenCommand},
+    anyhow::{anyhow, bail, Result},
+    bip39::{Language, Mnemonic, MnemonicType, Seed},
+    console::{Key, Term},
+    dirs::home_dir,
+    solana_instruction::{AccountMeta, Instruction},
+    solana_keypair::Keypair,
+    solana_pubkey::Pubkey,
+    solana_signer::{EncodableKey, Signer},
+    solana_transaction::Message,
+    std::{
+        fs,
+        io::{self, Write},
+        path::Path,
+    },
 };
 
-use anyhow::{anyhow, bail, Result};
-use bip39::{Language, Mnemonic, MnemonicType, Seed};
-use console::{Key, Term};
-use dirs::home_dir;
-use solana_instruction::{AccountMeta, Instruction};
-use solana_keypair::Keypair;
-use solana_pubkey::Pubkey;
-use solana_signer::{EncodableKey, Signer};
-use solana_transaction::Message;
-
-use crate::{config::ConfigOverride, get_keypair, KeygenCommand};
-
 /// Secure password input with asterisk visual feedback
 /// - show_spaces: if true, spaces are visible (for seed phrases); if false, all characters are asterisks (for passphrases)
 fn secure_input(prompt: &str, show_spaces: bool) -> Result<String> {
@@ -351,8 +351,10 @@ fn keygen_verify(pubkey: Pubkey, keypair_path: Option<String>) -> Result<()> {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use tempfile::{tempdir, TempDir};
+    use {
+        super::*,
+        tempfile::{tempdir, TempDir},
+    };
 
     fn tmp_outfile_path(out_dir: &TempDir, name: &str) -> String {
         let path = out_dir.path().join(name);
@@ -433,7 +435,8 @@ mod tests {
     #[test]
     fn test_keypair_from_seed_consistency() {
         // Test that the same seed phrase produces the same keypair
-        let test_phrase = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
+        let test_phrase = "abandon abandon abandon abandon abandon abandon abandon abandon \
+                           abandon abandon abandon about";
 
         let mnemonic = Mnemonic::from_phrase(test_phrase, Language::English).unwrap();
         let seed1 = Seed::new(&mnemonic, "");