Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added lint enum_tuple_variant_field_now_doc_hidden #685

Merged
merged 4 commits into from
Mar 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions src/lints/enum_tuple_variant_field_now_doc_hidden.ron
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
SemverQuery(
id: "enum_tuple_variant_field_now_doc_hidden",
human_readable_name: "pub enum tuple variant field is now #[doc(hidden)]",
description: "A pub enum tuple variant field is now marked #[doc(hidden)] and is thus no longer part of the public API.",
required_update: Major,
reference_link: Some("https://doc.rust-lang.org/rustdoc/write-documentation/the-doc-attribute.html#hidden"),
query: r#"
{
CrateDiff {
baseline {
item {
... on Enum {
visibility_limit @filter(op: "=", value: ["$public"])
enum_name: name @output @tag

importable_path {
path @output @tag
public_api @filter(op: "=", value: ["$true"])
}
variant {
... on TupleVariant {
variant_name: name @output @tag
public_api_eligible @filter(op: "=", value: ["$true"])

field {
field_name: name @output @tag
public_api_eligible @filter(op: "=", value: ["$true"])
}
}
}
}
}
}
current {
item {
... on Enum {
visibility_limit @filter(op: "=", value: ["$public"])
name @filter(op: "=", value: ["%enum_name"])

importable_path {
path @filter(op: "=", value: ["%path"])
}
variant {
... on TupleVariant {
name @filter(op: "=", value: ["%variant_name"])
public_api_eligible @filter(op: "=", value: ["$true"])

field {
public_api_eligible @filter(op: "!=", value: ["$true"])
name @filter(op: "=", value: ["%field_name"])
span_: span @optional {
filename @output
begin_line @output
}
}
}
}
}
}
}
}
}"#,
arguments: {
"public": "public",
"true": true,
},
error_message: "A field of a pub enum tuple variant is now marked #[doc(hidden)] and is no longer part of the public API.",
per_result_error_template: Some("field {{enum_name}}.{{field_name}} in file {{span_filename}}:{{span_begin_line}}"),
)
1 change: 1 addition & 0 deletions src/query.rs
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,7 @@ macro_rules! add_lints {
}

add_lints!(
enum_tuple_variant_field_now_doc_hidden,
trait_method_now_doc_hidden,
auto_trait_impl_removed,
constructible_struct_adds_field,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[package]
publish = false
name = "enum_tuple_variant_field_now_doc_hidden"
version = "0.1.0"
edition = "2021"

[dependencies]
17 changes: 17 additions & 0 deletions test_crates/enum_tuple_variant_field_now_doc_hidden/new/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
//Adding #[doc(hidden)] should not affect since the enum is not a part of public API
enum NonPublicEnum {
TupleVariant(#[doc(hidden)] i32, u8),
}
// basic test case(adding #[doc(hidden)] to public enum tuple variant)
pub enum PulicEnumA {
TupleVariantWithPublicField(#[doc(hidden)] u8, i32),
}
// Should not affect since there the field was already hidden
pub enum PulicEnumB {
TupleVariantWithPublicFieldHidden(#[doc(hidden)] i64, u8),
}
// should not affect since the public enum was not a part of Public API
#[doc(hidden)]
pub enum PulicEnumC {
TupleVariantWithPublicField(#[doc(hidden)] u8, i64),
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[package]
publish = false
name = "enum_tuple_variant_field_now_doc_hidden"
version = "0.1.0"
edition = "2021"

[dependencies]
13 changes: 13 additions & 0 deletions test_crates/enum_tuple_variant_field_now_doc_hidden/old/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
enum NonPublicEnum {
TupleVariant(i32, u8),
}
pub enum PulicEnumA {
TupleVariantWithPublicField(u8, i32),
}
pub enum PulicEnumB {
TupleVariantWithPublicFieldHidden(#[doc(hidden)] i64, u8),
}
#[doc(hidden)]
pub enum PulicEnumC {
TupleVariantWithPublicField(u8, i64),
}
15 changes: 15 additions & 0 deletions test_outputs/enum_tuple_variant_field_now_doc_hidden.output.ron
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"./test_crates/enum_tuple_variant_field_now_doc_hidden/": [
{
"enum_name": String("PulicEnumA"),
"field_name": String("0"),
"path": List([
String("enum_tuple_variant_field_now_doc_hidden"),
String("PulicEnumA"),
]),
"span_begin_line": Uint64(7),
"span_filename": String("src/lib.rs"),
"variant_name": String("TupleVariantWithPublicField"),
},
],
}
Loading