Add module_style lint to style #7543

DevinR528 · 2021-08-07T00:49:08Z

changelog: Add new [module_style] style lint

This is a configurable (no mod file/mod file) lint that determines if mod.rs is used consistently or if mod.rs is never used (using the new mod layout).

rust-highfive · 2021-08-07T00:49:10Z

r? @Manishearth

(rust-highfive has picked a reviewer for you, use r? to override)

camsteffen · 2021-08-11T14:45:02Z

clippy_lints/src/module_style.rs

+                            let p = p.to_string_lossy();
+                            let path = Path::new(p.trim_start_matches(trim_to_src.as_ref()));
+
+                            if path.ends_with("mod.rs") {


This should not trigger for something_mod.rs.

I would just emit the lint right here. It's okay to emit for every module. Also, you should be able to get a Span using Span::new(file.start_pos, file.start_pos, SyntaxContext::root()).

It shouldn't Path::ends_with is different that str::ends_with, it only considers whole segments.

I can't emit until I know if there are any missing mod.rs files this is the mod_file check. I could still collect all the folder names (after src) and collect all the mod.rs file paths and remove all the folders that contain mod files, emitting for all the folders that are left after. I would have to keep more info around and haven't figured out all the details but it would probably work, then the error messages would at least be more consistent.

camsteffen · 2021-08-11T15:42:44Z

I think it would be simpler to make this two complimentary restriction lints - mod_file and self_named_mod_file (enable the lint for the style you want to ban). In either case, I don't think the Ignore variant is necessary since it is the same as allowing the lint.

Manishearth · 2021-08-11T16:48:26Z

So we discussed this in the meeting yesterday and it's not really clear to me if this is an accepted style preference; in my experience codebases are fine with mixing them since the approaches sometimes have their own benefits. I think this should be a restriction lint, making it possible for crates to opt in but out of the picture by default.

camsteffen · 2021-08-11T17:25:36Z

I did see the meeting and my suggestion is in addition to that. (I should have clarified that)

Manishearth · 2021-08-11T19:04:41Z

Oh, I wasn't responding to you, I had just forgotten to update the PR 😄

camsteffen · 2021-08-11T19:07:07Z

Oh, I wasn't responding to you

Oh I see how it is! 😆

clippy_lints/src/module_style.rs

Manishearth · 2021-08-17T18:42:32Z

clippy_lints/src/module_style.rs

+    ///   stuff.rs
+    ///   lib.rs
+    /// ```
+    pub MOD_FILES,


thoughts on improving the lint name?

mod_module_files and the other could be self_named_module_files 🤷 I was hoping when I looked up the RFC that introduced the new module system there would be a good name for it but there is not.

@camsteffen thoughts?

Hmmm. I think @DevinR528's idea is good. Another approach is mod_file_within_dir and mod_file_outside_dir but I don't like that better.

jplatte · 2021-08-18T13:07:23Z

tests/ui-cargo/module_style/fail_mod/src/main.stderr

@@ -4,7 +4,7 @@ error: `mod.rs` files are required, found `/bad/inner.rs`
 LL | pub mod stuff;
   | ^
   |
-   = note: `-D clippy::self-named-mod-files` implied by `-D warnings`
+   = note: `-D clippy::self-named-module-files` implied by `-D warnings`
   = help: create a `/bad/inner/mod.rs` file and remove `/bad/inner.rs`


Should the suggestion simple be "move bad/inner.rs to bad/inner/mod.rs, rather than "create", "remove"?

I changed both error messages to the above suggestion

DevinR528 · 2021-08-22T17:11:34Z

Should I squash the commits or are there any more things to fix?

Manishearth · 2021-08-22T18:56:41Z

Nah I should just review this 😄

Manishearth · 2021-08-22T18:56:52Z

Squashing would be appreciated though!

DevinR528 · 2021-08-23T12:44:47Z

Squashed!

Manishearth

almost there!

Manishearth · 2021-08-23T16:22:46Z

clippy_lints/src/module_style.rs

+            return;
+        };
+
+        let mut segments = FxHashSet::default();


nit: can we have some comments on what these variables contain

Manishearth · 2021-08-23T16:23:07Z

clippy_lints/src/module_style.rs

+    }
+}
+
+fn check_mod_file_exists(


nit: also document the purpose of the function

especially since this does a different kind of "check" than the other one

I renamed this function to process_paths_for_mod_files, as you pointed out there is no check there so it didn't make much sense hope this works

Add tests for disallowed_mod in ui-cargo test section Use correct algorithm to determine if mod.rs is missing Move to two lints and remove config option Switch lint names so they read "warn on ..." Emit the same help info for self_named_mod_file warnings Bail when both lints are Allow Reword help message for both module_style lints

Manishearth · 2021-08-25T15:20:23Z

@bors r+

Thanks for your patience!

bors · 2021-08-25T15:20:25Z

📌 Commit 31738b1 has been approved by Manishearth

bors · 2021-08-25T15:20:31Z

⌛ Testing commit 31738b1 with merge de80188...

bors · 2021-08-25T15:33:59Z

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: Manishearth
Pushing de80188 to master...

DevinR528 · 2021-08-26T11:54:32Z

Thanks for helping me along!

lopopolo · 2021-09-04T04:39:46Z

This lint is going into the style group which means it will be enabled by default. Has a crater run been performed to assess how much churn this will cause?

jplatte · 2021-09-04T07:50:32Z

@lopopolo If you have a look at the description and discussion above, you will see that this lint was never enabled by default. Originally it was a style lint that would only ever trigger when it was configured via clippy.toml, after feedback it was changed to be two separate restriction lints.

rust-highfive assigned Manishearth Aug 7, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Aug 7, 2021

DevinR528 mentioned this pull request Aug 7, 2021

Add more automated checks for our code style ruma/ruma#221

Closed

camsteffen reviewed Aug 11, 2021

View reviewed changes

camsteffen reviewed Aug 12, 2021

View reviewed changes

clippy_lints/src/module_style.rs Outdated Show resolved Hide resolved

Manishearth reviewed Aug 17, 2021

View reviewed changes

jplatte reviewed Aug 18, 2021

View reviewed changes

DevinR528 force-pushed the disallowed-mod branch from 1bc9d5c to 5a69424 Compare August 22, 2021 20:24

Manishearth approved these changes Aug 23, 2021

View reviewed changes

DevinR528 force-pushed the disallowed-mod branch from 5a69424 to 31738b1 Compare August 24, 2021 19:54

Manishearth approved these changes Aug 25, 2021

View reviewed changes

bors merged commit de80188 into rust-lang:master Aug 25, 2021

DevinR528 deleted the disallowed-mod branch August 26, 2021 11:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add module_style lint to style #7543

Add module_style lint to style #7543

DevinR528 commented Aug 7, 2021

rust-highfive commented Aug 7, 2021

camsteffen Aug 11, 2021

DevinR528 Aug 12, 2021

camsteffen commented Aug 11, 2021

Manishearth commented Aug 11, 2021

camsteffen commented Aug 11, 2021

Manishearth commented Aug 11, 2021

camsteffen commented Aug 11, 2021

Manishearth Aug 17, 2021

DevinR528 Aug 17, 2021

Manishearth Aug 17, 2021

camsteffen Aug 17, 2021

jplatte Aug 18, 2021

DevinR528 Aug 18, 2021

DevinR528 commented Aug 22, 2021

Manishearth commented Aug 22, 2021

Manishearth commented Aug 22, 2021

DevinR528 commented Aug 23, 2021

Manishearth left a comment

Manishearth Aug 23, 2021

Manishearth Aug 23, 2021

DevinR528 Aug 24, 2021

Manishearth commented Aug 25, 2021

bors commented Aug 25, 2021

bors commented Aug 25, 2021

bors commented Aug 25, 2021

DevinR528 commented Aug 26, 2021

lopopolo commented Sep 4, 2021

jplatte commented Sep 4, 2021

Add module_style lint to style #7543

Add module_style lint to style #7543

Conversation

DevinR528 commented Aug 7, 2021

rust-highfive commented Aug 7, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camsteffen commented Aug 11, 2021

Manishearth commented Aug 11, 2021

camsteffen commented Aug 11, 2021

Manishearth commented Aug 11, 2021

camsteffen commented Aug 11, 2021

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

DevinR528 commented Aug 22, 2021

Manishearth commented Aug 22, 2021

Manishearth commented Aug 22, 2021

DevinR528 commented Aug 23, 2021

Manishearth 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

Manishearth commented Aug 25, 2021

bors commented Aug 25, 2021

bors commented Aug 25, 2021

bors commented Aug 25, 2021

DevinR528 commented Aug 26, 2021

lopopolo commented Sep 4, 2021

jplatte commented Sep 4, 2021