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.

Sign up for GitHub

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

Adding #[must_use] on an item #268

Closed
wants to merge 20 commits into from
Closed

Adding #[must_use] on an item #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
0290bee
New lint: enum_must_use_added
Jan 6, 2023
87b9a1e
Merge branch 'obi1kenobi:main' into Adding-#must_use-on-an-item
SmolSir Jan 6, 2023
df6e4c5
Update src/lints/enum_must_use_added.ron
SmolSir Jan 6, 2023
c72b6d2
Missing newline in enum_must_use_added/new/src/lib.rs
Jan 7, 2023
3434892
New lint: struct_must_use_added
Jan 7, 2023
36854b4
New lint: function_must_use_added
Jan 7, 2023
d7929a6
Update per_result_error_template in function_must_use_added lint
Jan 7, 2023
deb3c32
New lint: trait_must_use_added
Jan 7, 2023
33e7992
Additional tests with private items.
Jan 8, 2023
659430e
Missing test - private trait must_use added
Jan 9, 2023
96a134b
Simpler functions in function_must_use_added.
Jan 9, 2023
ee7c1e1
Correct the line numbers in function_must_use_added.output.ron file.
Jan 9, 2023
ba2c051
Additional test - adding new item with initial must_use.
Jan 9, 2023
68264c9
Backup commit before file splitting.
Jan 9, 2023
ffebed4
New lint: inherent_method_must_use_added
Jan 9, 2023
62acdda
More comment emphasis in tests against false-positives :)
Jan 9, 2023
a96d6a4
Removed unnecessary underscores '_'.
Jan 9, 2023
b138f79
New test crate: trait_method_must_use_added
Jan 9, 2023
f950f99
New test crate: inherent_method_moved_must_use_added
Jan 9, 2023
57e5e41
Merge branch 'obi1kenobi:main' into Adding-#must_use-on-an-item
SmolSir Jan 10, 2023
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
64 changes: 64 additions & 0 deletions src/lints/enum_must_use_added.ron
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
SemverQuery(
id: "enum_must_use_added",
human_readable_name: "enum #[must_use] added",
description: "An enum has been marked with #[must_use].",
required_update: Minor,

// TODO: Change the reference link to point to the cargo semver reference
// once it has a section on attribute #[must_use].
reference_link: Some("https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute"),
query: r#"
{
CrateDiff {
baseline {
item {
... on Enum {
visibility_limit @filter(op: "=", value: ["$public"]) @output
name @tag @output

importable_path {
path @tag @output
}

attribute @fold @transform(op: "count") @filter(op: "=", value: ["$zero"]) {
content {
base @filter(op: "=", value: ["$must_use"])
}
}
}
}
}
current {
item {
... on Enum {
visibility_limit @filter(op: "=", value: ["$public"])
name @filter(op: "=", value: ["%name"])

importable_path {
path @filter(op: "=", value: ["%path"])
}

attribute {
new_attr: raw_attribute @output
content {
base @filter(op: "=", value: ["$must_use"])
}
}

span_: span @optional {
filename @output
begin_line @output
}
}
}
}
}
}"#,
arguments: {
"public": "public",
"must_use": "must_use",
"zero": 0,
},
error_message: "An enum has been marked with #[must_use]. This can cause downstream crates that did not use this enum's value to get a compiler lint.",
per_result_error_template: Some("enum {{name}} in {{span_filename}}:{{span_begin_line}}"),
)
64 changes: 64 additions & 0 deletions src/lints/function_must_use_added.ron
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
SemverQuery(
id: "function_must_use_added",
human_readable_name: "function #[must_use] added",
description: "A function has been marked with #[must_use].",
required_update: Minor,

// TODO: Change the reference link to point to the cargo semver reference
// once it has a section on attribute #[must_use].
reference_link: Some("https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute"),
query: r#"
{
CrateDiff {
baseline {
item {
... on Function {
visibility_limit @filter(op: "=", value: ["$public"]) @output
name @tag @output

importable_path {
path @tag @output
}

attribute @fold @transform(op: "count") @filter(op: "=", value: ["$zero"]) {
content {
base @filter(op: "=", value: ["$must_use"])
}
}
}
}
}
current {
item {
... on Function {
visibility_limit @filter(op: "=", value: ["$public"])
name @filter(op: "=", value: ["%name"])

importable_path {
path @filter(op: "=", value: ["%path"])
}

attribute {
new_attr: raw_attribute @output
content {
base @filter(op: "=", value: ["$must_use"])
}
}

span_: span @optional {
filename @output
begin_line @output
}
}
}
}
}
}"#,
arguments: {
"public": "public",
"must_use": "must_use",
"zero": 0,
},
error_message: "A function has been marked with #[must_use]. This can cause downstream crates that did not use the value returned by this function to get a compiler lint.",
per_result_error_template: Some("function {{join \"::\" path}} in {{span_filename}}:{{span_begin_line}}"),
)
78 changes: 78 additions & 0 deletions src/lints/inherent_method_must_use_added.ron
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
SemverQuery(
id: "inherent_method_must_use_added",
human_readable_name: "inherent method #[must_use] added",
description: "An inherent method has been marked with #[must_use].",
required_update: Minor,

// TODO: Change the reference link to point to the cargo semver reference
// once it has a section on attribute #[must_use].
reference_link: Some("https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute"),
query: r#"
{
CrateDiff {
baseline {
item {
... on ImplOwner {
visibility_limit @filter(op: "=", value: ["$public"]) @output
name @tag @output

importable_path {
path @tag @output
}

inherent_impl {
method {
method_visibility: visibility_limit @filter(op: "=", value: ["$public"]) @output
method_name: name @tag @output

attribute @fold @transform(op: "count") @filter(op: "=", value: ["$zero"]) {
content {
base @filter(op: "=", value: ["$must_use"])
}
}
}
}
}
}
}
current {
item {
... on ImplOwner {
visibility_limit @filter(op: "=", value: ["$public"])
name @filter(op: "=", value: ["%name"])

importable_path {
path @filter(op: "=", value: ["%path"])
}

inherent_impl {
method {
visibility_limit @filter(op: "=", value: ["$public"])
name @filter(op: "=", value: ["%method_name"])

attribute {
new_attr: raw_attribute @output
content {
base @filter(op: "=", value: ["$must_use"])
}
}

span_: span @optional {
filename @output
begin_line @output
}
}
}
}
}
}
}
}"#,
arguments: {
"public": "public",
"must_use": "must_use",
"zero": 0,
},
error_message: "An inherent method has been marked with #[must_use]. This can cause downstream crates that did not use the value returned by this method to get a compiler lint.",
per_result_error_template: Some("inherent method {{join \"::\" path}}::{{method_name}} in {{span_filename}}:{{span_begin_line}}"),
)
89 changes: 89 additions & 0 deletions src/lints/method_must_use_added.ron
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
SemverQuery(
id: "method_must_use_added",
human_readable_name: "method #[must_use] added",
description: "A method has been marked with #[must_use].",
required_update: Minor,

// TODO: Change the reference link to point to the cargo semver reference
// once it has a section on attribute #[must_use].
reference_link: Some("https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute"),
query: r#"
{
CrateDiff {
baseline {
item {
... on ImplOwner {
visibility_limit @filter(op: "=", value: ["$public"]) @output
name @tag @output

importable_path {
path @tag @output
}

inherent_impl {
method {
method_visibility: visibility_limit @filter(op: "=", value: ["$public"]) @output
method_name: name @tag @output

attribute @fold @transform(op: "count") @filter(op: "=", value: ["$zero"]) {
content {
base @filter(op: "=", value: ["$must_use"])
}
}
}
}
}
}
}
current {
item {
... on ImplOwner {
visibility_limit @filter(op: "=", value: ["$public"])
name @filter(op: "=", value: ["%name"])

importable_path {
path @filter(op: "=", value: ["%path"])
}

# We use "impl" instead of "inherent_impl" here because moving
# an inherently-implemented method to a trait is not necessarily
# a breaking change, so we don't want to report it.
#
# It is also important to notice that #[must_use] can only be
# added to the method declaration or definition inside the trait.
# When #[must_use] is added to the definition inside an
# impl <trait_name> for <...> the attribute is ignored as only
# the attributes from the trait method declaration are applied.

impl {
method {
visibility_limit @filter(op: "one_of", value: ["$public_or_default"])
name @filter(op: "=", value: ["%method_name"])

attribute {
new_attr: raw_attribute @output
content {
base @filter(op: "=", value: ["$must_use"])
}
}

span_: span @optional {
filename @output
begin_line @output
}
}
}
}
}
}
}
}"#,
arguments: {
"public": "public",
"public_or_default": ["public", "default"],
"must_use": "must_use",
"zero": 0,
},
error_message: "A method has been marked with #[must_use]. This can cause downstream crates that did not use the value returned by this method to get a compiler lint.",
per_result_error_template: Some("method {{join \"::\" path}}::{{method_name}} in {{span_filename}}:{{span_begin_line}}"),
)
64 changes: 64 additions & 0 deletions src/lints/struct_must_use_added.ron
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
SemverQuery(
id: "struct_must_use_added",
human_readable_name: "struct #[must_use] added",
description: "A struct has been marked with #[must_use].",
required_update: Minor,

// TODO: Change the reference link to point to the cargo semver reference
// once it has a section on attribute #[must_use].
reference_link: Some("https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute"),
query: r#"
{
CrateDiff {
baseline {
item {
... on Struct {
visibility_limit @filter(op: "=", value: ["$public"]) @output
name @tag @output

importable_path {
path @tag @output
}

attribute @fold @transform(op: "count") @filter(op: "=", value: ["$zero"]) {
content {
base @filter(op: "=", value: ["$must_use"])
}
}
}
}
}
current {
item {
... on Struct {
visibility_limit @filter(op: "=", value: ["$public"])
name @filter(op: "=", value: ["%name"])

importable_path {
path @filter(op: "=", value: ["%path"])
}

attribute {
new_attr: raw_attribute @output
content {
base @filter(op: "=", value: ["$must_use"])
}
}

span_: span @optional {
filename @output
begin_line @output
}
}
}
}
}
}"#,
arguments: {
"public": "public",
"must_use": "must_use",
"zero": 0,
},
error_message: "A struct has been marked with #[must_use]. This can cause downstream crates that did not use this struct's value to get a compiler lint.",
per_result_error_template: Some("struct {{name}} in {{span_filename}}:{{span_begin_line}}"),
)
Loading