chore: introduce `rustfmt.toml` #5686

kamuik16 · 2024-11-23T14:53:56Z

Description

Uses cargo +nightly fmt for

reordering and formatting imports for better formatting and readability
formatting code in the /// doc comments

mergify · 2024-11-25T13:56:49Z

This pull request has merge conflicts. Could you please resolve them @kamuik16? 🙏

drHuangMHT · 2024-11-26T09:01:53Z

I think the diffs are too large, and some make more sense than others. Also I am not really a fan of so many line breaks.

kamuik16 · 2024-11-26T13:35:10Z

I think the diffs are too large, and some make more sense than others. Also I am not really a fan of so many line breaks.

okay. thou I don't know what you mean by line breaks?

jxs

Thanks! Overall looks very good to me, left just a couple comments

jxs · 2024-11-26T15:42:56Z

core/CHANGELOG.md

@@ -1,3 +1,6 @@
+- Introduce `rustfmt.toml`.


we don't need to add a CHANGELOG.md entry for this

we don't need to add a CHANGELOG.md entry for this

if I don't add an entry in the CHANGELOG.md entry for this, the CI will be all red because it thinks the diffs are protocol changes. I am okay, if that is something you are okay with.

that's because you titled it as feat, if you change to chore it won't

jxs · 2024-11-26T15:47:44Z

core/src/either.rs

    Multiaddr,
 };
 use either::Either;
 use futures::prelude::*;
 use pin_project::pin_project;
-use std::{pin::Pin, task::Context, task::Poll};


can we not break here, and therefore not diff on these situations? I think it's what @drHuangMHT was mentioning also

can we not break here, and therefore not diff on these situations? I think it's what @drHuangMHT was mentioning also

I don't think I can control the output of the diff here, but I don't see huge downside of this. lmk wdyt?

it's just cargo +nightly fmt on the codebase after adding the rustfmt.toml.

I think it's the imports_layout rule, can you test with LimitedHorizontalVertical? see here and here for more info

jxs · 2024-11-26T15:50:57Z

core/src/lib.rs

@@ -37,7 +37,8 @@ mod proto {
    #![allow(unreachable_pub)]
    include!("generated/mod.rs");
    pub use self::{
-        envelope_proto::*, peer_record_proto::mod_PeerRecord::*, peer_record_proto::PeerRecord,
+        envelope_proto::*,


since we are on this, is there a way to impede * imports?

since we are on this, is there a way to impede * imports?

aah no, not using the rustfmt as far as I know. do correct me if I'm wrong.

however there's a clippy lint config warn-on-all-wildcard-imports which we can set to true in the Cargo.toml and it will give us the warnings about these. we'd then have to fix them manually. I'd consider that a seperate issue for this PR.

ok nice, yeah we can submit another PR with it enabled

jxs

Thanks for your response, left a couple suggestions in the rustfmt.toml file can you run with those added?

jxs · 2024-11-26T17:45:05Z

core/CHANGELOG.md

@@ -1,3 +1,6 @@
+- Introduce `rustfmt.toml`.


that's because you titled it as feat, if you change to chore it won't

jxs · 2024-11-26T18:23:50Z

rustfmt.toml

@@ -0,0 +1,3 @@
+reorder_imports  = true
+imports_granularity = "Crate"


Suggested change

imports_granularity = "Crate"

imports_granularity = "Crate"

group_imports = "StdExternalCrate"

jxs · 2024-11-26T18:53:23Z

rustfmt.toml

@@ -0,0 +1,3 @@
+reorder_imports  = true
+imports_granularity = "Crate"
+format_code_in_doc_comments = true


Suggested change

format_code_in_doc_comments = true

format_code_in_doc_comments = true

format_strings = true

normalize_comments = true

wrap_comments = true

jxs · 2024-11-26T19:01:02Z

core/src/lib.rs

@@ -37,7 +37,8 @@ mod proto {
    #![allow(unreachable_pub)]
    include!("generated/mod.rs");
    pub use self::{
-        envelope_proto::*, peer_record_proto::mod_PeerRecord::*, peer_record_proto::PeerRecord,
+        envelope_proto::*,


ok nice, yeah we can submit another PR with it enabled

jxs · 2024-11-26T19:07:56Z

core/src/either.rs

    Multiaddr,
 };
 use either::Either;
 use futures::prelude::*;
 use pin_project::pin_project;
-use std::{pin::Pin, task::Context, task::Poll};


I think it's the imports_layout rule, can you test with LimitedHorizontalVertical? see here and here for more info

kamuik16 · 2024-11-27T03:04:06Z

Had some trouble with git, so had to close this one for #5694 :)

kamuik16 force-pushed the fmt branch from 8076c7c to 96060c2 Compare November 25, 2024 14:19

jxs reviewed Nov 26, 2024

View reviewed changes

kamuik16 changed the title ~~feat: introduces rustfmt.toml~~ chore: introduce rustfmt.toml Nov 27, 2024

kamuik16 force-pushed the fmt branch from acfc800 to 92af583 Compare November 27, 2024 02:41

chore: rustfmt.toml

5998c4c

kamuik16 force-pushed the fmt branch from 92af583 to 5998c4c Compare November 27, 2024 02:42

kamuik16 closed this Nov 27, 2024

kamuik16 deleted the fmt branch November 27, 2024 02:46

kamuik16 mentioned this pull request Nov 28, 2024

chore: add wildcard_imports clippy lint #5703

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: introduce `rustfmt.toml` #5686

chore: introduce `rustfmt.toml` #5686

kamuik16 commented Nov 23, 2024

mergify bot commented Nov 25, 2024

drHuangMHT commented Nov 26, 2024

kamuik16 commented Nov 26, 2024

jxs left a comment

jxs Nov 26, 2024

kamuik16 Nov 26, 2024 •

edited

Loading

jxs Nov 26, 2024

jxs Nov 26, 2024

kamuik16 Nov 26, 2024

kamuik16 Nov 26, 2024

jxs Nov 26, 2024

jxs Nov 26, 2024

kamuik16 Nov 26, 2024

kamuik16 Nov 26, 2024

jxs Nov 26, 2024

jxs left a comment

jxs Nov 26, 2024

jxs Nov 26, 2024

jxs Nov 26, 2024

jxs Nov 26, 2024

jxs Nov 26, 2024

kamuik16 commented Nov 27, 2024

		@@ -0,0 +1,3 @@
		reorder_imports = true
		imports_granularity = "Crate"

	imports_granularity = "Crate"
	imports_granularity = "Crate"
	group_imports = "StdExternalCrate"

-format_code_in_doc_comments = true
+format_code_in_doc_comments = true
+format_strings = true
+normalize_comments = true
+wrap_comments = true

chore: introduce rustfmt.toml #5686

chore: introduce rustfmt.toml #5686

Conversation

kamuik16 commented Nov 23, 2024

Description

mergify bot commented Nov 25, 2024

drHuangMHT commented Nov 26, 2024

kamuik16 commented Nov 26, 2024

jxs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kamuik16 Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jxs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kamuik16 commented Nov 27, 2024

chore: introduce `rustfmt.toml` #5686

chore: introduce `rustfmt.toml` #5686

kamuik16 Nov 26, 2024 •

edited

Loading