mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Auto merge of #130599 - jieyouxu:snake_case_binary_cleanup, r=petrochenkov

Browse Source 
Explain why `non_snake_case` is skipped for binary crates and cleanup tests

- Explain `non_snake_case` lint is skipped for bin crate names because binaries are not intended to be distributed or consumed like library crates (#45127).
- Coalesce the bunch of tests into a single one but with revisions, which is easier to compare the differences for `non_snake_case` behavior with respect to crate types.

Follow-up to #121749 with some more comments and test cleanup.

cc `@saethlin` who bumped into one of the tests and was confused why it was `only-x86_64-unknown-linux-gnu`.

try-job: dist-i586-gnu-i586-i686-musl
This commit is contained in:
bors 2024-09-21 11:16:38 +00:00
commit f48c99a004
19 changed files with 68 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
compiler/rustc_lint/src/nonstandard_style.rs
View File

@ -332,6 +332,9 @@ fn check_mod(&mut self, cx: &LateContext<'_>, _: &'tcx hir::Mod<'tcx>, id: hir::
return;
}
// Issue #45127: don't enforce `snake_case` for binary crates as binaries are not intended
// to be distributed and depended on like libraries. The lint is not suppressed for cdylib
// or staticlib because it's not clear what the desired lint behavior for those are.
if cx.tcx.crate_types().iter().all(|&crate_type| crate_type == CrateType::Executable) {
return;
}

7
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-bin.rs
View File

@ -1,7 +0,0 @@
//@ only-x86_64-unknown-linux-gnu
//@ check-pass
#![crate_name = "NonSnakeCase"]
#![deny(non_snake_case)]
fn main() {}

7
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-bin2.rs
View File

@ -1,7 +0,0 @@
//@ only-x86_64-unknown-linux-gnu
//@ compile-flags: --crate-name NonSnakeCase
//@ check-pass
#![deny(non_snake_case)]
fn main() {}

8
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-bin3.rs
View File

@ -1,8 +0,0 @@
//@ only-x86_64-unknown-linux-gnu
//@ check-pass
#![crate_type = "bin"]
#![crate_name = "NonSnakeCase"]
#![deny(non_snake_case)]
fn main() {}

7
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-cdylib.rs
View File

@ -1,7 +0,0 @@
//@ only-x86_64-unknown-linux-gnu
#![crate_type = "cdylib"]
#![crate_name = "NonSnakeCase"]
//~^ ERROR crate `NonSnakeCase` should have a snake case name
#![deny(non_snake_case)]
fn main() {}

7
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-dylib.rs
View File

@ -1,7 +0,0 @@
//@ only-x86_64-unknown-linux-gnu
#![crate_type = "dylib"]
#![crate_name = "NonSnakeCase"]
//~^ ERROR crate `NonSnakeCase` should have a snake case name
#![deny(non_snake_case)]
fn main() {}

7
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-lib.rs
View File

@ -1,7 +0,0 @@
//@ only-x86_64-unknown-linux-gnu
#![crate_type = "lib"]
#![crate_name = "NonSnakeCase"]
//~^ ERROR crate `NonSnakeCase` should have a snake case name
#![deny(non_snake_case)]
fn main() {}

7
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-proc-macro.rs
View File

@ -1,7 +0,0 @@
//@ only-x86_64-unknown-linux-gnu
#![crate_type = "proc-macro"]
#![crate_name = "NonSnakeCase"]
//~^ ERROR crate `NonSnakeCase` should have a snake case name
#![deny(non_snake_case)]
fn main() {}

14
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-proc-macro.stderr
View File

@ -1,14 +0,0 @@
error: crate `NonSnakeCase` should have a snake case name
--> $DIR/lint-non-snake-case-crate-proc-macro.rs:3:18
|
LL | #![crate_name = "NonSnakeCase"]
| ^^^^^^^^^^^^ help: convert the identifier to snake case: `non_snake_case`
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-crate-proc-macro.rs:5:9
|
LL | #![deny(non_snake_case)]
| ^^^^^^^^^^^^^^
error: aborting due to 1 previous error

7
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-rlib.rs
View File

@ -1,7 +0,0 @@
//@ only-x86_64-unknown-linux-gnu
#![crate_type = "rlib"]
#![crate_name = "NonSnakeCase"]
//~^ ERROR crate `NonSnakeCase` should have a snake case name
#![deny(non_snake_case)]
fn main() {}

7
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-staticlib.rs
View File

@ -1,7 +0,0 @@
//@ only-x86_64-unknown-linux-gnu
#![crate_type = "staticlib"]
#![crate_name = "NonSnakeCase"]
//~^ ERROR crate `NonSnakeCase` should have a snake case name
#![deny(non_snake_case)]
fn main() {}

14
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-staticlib.stderr
View File

@ -1,14 +0,0 @@
error: crate `NonSnakeCase` should have a snake case name
--> $DIR/lint-non-snake-case-crate-staticlib.rs:3:18
|
LL | #![crate_name = "NonSnakeCase"]
| ^^^^^^^^^^^^ help: convert the identifier to snake case: `non_snake_case`
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-crate-staticlib.rs:5:9
|
LL | #![deny(non_snake_case)]
| ^^^^^^^^^^^^^^
error: aborting due to 1 previous error

4
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-lib.stderr → tests/ui/lint/non-snake-case/lint-non-snake-case-crate.cdylib_.stderr
View File

@ -1,11 +1,11 @@
error: crate `NonSnakeCase` should have a snake case name
--> $DIR/lint-non-snake-case-crate-lib.rs:3:18
--> $DIR/lint-non-snake-case-crate.rs:25:18
|
LL | #![crate_name = "NonSnakeCase"]
| ^^^^^^^^^^^^ help: convert the identifier to snake case: `non_snake_case`
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-crate-lib.rs:5:9
--> $DIR/lint-non-snake-case-crate.rs:27:9
|
LL | #![deny(non_snake_case)]
| ^^^^^^^^^^^^^^

4
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-rlib.stderr → tests/ui/lint/non-snake-case/lint-non-snake-case-crate.dylib_.stderr
View File

@ -1,11 +1,11 @@
error: crate `NonSnakeCase` should have a snake case name
--> $DIR/lint-non-snake-case-crate-rlib.rs:3:18
--> $DIR/lint-non-snake-case-crate.rs:25:18
|
LL | #![crate_name = "NonSnakeCase"]
| ^^^^^^^^^^^^ help: convert the identifier to snake case: `non_snake_case`
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-crate-rlib.rs:5:9
--> $DIR/lint-non-snake-case-crate.rs:27:9
|
LL | #![deny(non_snake_case)]
| ^^^^^^^^^^^^^^

4
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-dylib.stderr → tests/ui/lint/non-snake-case/lint-non-snake-case-crate.lib_.stderr
View File

@ -1,11 +1,11 @@
error: crate `NonSnakeCase` should have a snake case name
--> $DIR/lint-non-snake-case-crate-dylib.rs:3:18
--> $DIR/lint-non-snake-case-crate.rs:25:18
|
LL | #![crate_name = "NonSnakeCase"]
| ^^^^^^^^^^^^ help: convert the identifier to snake case: `non_snake_case`
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-crate-dylib.rs:5:9
--> $DIR/lint-non-snake-case-crate.rs:27:9
|
LL | #![deny(non_snake_case)]
| ^^^^^^^^^^^^^^

4
tests/ui/lint/non-snake-case/lint-non-snake-case-crate-cdylib.stderr → tests/ui/lint/non-snake-case/lint-non-snake-case-crate.proc_macro_.stderr
View File

@ -1,11 +1,11 @@
error: crate `NonSnakeCase` should have a snake case name
--> $DIR/lint-non-snake-case-crate-cdylib.rs:3:18
--> $DIR/lint-non-snake-case-crate.rs:25:18
|
LL | #![crate_name = "NonSnakeCase"]
| ^^^^^^^^^^^^ help: convert the identifier to snake case: `non_snake_case`
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-crate-cdylib.rs:5:9
--> $DIR/lint-non-snake-case-crate.rs:27:9
|
LL | #![deny(non_snake_case)]
| ^^^^^^^^^^^^^^

14
tests/ui/lint/non-snake-case/lint-non-snake-case-crate.rlib_.stderr Normal file
View File

@ -0,0 +1,14 @@
error: crate `NonSnakeCase` should have a snake case name
--> $DIR/lint-non-snake-case-crate.rs:25:18
|
LL | #![crate_name = "NonSnakeCase"]
| ^^^^^^^^^^^^ help: convert the identifier to snake case: `non_snake_case`
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-crate.rs:27:9
|
LL | #![deny(non_snake_case)]
| ^^^^^^^^^^^^^^
error: aborting due to 1 previous error

29
tests/ui/lint/non-snake-case/lint-non-snake-case-crate.rs Normal file
View File

@ -0,0 +1,29 @@
//! Don't lint on binary crate with non-snake-case names.
//!
//! See <https://github.com/rust-lang/rust/issues/45127>.
//@ revisions: bin_ cdylib_ dylib_ lib_ proc_macro_ rlib_ staticlib_
// Should not fire on binary crates.
//@[bin_] compile-flags: --crate-type=bin
//@[bin_] check-pass
// But should fire on non-binary crates.
//@[cdylib_] ignore-musl (dylibs are not supported)
//@[dylib_] ignore-musl (dylibs are not supported)
//@[dylib_] ignore-wasm (dylib is not supported)
//@[proc_macro_] ignore-wasm (dylib is not supported)
//@[cdylib_] compile-flags: --crate-type=cdylib
//@[dylib_] compile-flags: --crate-type=dylib
//@[lib_] compile-flags: --crate-type=lib
//@[proc_macro_] compile-flags: --crate-type=proc-macro
//@[rlib_] compile-flags: --crate-type=rlib
//@[staticlib_] compile-flags: --crate-type=staticlib
#![crate_name = "NonSnakeCase"]
//[cdylib_,dylib_,lib_,proc_macro_,rlib_,staticlib_]~^ ERROR crate `NonSnakeCase` should have a snake case name
#![deny(non_snake_case)]
fn main() {}

14
tests/ui/lint/non-snake-case/lint-non-snake-case-crate.staticlib_.stderr Normal file
View File

@ -0,0 +1,14 @@
error: crate `NonSnakeCase` should have a snake case name
--> $DIR/lint-non-snake-case-crate.rs:25:18
|
LL | #![crate_name = "NonSnakeCase"]
| ^^^^^^^^^^^^ help: convert the identifier to snake case: `non_snake_case`
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-crate.rs:27:9
|
LL | #![deny(non_snake_case)]
| ^^^^^^^^^^^^^^
error: aborting due to 1 previous error