Replace rustfmt_excluded_files with rustfmt_skip cfg attribute

joostjager · joostjager · commit f1f6db5c5678 · 2025-05-27T10:01:01.000+02:00
This change removes the custom `rustfmt_excluded_files` mechanism and
instead uses the an attribute at the top of each excluded file.

No functional changes are introduced. This simplifies formatting
workflows by enabling standard `cargo fmt` and editor format-on-save
features without custom scripts.

The older `rustfmt` cfg attribute is used because newer formatting
directives only support code blocks, which would require more effort to
apply consistently. This commit focuses on improving developer
experience by streamlining formatting setup, while more granular or
comprehensive formatting can be addressed later.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -305,7 +305,7 @@ jobs:
         run: |
           rustup component add rustfmt
       - name: Run rustfmt checks
-        run: ci/rustfmt.sh
+        run: cargo fmt --check
 
   incremental-mutants:
     runs-on: ubuntu-latest
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -124,7 +124,7 @@ display fine at any tab-length display setting. We use `rustfmt` to establish
 uniform coding standards throughout the codebase. Please run
 
 ```bash
-./contrib/run-rustfmt.sh
+cargo fmt
 ```
 
 before committing and pushing any changes, as compliance will also be checked
diff --git a/ci/rustfmt.sh b/ci/rustfmt.sh
diff --git a/contrib/run-rustfmt.sh b/contrib/run-rustfmt.sh
diff --git a/lightning/src/chain/chaininterface.rs b/lightning/src/chain/chaininterface.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/chain/chainmonitor.rs b/lightning/src/chain/chainmonitor.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/chain/channelmonitor.rs b/lightning/src/chain/channelmonitor.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/chain/mod.rs b/lightning/src/chain/mod.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/chain/onchaintx.rs b/lightning/src/chain/onchaintx.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/chain/package.rs b/lightning/src/chain/package.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/chain/transaction.rs b/lightning/src/chain/transaction.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/lib.rs b/lightning/src/lib.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/async_signer_tests.rs b/lightning/src/ln/async_signer_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/blinded_payment_tests.rs b/lightning/src/ln/blinded_payment_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/chan_utils.rs b/lightning/src/ln/chan_utils.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/chanmon_update_fail_tests.rs b/lightning/src/ln/chanmon_update_fail_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/functional_test_utils.rs b/lightning/src/ln/functional_test_utils.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/max_payment_path_len_tests.rs b/lightning/src/ln/max_payment_path_len_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/mod.rs b/lightning/src/ln/mod.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/monitor_tests.rs b/lightning/src/ln/monitor_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/offers_tests.rs b/lightning/src/ln/offers_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/onion_payment.rs b/lightning/src/ln/onion_payment.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 //! Utilities to decode payment onions and do contextless validation of incoming payments.
 //!
 //! Primarily features [`peel_payment_onion`], which allows the decoding of an onion statelessly
diff --git a/lightning/src/ln/onion_route_tests.rs b/lightning/src/ln/onion_route_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/outbound_payment.rs b/lightning/src/ln/outbound_payment.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/peer_handler.rs b/lightning/src/ln/peer_handler.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/priv_short_conf_tests.rs b/lightning/src/ln/priv_short_conf_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/reload_tests.rs b/lightning/src/ln/reload_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/reorg_tests.rs b/lightning/src/ln/reorg_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/ln/shutdown_tests.rs b/lightning/src/ln/shutdown_tests.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/routing/mod.rs b/lightning/src/routing/mod.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/routing/scoring.rs b/lightning/src/routing/scoring.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/routing/test_utils.rs b/lightning/src/routing/test_utils.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/lightning/src/routing/utxo.rs b/lightning/src/routing/utxo.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
 // This file is Copyright its original authors, visible in version control
 // history.
 //
diff --git a/rustfmt_excluded_files b/rustfmt_excluded_files

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+#![cfg_attr(rustfmt, rustfmt_skip)]`
	`2`	`+`
`1`	`3`	`// This file is Copyright its original authors, visible in version control`
`2`	`4`	`// history.`
`3`	`5`	`//`