-
Notifications
You must be signed in to change notification settings - Fork 3.9k
[lint] Added empty_if lint and tests
#17794
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
Merged
+1,216
−7
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
third_party/move/tools/move-linter/src/model_ast_lints/empty_if.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Copyright (c) Aptos Foundation | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| //! This module implements an expression linter that checks for empty `else` branches | ||
| //! public fun empty_if(x: u64): u64 { | ||
| //! if (x > 35) { // <---- | ||
| //! } else { | ||
| //! x = x + 1; | ||
| //! }; | ||
| //! x | ||
| //! } | ||
|
|
||
| use move_compiler_v2::external_checks::ExpChecker; | ||
| use move_model::{ | ||
| ast::{ExpData, Operation}, | ||
| model::FunctionEnv, | ||
| }; | ||
|
|
||
| #[derive(Default)] | ||
| pub struct EmptyIf; | ||
|
|
||
| impl ExpChecker for EmptyIf { | ||
| fn get_name(&self) -> String { | ||
| "empty_if".to_string() | ||
| } | ||
|
|
||
| fn visit_expr_pre(&mut self, function: &FunctionEnv, expr: &ExpData) { | ||
| let ExpData::IfElse(full_nid, .., if_branch, else_branch) = expr else { | ||
| return; | ||
| }; | ||
|
|
||
| let ExpData::Call(_, Operation::Tuple, args) = if_branch.as_ref() else { | ||
| return; | ||
| }; | ||
|
|
||
| if !args.is_empty() { | ||
| return; | ||
| } | ||
|
|
||
| if let ExpData::Call(_, Operation::Abort, _) = else_branch.as_ref() { | ||
| return; | ||
| } | ||
|
|
||
| let genv = function.env(); | ||
|
|
||
Helios-vmg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| let message = match else_branch.as_ref() { | ||
| ExpData::Call(.., Operation::Tuple, eargs) if eargs.is_empty() => { | ||
| "Empty `if` branch. Consider simplifying by removing or rewriting." | ||
| }, | ||
| ExpData::LoopCont(_, _, _) => { | ||
| return; | ||
| }, | ||
| _ => "Empty `if` branch. Consider simplifying this `if-else`.", | ||
| }; | ||
|
|
||
| self.report(genv, &genv.get_node_loc(*full_nid), message); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
third_party/move/tools/move-linter/tests/model_ast_lints/empty_if.exp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
|
|
||
| Diagnostics: | ||
| warning: [lint] Empty `if` branch. Consider simplifying this `if-else`. | ||
| ┌─ tests/model_ast_lints/empty_if.move:4:9 | ||
| │ | ||
| 4 │ ╭ if (x > 0) { | ||
| 5 │ │ } else { | ||
| 6 │ │ return; | ||
| 7 │ │ }; | ||
| │ ╰─────────^ | ||
| │ | ||
| = To suppress this warning, annotate the function/module with the attribute `#[lint::skip(empty_if)]`. | ||
| = For more information, see https://aptos.dev/en/build/smart-contracts/linter#empty_if. | ||
|
|
||
| warning: [lint] Empty `if` branch. Consider simplifying by removing or rewriting. | ||
| ┌─ tests/model_ast_lints/empty_if.move:11:9 | ||
| │ | ||
| 11 │ ╭ if (x > 0) { | ||
| 12 │ │ }; | ||
| │ ╰─────────^ | ||
| │ | ||
| = To suppress this warning, annotate the function/module with the attribute `#[lint::skip(empty_if)]`. | ||
| = For more information, see https://aptos.dev/en/build/smart-contracts/linter#empty_if. | ||
|
|
||
| warning: [lint] Empty `if` branch. Consider simplifying by removing or rewriting. | ||
| ┌─ tests/model_ast_lints/empty_if.move:23:9 | ||
| │ | ||
| 23 │ ╭ if (x > 0) { | ||
| 24 │ │ () | ||
| 25 │ │ }; | ||
| │ ╰─────────^ | ||
| │ | ||
| = To suppress this warning, annotate the function/module with the attribute `#[lint::skip(empty_if)]`. | ||
| = For more information, see https://aptos.dev/en/build/smart-contracts/linter#empty_if. | ||
|
|
||
| warning: [lint] Empty `if` branch. Consider simplifying by removing or rewriting. | ||
| ┌─ tests/model_ast_lints/empty_if.move:30:9 | ||
| │ | ||
| 30 │ ╭ if (x > 35) { | ||
| 31 │ │ } else { }; | ||
| │ ╰──────────────────^ | ||
| │ | ||
| = To suppress this warning, annotate the function/module with the attribute `#[lint::skip(empty_if)]`. | ||
| = For more information, see https://aptos.dev/en/build/smart-contracts/linter#empty_if. | ||
|
|
||
| warning: [lint] Empty `if` branch. Consider simplifying this `if-else`. | ||
| ┌─ tests/model_ast_lints/empty_if.move:36:9 | ||
| │ | ||
| 36 │ ╭ if (x > 35) { | ||
| 37 │ │ } else { | ||
| 38 │ │ return 2; | ||
| 39 │ │ }; | ||
| │ ╰──────────^ | ||
| │ | ||
| = To suppress this warning, annotate the function/module with the attribute `#[lint::skip(empty_if)]`. | ||
| = For more information, see https://aptos.dev/en/build/smart-contracts/linter#empty_if. |
56 changes: 56 additions & 0 deletions
56
third_party/move/tools/move-linter/tests/model_ast_lints/empty_if.move
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| module 0xc0ffee::m { | ||
|
|
||
| public fun empty_if(x: u64) { | ||
| if (x > 0) { | ||
| } else { | ||
| return; | ||
| }; | ||
| } | ||
|
|
||
| public fun empty_if_no_else(x: u64) { | ||
| if (x > 0) { | ||
| }; | ||
| } | ||
|
|
||
| public fun non_empty_if(x: u64): u64 { | ||
| if (x > 0) { | ||
| x = x + 1; | ||
| }; | ||
| x | ||
| } | ||
|
|
||
| public fun empty_if_with_void(x: u64): u64 { | ||
| if (x > 0) { | ||
| () | ||
| }; | ||
| x | ||
| } | ||
|
|
||
| public fun empty_if_with_empty_else(x: u64): u64 { | ||
| if (x > 35) { | ||
| } else { }; | ||
| 0 | ||
| } | ||
|
|
||
| public fun empty_if_with_non_empty_else(x: u64): u64 { | ||
| if (x > 35) { | ||
| } else { | ||
| return 2; | ||
| }; | ||
| 0 | ||
| } | ||
|
|
||
| public fun aborts(x: u64) { | ||
| assert!(x > 10); | ||
| } | ||
|
|
||
|
|
||
| #[lint::skip(empty_if)] | ||
| public fun skip_empty_if(x: u64) { | ||
| if (x > 0) { | ||
| } else { | ||
| abort(0) | ||
| }; | ||
| } | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.